Package com.azure.resourcemanager.cosmos.models

Class IncludedPath

java.lang.Object
com.azure.resourcemanager.cosmos.models.IncludedPath
All Implemented Interfaces:
com.azure.json.JsonSerializable<IncludedPath>
public final class IncludedPath extends Object implements com.azure.json.JsonSerializable<IncludedPath>
The paths that are included in indexing.

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    static IncludedPath
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of IncludedPath from the JsonReader.
    List<Indexes>
    indexes()
    Get the indexes property: List of indexes for this path.
    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.
    IncludedPath
    withIndexes(List<Indexes> indexes)
    Set the indexes property: List of indexes for this path.
    IncludedPath
    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

    • IncludedPath

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

    • indexes

      public List<Indexes> indexes()
      Get the indexes property: List of indexes for this path.
      Returns:
      the indexes value.

    • withIndexes

      public IncludedPath withIndexes(List<Indexes> indexes)
      Set the indexes property: List of indexes for this path.
      Parameters:
      indexes - the indexes value to set.
      Returns:
      the IncludedPath 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<IncludedPath>
      Throws:
      IOException

    • fromJson

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