com.azure.cosmos

Enum IndexKind

java.lang.Object

java.lang.Enum<IndexKind>

com.azure.cosmos.IndexKind

All Implemented Interfaces:

Serializable, Comparable<IndexKind>

public enum IndexKind
extends Enum<IndexKind>

These are the indexing types available for indexing a path in the Azure Cosmos DB database service. For additional details, refer to http://azure.microsoft.com/documentation/articles/documentdb-indexing-policies/#ConfigPolicy.

Enum Constant Summary

Enum Constants

Enum Constant and Description
HASH
RANGE
SPATIAL

Method Summary

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

RANGE

public static final IndexKind RANGE

SPATIAL

public static final IndexKind SPATIAL

Method Detail

values

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

Returns:

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

valueOf

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