Class UniqueKey

java.lang.Object
com.azure.resourcemanager.cosmos.models.UniqueKey
All Implemented Interfaces:
com.azure.json.JsonSerializable<UniqueKey>
public final class UniqueKey extends Object implements com.azure.json.JsonSerializable<UniqueKey>
The unique key on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    static UniqueKey
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of UniqueKey from the JsonReader.
    List<String>
    paths()
    Get the paths property: List of paths must be unique for each document in the Azure Cosmos DB service.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)
    void
    validate()
    Validates the instance.
    UniqueKey
    withPaths(List<String> paths)
    Set the paths property: List of paths must be unique for each document in the Azure Cosmos DB service.

    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

    • UniqueKey

      public UniqueKey()
      Creates an instance of UniqueKey class.

  • Method Details

    • paths

      public List<String> paths()
      Get the paths property: List of paths must be unique for each document in the Azure Cosmos DB service.
      Returns:
      the paths value.

    • withPaths

      public UniqueKey withPaths(List<String> paths)
      Set the paths property: List of paths must be unique for each document in the Azure Cosmos DB service.
      Parameters:
      paths - the paths value to set.
      Returns:
      the UniqueKey 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<UniqueKey>
      Throws:
      IOException

    • fromJson

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