DocumentCollection クラス

  • リファレンス
パッケージ:
com.microsoft.azure.cosmosdb

public class DocumentCollection extends Resource

Azure Cosmos DB データベース サービスのドキュメント コレクションを表します。 コレクションは、ドキュメントの名前付き論理コンテナーです。

データベースには 0 個以上の名前付きコレクションを含め、各コレクションは 0 個以上の JSON ドキュメントで構成されます。 スキーマを使用しないため、コレクション内のドキュメントは同じ構造またはフィールドを共有する必要はありません。 コレクションはアプリケーション リソースであるため、マスター キーまたはリソース キーを使用して承認できます。

コンストラクターの概要

コンストラクター 説明
DocumentCollection()

ドキュメント コレクション オブジェクトを初期化します。

DocumentCollection(String jsonString)

json 文字列からドキュメント コレクション オブジェクトを初期化します。

メソッドの概要

修飾子と型 メソッドと説明
boolean equals(Object obj)
ConflictResolutionPolicy getConflictResolutionPolicy()

Azure Cosmos DB サービスのコレクション内の異なるリージョンのドキュメントに対する競合する書き込みを解決するために使用される conflictResolutionPolicy を取得します。
String getConflictsLink()

コレクション内の競合の自己リンクを取得します。
Integer getDefaultTimeToLive()

コレクションの既定の有効期間の値を取得します。
String getDocumentsLink()

コレクション内のドキュメントの自己リンクを取得します。
IndexingPolicy getIndexingPolicy()

インデックス作成ポリシーを取得します。
PartitionKeyDefinition getPartitionKey()

コレクションのパーティション キー定義を取得します。
String getStoredProceduresLink()

コレクション内のストアド プロシージャのセルフリンクを取得します。
String getTriggersLink()

コレクション内のトリガーのセルフリンクを取得します。
UniqueKeyPolicy getUniqueKeyPolicy()

Azure Cosmos DB サービスのコレクション内のドキュメントの一意性を保証する Uni を設定します。

String getUserDefinedFunctionsLink()

コレクション内のユーザー定義関数の自己リンクを取得します。
int hashCode()
void setConflictResolutionPolicy(ConflictResolutionPolicy value)

Azure Cosmos DB サービスのコレクション内の異なるリージョンのドキュメントに対する競合する書き込みを解決するために使用される conflictResolutionPolicy を設定します。
void setDefaultTimeToLive(Integer timeToLive)

コレクションの既定の有効期間の値を設定します。

コレクションの既定の有効期間の値は省略可能なプロパティです。 設定した場合、コレクション内のドキュメントは、最後の書き込み時刻から指定した秒数後に期限切れになります。 このプロパティの値は、次のいずれかである必要があります。

null - 個々のドキュメントに有効期限が設定されているかどうかに関係なく、有効期間の評価が無効になり、コレクション内のドキュメントの有効期限が切れることがないことを示します。

0 以外の正の整数 - コレクション内のすべてのドキュメントの既定の有効期間の値を示します。 この値は、個々のドキュメントの有効期間の値によってオーバーライドできます。

-1 - 既定では、コレクション内のすべてのドキュメントの有効期限が切れないことを示します。 この値は、個々のドキュメントの有効期間の値によってオーバーライドできます。
void setIndexingPolicy(IndexingPolicy indexingPolicy)

インデックス作成ポリシーを設定します。
void setPartitionKey(PartitionKeyDefinition partitionKey)

コレクションのパーティション キー定義を設定します。
void setUniqueKeyPolicy(UniqueKeyPolicy uniqueKeyPolicy)

継承メンバー

JsonSerializable.get(String propertyName) JsonSerializable.getBoolean(String propertyName) JsonSerializable.getCollection(String propertyName) JsonSerializable.getDouble(String propertyName) Resource.getETag() JsonSerializable.getHashMap() Resource.getId() JsonSerializable.getInt(String propertyName) JsonSerializable.getLogger() JsonSerializable.getLong(String propertyName) JsonSerializable.getMapper() JsonSerializable.getObject(String propertyName) JsonSerializable.getObjectByPath(List<String> propertyNames) Resource.getResourceId() Resource.getSelfLink() JsonSerializable.getString(String propertyName) Resource.getTimestamp() JsonSerializable.has(String propertyName) JsonSerializable.JsonSerializable() JsonSerializable.JsonSerializable(String jsonString, ObjectMapper objectMapper) JsonSerializable.JsonSerializable(String jsonString) JsonSerializable.remove(String propertyName) Resource.Resource(Resource resource) Resource.Resource() Resource.Resource(String jsonString, ObjectMapper objectMapper) Resource.Resource(String jsonString) Resource.setId(String id) Resource.setResourceId(String resourceId) JsonSerializable.toJson() JsonSerializable.toJson(SerializationFormattingPolicy formattingPolicy) JsonSerializable.toString()

コンストラクターの詳細

DocumentCollection

public DocumentCollection()

ドキュメント コレクション オブジェクトを初期化します。

DocumentCollection

public DocumentCollection(String jsonString)

json 文字列からドキュメント コレクション オブジェクトを初期化します。

パラメーター:

jsonString - ドキュメント コレクションを表す json 文字列。

メソッドの詳細

equals

public boolean equals(Object obj)

パラメーター:

obj

getConflictResolutionPolicy

public ConflictResolutionPolicy getConflictResolutionPolicy()

Azure Cosmos DB サービスのコレクション内の異なるリージョンのドキュメントに対する競合する書き込みを解決するために使用される conflictResolutionPolicy を取得します。

戻り値:

ConflictResolutionPolicy

getConflictsLink

public String getConflictsLink()

コレクション内の競合の自己リンクを取得します。

戻り値:

競合リンク。

getDefaultTimeToLive

public Integer getDefaultTimeToLive()

コレクションの既定の有効期間の値を取得します。

戻り値:

既定の time-to-live 値 (秒単位)。

getDocumentsLink

public String getDocumentsLink()

コレクション内のドキュメントの自己リンクを取得します。

戻り値:

ドキュメント リンク。

getIndexingPolicy

public IndexingPolicy getIndexingPolicy()

インデックス作成ポリシーを取得します。

戻り値:

インデックス作成ポリシー。

getPartitionKey

public PartitionKeyDefinition getPartitionKey()

コレクションのパーティション キー定義を取得します。

戻り値:

パーティション キー定義。

getStoredProceduresLink

public String getStoredProceduresLink()

コレクション内のストアド プロシージャのセルフリンクを取得します。

戻り値:

ストアド プロシージャのリンク。

getTriggersLink

public String getTriggersLink()

コレクション内のトリガーのセルフリンクを取得します。

戻り値:

トリガー リンク。

getUniqueKeyPolicy

public UniqueKeyPolicy getUniqueKeyPolicy()

Azure Cosmos DB サービスのコレクション内のドキュメントの一意性を保証する Uni を設定します。

戻り値:

UniqueKeyPolicy

getUserDefinedFunctionsLink

public String getUserDefinedFunctionsLink()

コレクション内のユーザー定義関数の自己リンクを取得します。

戻り値:

ユーザー定義関数リンク。

hashCode

public int hashCode()

setConflictResolutionPolicy

public void setConflictResolutionPolicy(ConflictResolutionPolicy value)

Azure Cosmos DB サービスのコレクション内の異なるリージョンのドキュメントに対する競合する書き込みを解決するために使用される conflictResolutionPolicy を設定します。

パラメーター:

value - 使用する ConflictResolutionPolicy。

setDefaultTimeToLive

public void setDefaultTimeToLive(Integer timeToLive)

コレクションの既定の有効期間の値を設定します。

コレクションの既定の有効期間の値は省略可能なプロパティです。 設定した場合、コレクション内のドキュメントは、最後の書き込み時刻から指定した秒数後に期限切れになります。 このプロパティの値は、次のいずれかである必要があります。

null - 個々のドキュメントに有効期限が設定されているかどうかに関係なく、有効期間の評価が無効になり、コレクション内のドキュメントの有効期限が切れることがないことを示します。

0 以外の正の整数 - コレクション内のすべてのドキュメントの既定の有効期間の値を示します。 この値は、個々のドキュメントの有効期間の値によってオーバーライドできます。

-1 - 既定では、コレクション内のすべてのドキュメントの有効期限が切れないことを示します。 この値は、個々のドキュメントの有効期間の値によってオーバーライドできます。

パラメーター:

timeToLive - 既定の time-to-live 値 (秒単位)。

setIndexingPolicy

public void setIndexingPolicy(IndexingPolicy indexingPolicy)

インデックス作成ポリシーを設定します。

パラメーター:

indexingPolicy - インデックス作成ポリシー。

setPartitionKey

public void setPartitionKey(PartitionKeyDefinition partitionKey)

コレクションのパーティション キー定義を設定します。

パラメーター:

partitionKey - パーティション キー定義。

setUniqueKeyPolicy

public void setUniqueKeyPolicy(UniqueKeyPolicy uniqueKeyPolicy)

パラメーター:

uniqueKeyPolicy

適用対象