IncludedPath Class

Package:

com.azure.resourcemanager.cosmos.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-cosmos:2.46.0

• java.lang.Object
• • com.azure.resourcemanager.cosmos.models.IncludedPath

Implements

JsonSerializable<IncludedPath>

public final class IncludedPath
implements JsonSerializable<IncludedPath>

The paths that are included in indexing.

Constructor Summary

Constructor	Description
IncludedPath()	Creates an instance of IncludedPath class.

Method Summary

Modifier and Type	Method and Description
static IncludedPath	fromJson(JsonReader jsonReader) Reads an instance of IncludedPath from the JsonReader.
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.
JsonWriter	toJson(JsonWriter jsonWriter)
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 java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

IncludedPath

public IncludedPath()

Creates an instance of IncludedPath class.

Method Details

fromJson

public static IncludedPath fromJson(JsonReader jsonReader)

Reads an instance of IncludedPath from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of IncludedPath if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If an error occurs while reading the IncludedPath.

indexes

public List indexes()

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

Returns:

the indexes value.

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.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

validate

public void validate()

Validates the instance.

withIndexes

public IncludedPath withIndexes(List indexes)

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

Parameters:

indexes - the indexes value to set.

Returns:

the IncludedPath object itself.

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.