Share via

CompositePath Class

  • Reference
Package:
com.azure.cosmos.models
Maven Artifact:
com.azure:azure-cosmos:4.63.4
  • java.lang.Object
    • com.azure.cosmos.models.CompositePath

public final class CompositePath

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.

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)

Sets the sort order for the composite path.
CompositePath setPath(String path)

Sets path.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

CompositePath

public CompositePath()

Constructor.

Method Details

equals

public boolean equals(Object o)

Overrides:

CompositePath.equals(Object o)

Parameters:

o

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.

hashCode

public int hashCode()

Overrides:

CompositePath.hashCode()

setOrder

public CompositePath setOrder(CompositePathSortOrder order)

Sets 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.

setPath

public CompositePath setPath(String path)

Sets path.

Parameters:

path - the path.

Returns:

the CompositePath.

Applies to