Class Indexes
- java.lang.Object
-
- com.microsoft.azure.management.cosmosdb.Indexes
-
public class Indexes extends Object
The indexes for the path.
-
-
Constructor Summary
Constructors Constructor Description Indexes()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DataTypedataType()Get the datatype for which the indexing behavior is applied to.IndexKindkind()Get indicates the type of index.Integerprecision()Get the precision of the index.IndexeswithDataType(DataType dataType)Set the datatype for which the indexing behavior is applied to.IndexeswithKind(IndexKind kind)Set indicates the type of index.IndexeswithPrecision(Integer precision)Set the precision of the index.
-
-
-
Method Detail
-
dataType
public DataType dataType()
Get the datatype for which the indexing behavior is applied to. Possible values include: 'String', 'Number', 'Point', 'Polygon', 'LineString', 'MultiPolygon'.- Returns:
- the dataType value
-
withDataType
public Indexes withDataType(DataType dataType)
Set the datatype for which the indexing behavior is applied to. Possible values include: 'String', 'Number', 'Point', 'Polygon', 'LineString', 'MultiPolygon'.- Parameters:
dataType- the dataType value to set- Returns:
- the Indexes object itself.
-
precision
public Integer precision()
Get the precision of the index. -1 is maximum precision.- Returns:
- the precision value
-
withPrecision
public Indexes withPrecision(Integer precision)
Set the precision of the index. -1 is maximum precision.- Parameters:
precision- the precision value to set- Returns:
- the Indexes object itself.
-
kind
public IndexKind kind()
Get indicates the type of index. Possible values include: 'Hash', 'Range', 'Spatial'.- Returns:
- the kind value
-
-