Package com.azure.cosmos.models

Enum PartitionKind

java.lang.Object

java.lang.Enum<PartitionKind>

com.azure.cosmos.models.PartitionKind

All Implemented Interfaces:

Serializable, Comparable<PartitionKind>

public enum PartitionKind
extends Enum<PartitionKind>

Specifies the partition scheme for a multiple-partitioned container in the Azure Cosmos DB database service.

Enum Constant Summary

Enum Constants

Enum Constant	Description
HASH	The Partition of an item is calculated based on the hash value of the PartitionKey.
MULTI_HASH	The Partition of an item is calculated based on the hash value of multiple PartitionKeys.
RANGE	The Partition of an item is calculated based on a range.

Method Summary

Modifier and Type	Method	Description
String	toString()
static PartitionKind	valueOf(String name)	Returns the enum constant of this type with the specified name.
static PartitionKind[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

HASH

public static final PartitionKind HASH

The Partition of an item is calculated based on the hash value of the PartitionKey.

RANGE

public static final PartitionKind RANGE

The Partition of an item is calculated based on a range.

MULTI_HASH

@Beta(value=V4_16_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public static final PartitionKind MULTI_HASH

The Partition of an item is calculated based on the hash value of multiple PartitionKeys.

Method Detail

values

public static PartitionKind[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PartitionKind c : PartitionKind.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PartitionKind valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Overrides:

toString in class Enum<PartitionKind>