次の方法で共有

Document クラス

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

public class Document extends Resource

Azure Cosmos DB データベース サービスのドキュメントを表します。

ドキュメントは、構造化された JSON ドキュメントです。 JSON ドキュメントにはスキーマが設定されておらず、ドキュメントには任意の数のカスタム プロパティと、オプションの添付ファイルの一覧が含まれる場合があります。 ドキュメントはアプリケーション リソースであり、マスター キーまたはリソース キーを使用して承認できます。

コンストラクターの概要

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

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

Document(String jsonString)

json 文字列からドキュメント オブジェクトを初期化します。
Document(String jsonString, ObjectMapper objectMapper)

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

メソッドの概要

修飾子と型 メソッドと説明
Integer getTimeToLive()

ドキュメントの有効期間の値を取得します。
void setTimeToLive(Integer timeToLive)

ドキュメントの有効期間の値を設定します。

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

null - このドキュメントの有効期間の値が親コレクションの既定の有効期間の値から継承することを示します。

0 以外の正の整数 - ドキュメントの有効期限が切れるまでの秒数を示します。 親コレクションの既定の有効期間が null でない限り、親コレクションで指定された既定の有効期間の値がオーバーライドされます。

-1 - ドキュメントの有効期限が切れないことを示します。 親コレクションの既定の有効期間が null でない限り、親コレクションで指定された既定の有効期間の値がオーバーライドされます。

継承メンバー

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()

コンストラクターの詳細

Document

public Document()

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

Document

public Document(String jsonString)

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

Parameters:

jsonString - ドキュメント オブジェクトを表す json 文字列。

Document

public Document(String jsonString, ObjectMapper objectMapper)

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

Parameters:

jsonString - ドキュメント オブジェクトを表す json 文字列。
objectMapper - カスタム オブジェクト マッパー

メソッドの詳細

getTimeToLive

public Integer getTimeToLive()

ドキュメントの有効期間の値を取得します。

Returns:

ドキュメントの有効期間の値を秒単位で指定します。

setTimeToLive

public void setTimeToLive(Integer timeToLive)

ドキュメントの有効期間の値を設定します。

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

null - このドキュメントの有効期間の値が親コレクションの既定の有効期間の値から継承することを示します。

0 以外の正の整数 - ドキュメントの有効期限が切れるまでの秒数を示します。 親コレクションの既定の有効期間が null でない限り、親コレクションで指定された既定の有効期間の値がオーバーライドされます。

-1 - ドキュメントの有効期限が切れないことを示します。 親コレクションの既定の有効期間が null でない限り、親コレクションで指定された既定の有効期間の値がオーバーライドされます。

Parameters:

timeToLive - ドキュメントの有効期間の値を秒単位で指定します。

適用対象