Share via

FullTextIndexPath Class

Package:
com.azure.resourcemanager.cosmos.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-cosmos:2.54.0
  • java.lang.Object
    • com.azure.resourcemanager.cosmos.models.FullTextIndexPath

Implements

JsonSerializable<FullTextIndexPath>

public final class FullTextIndexPath
implements JsonSerializable<FullTextIndexPath>

Represents the full text index path.

Constructor Summary

Constructor Description
FullTextIndexPath()

Creates an instance of FullTextIndexPath class.

Method Summary

Modifier and Type Method and Description
static FullTextIndexPath fromJson(JsonReader jsonReader)

Reads an instance of FullTextIndexPath from the JsonReader.
String path()

Get the path property: The path to the full text field in the document.
JsonWriter toJson(JsonWriter jsonWriter)
void validate()

Validates the instance.
FullTextIndexPath withPath(String path)

Set the path property: The path to the full text field in the document.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

FullTextIndexPath

public FullTextIndexPath()

Creates an instance of FullTextIndexPath class.

Method Details

fromJson

public static FullTextIndexPath fromJson(JsonReader jsonReader)

Reads an instance of FullTextIndexPath from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

path

public String path()

Get the path property: The path to the full text field in the document.

Returns:

the path value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

validate

public void validate()

Validates the instance.

withPath

public FullTextIndexPath withPath(String path)

Set the path property: The path to the full text field in the document.

Parameters:

path - the path value to set.

Returns:

the FullTextIndexPath object itself.

Applies to