Package com.azure.resourcemanager.cosmos.models

Class CompositePath

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

  • Constructor Details

    • CompositePath

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

    • order

      public CompositePathSortOrder order()
      Get the order property: Sort order for composite paths.
      Returns:
      the order value.

    • withOrder

      public CompositePath withOrder(CompositePathSortOrder order)
      Set the order property: Sort order for composite paths.
      Parameters:
      order - the order value to set.
      Returns:
      the CompositePath 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<CompositePath>
      Throws:
      IOException

    • fromJson

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