Package com.azure.resourcemanager.cosmos.models

Class FullTextPath

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

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    static FullTextPath
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of FullTextPath from the JsonReader.
    String
    language()
    Get the language property: The language of the full text field in the document.
    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.
    FullTextPath
    withLanguage(String language)
    Set the language property: The language of the full text field in the document.
    FullTextPath
    withPath(String path)
    Set the path property: The path to the full text field in the document.

    Methods inherited from class java.lang.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

    • FullTextPath

      public FullTextPath()
      Creates an instance of FullTextPath 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 FullTextPath 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 FullTextPath object itself.

    • language

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

    • withLanguage

      public FullTextPath withLanguage(String language)
      Set the language property: The language of the full text field in the document.
      Parameters:
      language - the language value to set.
      Returns:
      the FullTextPath 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<FullTextPath>
      Throws:
      IOException

    • fromJson

      public static FullTextPath fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of FullTextPath from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of FullTextPath 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 FullTextPath.