ClusterKey (Azure SDK for Java Reference Documentation)

java.lang.Object
- com.azure.resourcemanager.cosmos.models.ClusterKey

public final class ClusterKey
extends Object

Cosmos DB Cassandra table cluster key.

Constructor Summary

Constructors
Constructor Description

ClusterKey()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`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".
`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

- Constructor Detail
  - ClusterKey
```
public ClusterKey()
```
- Method Detail
  - 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.