com.azure.cosmos

Class CosmosKeyCredential

java.lang.Object

com.azure.cosmos.CosmosKeyCredential

public class CosmosKeyCredential
extends Object

Cosmos Key Credential is used to store key credentials, in order to support dynamic key rotation. Singleton instance should be used to support multiple keys. Azure client library for Cosmos ensures to use the updated key provided in the same singleton instance which was used when building CosmosAsyncClient

Constructor Summary

Constructors

Constructor and Description
CosmosKeyCredential(String key)

Method Summary

Modifier and Type	Method and Description
String	getKey() Returns the key stored in Cosmos Key Credential
int	getKeyHashCode() CosmosKeyCredential stores the computed hashcode of the key for performance improvements.
CosmosKeyCredential	setKey(String key) Sets the key to be used in CosmosKeyCredential

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CosmosKeyCredential

public CosmosKeyCredential(String key)

Method Detail

getKey

public String getKey()

Returns the key stored in Cosmos Key Credential

Returns:

key

setKey

public CosmosKeyCredential setKey(String key)

Sets the key to be used in CosmosKeyCredential

Parameters:

key - key to be used in CosmosKeyCredential

Returns:

current CosmosKeyCredential

getKeyHashCode

public int getKeyHashCode()

CosmosKeyCredential stores the computed hashcode of the key for performance improvements.

Returns:

hashcode of the key