CosmosContainerProperties クラス
- java.
lang. Object - com.
azure. cosmos. models. CosmosContainerProperties
- com.
public final class CosmosContainerProperties
Azure Cosmos DB データベース サービス内のコンテナーを表します。 Cosmos コンテナーは、Cosmos アイテムの名前付き論理コンテナーです。
データベースには 0 個以上の名前付きコンテナーを含め、各コンテナーは 0 個以上の JSON 項目で構成されます。 スキーマフリーのコンテナー内の項目は、同じ構造またはフィールドを共有する必要はありません。 コンテナーはアプリケーション リソースであるため、マスター キーまたはリソース キーを使用して承認できます。
コンストラクターの概要
| コンストラクター | 説明 |
|---|---|
| CosmosContainerProperties(String id, PartitionKeyDefinition partitionKeyDefinition) |
コンストラクター |
| CosmosContainerProperties(String id, String partitionKeyPath) |
コンストラクター |
メソッドの概要
メソッドの継承元: java.lang.Object
コンストラクターの詳細
CosmosContainerProperties
public CosmosContainerProperties(String id, PartitionKeyDefinition partitionKeyDefinition)
コンストラクター
Parameters:
CosmosContainerProperties
public CosmosContainerProperties(String id, String partitionKeyPath)
コンストラクター
Parameters:
メソッドの詳細
getAnalyticalStoreTimeToLiveInSeconds
public Integer getAnalyticalStoreTimeToLiveInSeconds()
Azure Cosmos DB サービスからコンテナー内の項目の分析ストアの有効期間を秒単位で取得します。 これは省略可能なプロパティです。 有効な値は、0 以外の正の整数、'-1'、または 0 である必要があります。 既定では、AnalyticalStoreTimeToLive は 0 に設定されています。これは、コンテナーに対して分析ストアがオフになっていることを意味します。-1 は、分析ストア内のアイテムの有効期限が切れないことを意味します。 測定単位は秒です。 許容される最大値は2147483647。
Returns:
getChangeFeedPolicy
public ChangeFeedPolicy getChangeFeedPolicy()
Azure Cosmos DB サービス内のこのコンテナーの changeFeedPolicy を取得します。
Returns:
getClientEncryptionPolicy
public ClientEncryptionPolicy getClientEncryptionPolicy()
項目フィールドの暗号化に使用される ClientEncryptionPolicy を取得します
Returns:
getComputedProperties
public Collection
Azure Cosmos DB サービス内のこのコンテナーの computedProperties を取得します。
Returns:
getConflictResolutionPolicy
public ConflictResolutionPolicy getConflictResolutionPolicy()
Azure Cosmos DB サービス内のコンテナー内の異なるリージョン内のアイテムに対する競合する書き込みを解決するために使用される conflictResolutionPolicy を取得します。
Returns:
getDefaultTimeToLiveInSeconds
public Integer getDefaultTimeToLiveInSeconds()
コンテナーの既定の有効期間の値を取得します。
Returns:
getETag
public String getETag()
リソースに関連付けられているエンティティ タグを取得します。 これは、サーバーから応答を取得する場合にのみ関連します。
Returns:
getId
public String getId()
リソースの名前を取得します。
Returns:
getIndexingPolicy
public IndexingPolicy getIndexingPolicy()
コンテナーのインデックス作成ポリシーを取得します。
Returns:
getPartitionKeyDefinition
public PartitionKeyDefinition getPartitionKeyDefinition()
コンテナーのパーティション キー定義を取得します。
Returns:
getResourceId
public String getResourceId()
リソースに関連付けられている ID を取得します。
Returns:
getTimestamp
public Instant getTimestamp()
リソースに関連付けられている最後に変更されたタイムスタンプを取得します。 これは、サーバーから応答を取得する場合にのみ関連します。
Returns:
getUniqueKeyPolicy
public UniqueKeyPolicy getUniqueKeyPolicy()
コンテナーの一意のキー ポリシーを取得します
Returns:
setAnalyticalStoreTimeToLiveInSeconds
public CosmosContainerProperties setAnalyticalStoreTimeToLiveInSeconds(Integer timeToLive)
Azure Cosmos DB サービスのコンテナー内の項目の分析ストアの有効期間を秒単位で設定します。 これは省略可能なプロパティです。 有効な値は、0 以外の正の整数 、'-1'、または 0 のいずれかである必要があります。 既定では、AnalyticalStoreTimeToLive は 0 に設定されています。これは、コンテナーの分析ストアがオフになっていることを意味します。-1 は、分析ストア内のアイテムの有効期限が切れないことを意味します。 測定単位は秒です。 許容される最大値は2147483647。
Parameters:
Returns:
setChangeFeedPolicy
public CosmosContainerProperties setChangeFeedPolicy(ChangeFeedPolicy value)
Azure Cosmos DB サービスのこのコンテナーの changeFeedPolicy を設定します。
Parameters:
Returns:
setClientEncryptionPolicy
public CosmosContainerProperties setClientEncryptionPolicy(ClientEncryptionPolicy value)
項目フィールドの暗号化に使用される ClientEncryptionPolicy を設定します
Parameters:
Returns:
setComputedProperties
public CosmosContainerProperties setComputedProperties(Collection
Azure Cosmos DB サービスのこのコンテナーの computedProperties を設定します。 計算プロパティの使用方法の詳細については、「Azure Cosmos DB の計算プロパティ」を参照してください。
Parameters:
Returns:
setConflictResolutionPolicy
public CosmosContainerProperties setConflictResolutionPolicy(ConflictResolutionPolicy value)
Azure Cosmos DB サービス内のコンテナー内の異なるリージョン内の項目に対する競合する書き込みを解決するために使用される conflictResolutionPolicy を設定します。
Parameters:
Returns:
setDefaultTimeToLiveInSeconds
public CosmosContainerProperties setDefaultTimeToLiveInSeconds(Integer timeToLive)
コンテナーの既定の有効期間の値を設定します。
コンテナーの既定の有効期間の値は省略可能なプロパティです。 設定した場合、コンテナー内の項目は、最後の書き込み時間から指定した秒数後に期限切れになります。 このプロパティの値は、次のいずれかである必要があります。
null - 個々のアイテムに有効期限が設定されているかどうかに関係なく、有効期間の評価が無効になり、コンテナー内の項目が期限切れになることがないことを示します。
0 以外の正の整数 - コンテナー内のすべての項目の既定の有効期間の値を示します。 この値は、個々のアイテムの有効期間の値によってオーバーライドできます。
-1 - 既定では、コンテナー内のすべての項目の有効期限が切れないことを示します。 この値は、個々のアイテムの有効期間の値によってオーバーライドできます。
Parameters:
Returns:
setId
public CosmosContainerProperties setId(String id)
リソースの名前を設定します。
Parameters:
Returns:
setIndexingPolicy
public CosmosContainerProperties setIndexingPolicy(IndexingPolicy indexingPolicy)
コンテナーのインデックス作成ポリシーを設定します
Parameters:
Returns:
setPartitionKeyDefinition
public CosmosContainerProperties setPartitionKeyDefinition(PartitionKeyDefinition partitionKeyDefinition)
コンテナーのパーティション キー定義を設定します。
Parameters:
Returns:
setUniqueKeyPolicy
public CosmosContainerProperties setUniqueKeyPolicy(UniqueKeyPolicy uniqueKeyPolicy)
コンテナーの一意キー ポリシーを設定します
Parameters:
Returns:
適用対象
Azure SDK for Java