com.azure.cosmos.models

Class CompositePath

java.lang.Object

com.azure.cosmos.models.CompositePath

public final class CompositePath
extends Object

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

Constructors

Constructor and Description
CompositePath() Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
CompositePathSortOrder	getOrder() Gets the sort order for the composite path.
String	getPath() Gets path.
int	hashCode()
CompositePath	setOrder(CompositePathSortOrder order) Gets the sort order for the composite path.
CompositePath	setPath(String path) Sets path.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CompositePath

public CompositePath()

Constructor.

Method Detail

getPath

public String getPath()

Gets path.

Returns:

the path.

setPath

public CompositePath setPath(String path)

Sets path.

Parameters:

path - the path.

Returns:

the CompositePath.

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.

setOrder

public CompositePath 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.

Returns:

the CompositePath.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object