CompositePath Class

Package:

com.azure.resourcemanager.cosmos.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-cosmos:2.47.0

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

Implements

JsonSerializable<CompositePath>

public final class CompositePath
implements JsonSerializable<CompositePath>

The CompositePath model.

Constructor Summary

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

Method Summary

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

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

CompositePath

public CompositePath()

Creates an instance of CompositePath class.

Method Details

fromJson

public static CompositePath fromJson(JsonReader jsonReader)

Reads an instance of CompositePath from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of CompositePath 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 CompositePath.

order

public CompositePathSortOrder order()

Get the order property: Sort order for composite paths.

Returns:

the order 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.

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.

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.