Partager via

CompositePath Class

  • Reference
Package:
com.microsoft.azure.documentdb
Maven Artifact:
com.microsoft.azure:azure-documentdb:2.4.7

public class CompositePath
extends JsonSerializable

Represents a composite path of the IndexingPolicy in the Azure Cosmos DB database service. A composite path is used in a composite index. For example if you want to run a query like "SELECT * FROM c ORDER BY c.age, c.height", then you need to add "/age" and "/height" as composite paths to your composite index.

Constructor Summary

Constructor Description
CompositePath()

Constructor.
CompositePath(String jsonString)

Constructor.

Method Summary

Modifier and Type Method and Description
CompositePathSortOrder getOrder()

Gets the sort order for the composite path.
java.lang.String getPath()

Gets path.
void setOrder(CompositePathSortOrder order)

Gets the sort order for the composite path.
void setPath(String path)

Sets path.

Methods inherited from JsonSerializable

<T>getCollection <T>getObject <T>set <T>toObject get getBoolean getCollection getDouble getHashMap getInt getLogger getLong getMapper getObject getObjectByPath getString has remove toJson toJson toString toString

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Constructor Details

CompositePath

public CompositePath()

Constructor.

CompositePath

public CompositePath(String jsonString)

Constructor.

Parameters:

jsonString - the json string that represents the included path.

Method Details

getOrder

public CompositePathSortOrder getOrder()

Gets the sort order for the composite path. For example if you want to run the query "SELECT * FROM c ORDER BY c.age asc, c.height desc", then you need to make the order for "/age" "ascending" and the order for "/height" "descending".

Returns:

the sort order.

getPath

public String getPath()

Gets path.

Returns:

the path.

setOrder

public void setOrder(CompositePathSortOrder order)

Gets the sort order for the composite path. For example if you want to run the query "SELECT * FROM c ORDER BY c.age asc, c.height desc", then you need to make the order for "/age" "ascending" and the order for "/height" "descending".

Parameters:

order - the sort order.

setPath

public void setPath(String path)

Sets path.

Parameters:

path - the path.

Applies to