Share via

ClusterKey Class

  • Reference
Package:
com.azure.resourcemanager.cosmos.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-cosmos:2.44.1
  • java.lang.Object
    • com.azure.resourcemanager.cosmos.models.ClusterKey

Implements

JsonSerializable<ClusterKey>

public final class ClusterKey
implements JsonSerializable<ClusterKey>

Cosmos DB Cassandra table cluster key.

Constructor Summary

Constructor Description
ClusterKey()

Creates an instance of ClusterKey class.

Method Summary

Modifier and Type Method and Description
static ClusterKey fromJson(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".
JsonWriter toJson(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 java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ClusterKey

public ClusterKey()

Creates an instance of ClusterKey class.

Method Details

fromJson

public static ClusterKey fromJson(JsonReader jsonReader)

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.

name

public String name()

Get the name property: Name of the Cosmos DB Cassandra table cluster key.

Returns:

the name value.

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.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

validate

public void validate()

Validates the instance.

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.

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.

Applies to