Package com.azure.resourcemanager.cosmos.models

Class UniqueKeyPolicy

java.lang.Object
com.azure.resourcemanager.cosmos.models.UniqueKeyPolicy
All Implemented Interfaces:
com.azure.json.JsonSerializable<UniqueKeyPolicy>
public final class UniqueKeyPolicy extends Object implements com.azure.json.JsonSerializable<UniqueKeyPolicy>
The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    static UniqueKeyPolicy
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of UniqueKeyPolicy from the JsonReader.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)
    List<UniqueKey>
    uniqueKeys()
    Get the uniqueKeys property: List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.
    void
    validate()
    Validates the instance.
    UniqueKeyPolicy
    withUniqueKeys(List<UniqueKey> uniqueKeys)
    Set the uniqueKeys property: List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.

    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

    • UniqueKeyPolicy

      public UniqueKeyPolicy()
      Creates an instance of UniqueKeyPolicy class.

  • Method Details

    • uniqueKeys

      public List<UniqueKey> uniqueKeys()
      Get the uniqueKeys property: List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.
      Returns:
      the uniqueKeys value.

    • withUniqueKeys

      public UniqueKeyPolicy withUniqueKeys(List<UniqueKey> uniqueKeys)
      Set the uniqueKeys property: List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.
      Parameters:
      uniqueKeys - the uniqueKeys value to set.
      Returns:
      the UniqueKeyPolicy 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<UniqueKeyPolicy>
      Throws:
      IOException

    • fromJson

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