Package com.azure.resourcemanager.cosmos.models

Class ExcludedPath

java.lang.Object
com.azure.resourcemanager.cosmos.models.ExcludedPath
All Implemented Interfaces:
com.azure.json.JsonSerializable<ExcludedPath>
public final class ExcludedPath extends Object implements com.azure.json.JsonSerializable<ExcludedPath>
The ExcludedPath model.

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    static ExcludedPath
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of ExcludedPath from the JsonReader.
    String
    path()
    Get the path property: The path for which the indexing behavior applies to.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)
    void
    validate()
    Validates the instance.
    ExcludedPath
    withPath(String path)
    Set the path property: The path for which the indexing behavior applies to.

    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

    • ExcludedPath

      public ExcludedPath()
      Creates an instance of ExcludedPath class.

  • Method Details

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

    • withPath

      public ExcludedPath 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 ExcludedPath 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<ExcludedPath>
      Throws:
      IOException

    • fromJson

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