ContainerPartitionKey Class

Package:

com.azure.resourcemanager.cosmos.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-cosmos:2.46.0

• java.lang.Object
• • com.azure.resourcemanager.cosmos.models.ContainerPartitionKey

Implements

JsonSerializable<ContainerPartitionKey>

public final class ContainerPartitionKey
implements JsonSerializable<ContainerPartitionKey>

The configuration of the partition key to be used for partitioning data into multiple partitions.

Constructor Summary

Constructor	Description
ContainerPartitionKey()	Creates an instance of ContainerPartitionKey class.

Method Summary

Modifier and Type	Method and Description
static ContainerPartitionKey	fromJson(JsonReader jsonReader) Reads an instance of ContainerPartitionKey from the JsonReader.
PartitionKind	kind() Get the kind property: Indicates the kind of algorithm used for partitioning.
List<String>	paths() Get the paths property: List of paths using which data within the container can be partitioned.
Boolean	systemKey() Get the systemKey property: Indicates if the container is using a system generated partition key.
JsonWriter	toJson(JsonWriter jsonWriter)
void	validate() Validates the instance.
Integer	version() Get the version property: Indicates the version of the partition key definition.
ContainerPartitionKey	withKind(PartitionKind kind) Set the kind property: Indicates the kind of algorithm used for partitioning.
ContainerPartitionKey	withPaths(List<String> paths) Set the paths property: List of paths using which data within the container can be partitioned.
ContainerPartitionKey	withVersion(Integer version) Set the version property: Indicates the version of the partition key definition.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ContainerPartitionKey

public ContainerPartitionKey()

Creates an instance of ContainerPartitionKey class.

Method Details

fromJson

public static ContainerPartitionKey fromJson(JsonReader jsonReader)

Reads an instance of ContainerPartitionKey from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ContainerPartitionKey if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If an error occurs while reading the ContainerPartitionKey.

kind

public PartitionKind kind()

Get the kind property: Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create.

Returns:

the kind value.

paths

public List paths()

Get the paths property: List of paths using which data within the container can be partitioned.

Returns:

the paths value.

systemKey

public Boolean systemKey()

Get the systemKey property: Indicates if the container is using a system generated partition key.

Returns:

the systemKey value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

validate

public void validate()

Validates the instance.

version

public Integer version()

Get the version property: Indicates the version of the partition key definition.

Returns:

the version value.

withKind

public ContainerPartitionKey withKind(PartitionKind kind)

Set the kind property: Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create.

Parameters:

kind - the kind value to set.

Returns:

the ContainerPartitionKey object itself.

withPaths

public ContainerPartitionKey withPaths(List paths)

Set the paths property: List of paths using which data within the container can be partitioned.

Parameters:

paths - the paths value to set.

Returns:

the ContainerPartitionKey object itself.

withVersion

public ContainerPartitionKey withVersion(Integer version)

Set the version property: Indicates the version of the partition key definition.

Parameters:

version - the version value to set.

Returns:

the ContainerPartitionKey object itself.