com.microsoft.azure.cosmosdb

Enum PartitionKeyDefinitionVersion

java.lang.Object

java.lang.Enum<PartitionKeyDefinitionVersion>

com.microsoft.azure.cosmosdb.PartitionKeyDefinitionVersion

All Implemented Interfaces:

Serializable, Comparable<PartitionKeyDefinitionVersion>

public enum PartitionKeyDefinitionVersion
extends Enum<PartitionKeyDefinitionVersion>

Partitioning version.

Enum Constant Summary

Enum Constants

Enum Constant and Description
V1 Original version of hash partitioning.
V2 Enhanced version of hash partitioning - offers better distribution of long partition keys and uses less storage.

Method Summary

Modifier and Type	Method and Description
static PartitionKeyDefinitionVersion	valueOf(String name) Returns the enum constant of this type with the specified name.
static PartitionKeyDefinitionVersion[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

V1

public static final PartitionKeyDefinitionVersion V1

Original version of hash partitioning.

V2

public static final PartitionKeyDefinitionVersion V2

Enhanced version of hash partitioning - offers better distribution of long partition keys and uses less storage. This version should be used for any practical purpose, but it is available in newer SDKs only.

Method Detail

values

public static PartitionKeyDefinitionVersion[] 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 (PartitionKeyDefinitionVersion c : PartitionKeyDefinitionVersion.values())
    System.out.println(c);

Returns:

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

valueOf

public static PartitionKeyDefinitionVersion 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