Package com.azure.resourcemanager.cosmos.models

Class ClusterKey

java.lang.Object
com.azure.resourcemanager.cosmos.models.ClusterKey
All Implemented Interfaces:
com.azure.json.JsonSerializable<ClusterKey>
public final class ClusterKey extends Object implements com.azure.json.JsonSerializable<ClusterKey>
Cosmos DB Cassandra table cluster key.

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    static ClusterKey
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of ClusterKey from the JsonReader.
    String
    name()
    Get the name property: Name of the Cosmos DB Cassandra table cluster key.
    String
    orderBy()
    Get the orderBy property: Order of the Cosmos DB Cassandra table cluster key, only support "Asc" and "Desc".
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)
    void
    validate()
    Validates the instance.
    ClusterKey
    withName(String name)
    Set the name property: Name of the Cosmos DB Cassandra table cluster key.
    ClusterKey
    withOrderBy(String orderBy)
    Set the orderBy property: Order of the Cosmos DB Cassandra table cluster key, only support "Asc" and "Desc".

    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

    • ClusterKey

      public ClusterKey()
      Creates an instance of ClusterKey class.

  • Method Details

    • name

      public String name()
      Get the name property: Name of the Cosmos DB Cassandra table cluster key.
      Returns:
      the name value.

    • withName

      public ClusterKey withName(String name)
      Set the name property: Name of the Cosmos DB Cassandra table cluster key.
      Parameters:
      name - the name value to set.
      Returns:
      the ClusterKey object itself.

    • orderBy

      public String orderBy()
      Get the orderBy property: Order of the Cosmos DB Cassandra table cluster key, only support "Asc" and "Desc".
      Returns:
      the orderBy value.

    • withOrderBy

      public ClusterKey withOrderBy(String orderBy)
      Set the orderBy property: Order of the Cosmos DB Cassandra table cluster key, only support "Asc" and "Desc".
      Parameters:
      orderBy - the orderBy value to set.
      Returns:
      the ClusterKey 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<ClusterKey>
      Throws:
      IOException

    • fromJson

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