com.azure.resourcemanager.cosmos.models

Class IncludedPath

java.lang.Object

com.azure.resourcemanager.cosmos.models.IncludedPath

public final class IncludedPath
extends Object

The paths that are included in indexing.

Constructor Summary

Constructors

Constructor and Description
IncludedPath()

Method Summary

Modifier and Type	Method and Description
List<Indexes>	indexes() Get the indexes property: List of indexes for this path.
String	path() Get the path property: The path for which the indexing behavior applies to.
void	validate() Validates the instance.
IncludedPath	withIndexes(List<Indexes> indexes) Set the indexes property: List of indexes for this path.
IncludedPath	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

IncludedPath

public IncludedPath()

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 IncludedPath 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 IncludedPath object itself.

indexes

public List<Indexes> indexes()

Get the indexes property: List of indexes for this path.

Returns:

the indexes value.

withIndexes

public IncludedPath withIndexes(List<Indexes> indexes)

Set the indexes property: List of indexes for this path.

Parameters:

indexes - the indexes value to set.

Returns:

the IncludedPath object itself.

validate

public void validate()

Validates the instance.

Throws:

IllegalArgumentException - thrown if the instance is not valid.