com.azure.resourcemanager.cosmos.models

Class CompositePath

java.lang.Object

com.azure.resourcemanager.cosmos.models.CompositePath

public final class CompositePath
extends Object

The CompositePath model.

Constructor Summary

Constructors

Constructor and Description
CompositePath()

Method Summary

Modifier and Type	Method and Description
CompositePathSortOrder	order() Get the order property: Sort order for composite paths.
String	path() Get the path property: The path for which the indexing behavior applies to.
void	validate() Validates the instance.
CompositePath	withOrder(CompositePathSortOrder order) Set the order property: Sort order for composite paths.
CompositePath	withPath(String path) Set the path property: The path for which the indexing behavior applies to.

Methods inherited from class java.lang.Object

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

Constructor Detail

CompositePath

public CompositePath()

Method Detail

path

public String path()

Get the path property: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*).

Returns:

the path value.

withPath

public CompositePath withPath(String path)

Set the path property: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*).

Parameters:

path - the path value to set.

Returns:

the CompositePath object itself.

order

public CompositePathSortOrder order()

Get the order property: Sort order for composite paths.

Returns:

the order value.

withOrder

public CompositePath withOrder(CompositePathSortOrder order)

Set the order property: Sort order for composite paths.

Parameters:

order - the order value to set.

Returns:

the CompositePath object itself.

validate

public void validate()

Validates the instance.

Throws:

IllegalArgumentException - thrown if the instance is not valid.