com.azure.resourcemanager.cosmos.models

Class ContainerPartitionKey

java.lang.Object

com.azure.resourcemanager.cosmos.models.ContainerPartitionKey

public final class ContainerPartitionKey
extends Object

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

Constructor Summary

Constructors

Constructor and Description
ContainerPartitionKey()

Method Summary

Modifier and Type	Method and Description
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.
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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ContainerPartitionKey

public ContainerPartitionKey()

Method Detail

paths

public List<String> paths()

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

Returns:

the paths value.

withPaths

public ContainerPartitionKey withPaths(List<String> 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.

kind

public PartitionKind kind()

Get the kind property: Indicates the kind of algorithm used for partitioning.

Returns:

the kind value.

withKind

public ContainerPartitionKey withKind(PartitionKind kind)

Set the kind property: Indicates the kind of algorithm used for partitioning.

Parameters:

kind - the kind value to set.

Returns:

the ContainerPartitionKey object itself.

version

public Integer version()

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

Returns:

the version value.

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.

validate

public void validate()

Validates the instance.

Throws:

IllegalArgumentException - thrown if the instance is not valid.