com.microsoft.azure.management.cosmosdb

Class ContainerPartitionKey

java.lang.Object

com.microsoft.azure.management.cosmosdb.ContainerPartitionKey

public 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 indicates the kind of algorithm used for partitioning.
List<String>	paths() Get list of paths using which data within the container can be partitioned.
Integer	version() Get indicates the version of the partition key definition.
ContainerPartitionKey	withKind(PartitionKind kind) Set indicates the kind of algorithm used for partitioning.
ContainerPartitionKey	withPaths(List<String> paths) Set list of paths using which data within the container can be partitioned.
ContainerPartitionKey	withVersion(Integer version) Set 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 list of paths using which data within the container can be partitioned.

Returns:

the paths value

withPaths

public ContainerPartitionKey withPaths(List<String> paths)

Set 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 indicates the kind of algorithm used for partitioning. Possible values include: 'Hash', 'Range'.

Returns:

the kind value

withKind

public ContainerPartitionKey withKind(PartitionKind kind)

Set indicates the kind of algorithm used for partitioning. Possible values include: 'Hash', 'Range'.

Parameters:

kind - the kind value to set

Returns:

the ContainerPartitionKey object itself.

version

public Integer version()

Get indicates the version of the partition key definition.

Returns:

the version value

withVersion

public ContainerPartitionKey withVersion(Integer version)

Set indicates the version of the partition key definition.

Parameters:

version - the version value to set

Returns:

the ContainerPartitionKey object itself.