PartitionKeyDefinition クラス

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

public class PartitionKeyDefinition extends JsonSerializable

Azure Cosmos DB データベース サービスのパーティション キー定義を表します。 パーティション キー定義は、複数のパーティションを持つコレクション内のパーティション キーとして使用されるドキュメント プロパティを指定します。

コンストラクターの概要

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

コンストラクターです。 PartitionKeyDefinition オブジェクトの新しいインスタンスを作成します。

PartitionKeyDefinition(String jsonString)

コンストラクターです。 JSON 文字列から PartitionKeyDefinition オブジェクトの新しいインスタンスを作成します。

メソッドの概要

修飾子と型 メソッドと説明
PartitionKind getKind()

パーティション キーを指定してパーティション ID を計算するために使用するパーティション アルゴリズムを設定します。
List<String> getPaths()

パーティション キーのドキュメント プロパティ パスを取得します。
PartitionKeyDefinitionVersion getVersion()
void setKind(PartitionKind kind)

パーティション キーを指定してパーティション ID を計算するために使用するパーティション アルゴリズムを設定します。
void setPaths(List<String> paths)

パーティション キーのドキュメント プロパティ パスを設定します。
void setVersion(PartitionKeyDefinitionVersion version)

継承メンバー

JsonSerializable.get(String propertyName) JsonSerializable.getBoolean(String propertyName) JsonSerializable.getCollection(String propertyName) JsonSerializable.getDouble(String propertyName) JsonSerializable.getHashMap() JsonSerializable.getInt(String propertyName) JsonSerializable.getLogger() JsonSerializable.getLong(String propertyName) JsonSerializable.getMapper() JsonSerializable.getObject(String propertyName) JsonSerializable.getObjectByPath(List<String> propertyNames) JsonSerializable.getString(String propertyName) JsonSerializable.has(String propertyName) JsonSerializable.JsonSerializable() JsonSerializable.JsonSerializable(String jsonString, ObjectMapper objectMapper) JsonSerializable.JsonSerializable(String jsonString) JsonSerializable.remove(String propertyName) JsonSerializable.toJson() JsonSerializable.toJson(SerializationFormattingPolicy formattingPolicy) JsonSerializable.toString()

コンストラクターの詳細

PartitionKeyDefinition

public PartitionKeyDefinition()

コンストラクターです。 PartitionKeyDefinition オブジェクトの新しいインスタンスを作成します。

PartitionKeyDefinition

public PartitionKeyDefinition(String jsonString)

コンストラクターです。 JSON 文字列から PartitionKeyDefinition オブジェクトの新しいインスタンスを作成します。

パラメーター:

jsonString - パーティション キー定義を表す JSON 文字列。

メソッドの詳細

getKind

public PartitionKind getKind()

パーティション キーを指定してパーティション ID を計算するために使用するパーティション アルゴリズムを設定します。

戻り値:

パーティション アルゴリズム。

getPaths

public List getPaths()

パーティション キーのドキュメント プロパティ パスを取得します。

戻り値:

パーティション キーを形成するドキュメント プロパティへのパス。

getVersion

public PartitionKeyDefinitionVersion getVersion()

setKind

public void setKind(PartitionKind kind)

パーティション キーを指定してパーティション ID を計算するために使用するパーティション アルゴリズムを設定します。

パラメーター:

kind - パーティション アルゴリズム。

setPaths

public void setPaths(List paths)

パーティション キーのドキュメント プロパティ パスを設定します。

パラメーター:

paths - パーティション キーを形成するドキュメント プロパティへのパス。

setVersion

public void setVersion(PartitionKeyDefinitionVersion version)

パラメーター:

version

適用対象