Class FullTextIndexPath

java.lang.Object
com.azure.resourcemanager.cosmos.models.FullTextIndexPath
All Implemented Interfaces:
com.azure.json.JsonSerializable<FullTextIndexPath>
public final class FullTextIndexPath extends Object implements com.azure.json.JsonSerializable<FullTextIndexPath>
Represents the full text index path.

  • Constructor Summary

    Constructors
    Constructor
    Description
    FullTextIndexPath()
    Creates an instance of FullTextIndexPath class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static FullTextIndexPath
    fromJson(com.azure.json.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.
    com.azure.json.JsonWriter
    toJson(com.azure.json.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 class Object

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

    Methods inherited from interface com.azure.json.JsonSerializable

    toJson, toJson, toJsonBytes, toJsonString

  • Constructor Details

    • FullTextIndexPath

      public FullTextIndexPath()
      Creates an instance of FullTextIndexPath class.

  • Method Details

    • path

      public String path()
      Get the path property: The path to the full text field in the document.
      Returns:
      the path value.

    • 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.

    • validate

      public void validate()
      Validates the instance.
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<FullTextIndexPath>
      Throws:
      IOException

    • fromJson

      public static FullTextIndexPath fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      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:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the FullTextIndexPath.