データクラス注釈 - AWS SDK for Java 2.x

データクラス注釈

次の表は、データクラスで使用できる注釈の一覧と、このガイドの情報と例へのリンクを示しています。テーブルは、注釈名別にアルファベット順に昇順に並べ替えられます。

このガイドで使用されているデータクラス注釈
注釈名 次に適用される注釈1 その内容 このガイドに記載されている場所
DynamoDbAtomicCounter 属性2 レコードがデータベースに書き込まれるたびに、タグ付きの数値属性を増やします。 概要とディスカッション。
DynamoDbAttribute 属性 DynamoDB テーブル属性にマップされる Bean プロパティを定義または名前を変更します。
DynamoDbAutoGeneratedTimestampAttribute 属性 項目がデータベースに正常に書き込まれるたびに、タグ付き属性を現在のタイムスタンプで更新します。 概要とディスカッション。
DynamoDbAutoGeneratedUuid 属性 新しいレコードがデータベースに書き込まれるときに、属性の一意の UUID (ユニバーサル一意識別子) を生成します。 概要とディスカッション。
DynamoDbBean class データクラスをテーブルスキーマにマッピング可能としてマークします。 「はじめに」セクションのカスタマークラスで初めに使用します。このガイドでは、いくつかの使用法が説明されています。
DynamoDbConvertedBy 属性 カスタム AttributeConverter を注釈付きの属性に関連付けます。 最初のディスカッションと例。
DynamoDbFlatten 属性 個別の DynamoDB データクラスのすべての属性をフラット化し、データベースに読み書きされるレコードに最上位の属性として追加します。
DynamoDbIgnore 属性

その結果、属性はマップされないままの状態となります。
DynamoDbIgnoreNulls 属性 ネストされた DynamoDB オブジェクトの NULL 属性が保存されないようにします。 ディスカッションと例。
DynamoDbImmutable class

変更不可能なデータクラスをテーブルスキーマにマッピング可能としてマークします。
DynamoDbPartitionKey 属性

属性を DynamoDB テーブルのプライマリパーティションキー (ハッシュキー) としてマークします。
DynamoDbPreserveEmptyObject 属性

注釈付き属性にマップされたオブジェクトにデータが存在しない場合、オブジェクトはすべて NULL フィールドで初期化されるように指定します。

 ディスカッションと例。
DynamoDbSecondaryPartitionKey 属性

グローバルセカンダリインデックスのパーティションキーとして属性をマークします。
DynamoDbSecondarySortKey 属性

属性をグローバルまたはローカルのセカンダリインデックスのオプションのソートキーとしてマークします。
DynamoDbSortKey 属性

属性をオプションのプライマリソートキー (レンジキー) としてマークします。
DynamoDbUpdateBehavior 属性

UpdateItem などの「更新」オペレーションの一部としてこの属性が更新されたときの動作を指定します。

 概要と例。
DynamoDbVersionAttribute 属性 アイテムのバージョン番号を増やします。 概要とディスカッション。

1属性レベルの注釈はゲッターまたはセッターに適用できますが、両方に適用することはできません。このガイドでは、ゲッターの注釈を示します。

2通常、property という用語は JavaBean データクラスにカプセル化された値に使用されます。ただし、このガイドでは、DynamoDB で使用されている用語との一貫性を保つため、代わりに attribute という用語を使用しています。