CosmosClientEncryptionKeyProperties Class

  • Reference
Package:
com.azure.cosmos.models
Maven Artifact:
com.azure:azure-cosmos:4.59.0
  • java.lang.Object
    • com.azure.cosmos.models.CosmosClientEncryptionKeyProperties

public final class CosmosClientEncryptionKeyProperties

Details of an encryption key for use with the Azure Cosmos DB service.

Constructor Summary

Constructor Description
CosmosClientEncryptionKeyProperties(String id, String encryptionAlgorithm, byte[] wrappedDataEncryptionKey, EncryptionKeyWrapMetadata encryptionKeyWrapMetadata)

Constructor.

Method Summary

Modifier and Type Method and Description
String getETag()

Get the entity tag associated with the resource.
String getEncryptionAlgorithm()

Gets the encryption algorithm that will be used along with this client encryption key to encrypt/decrypt data.
EncryptionKeyWrapMetadata getEncryptionKeyWrapMetadata()

Gets the metadata for the wrapping provider that can be used to unwrap the wrapped client encryption key.
String getId()

Gets the name of the resource.
Instant getTimestamp()

Get the last modified timestamp associated with the resource.
byte[] getWrappedDataEncryptionKey()

Gets the wrapped form of the client encryption key.
CosmosClientEncryptionKeyProperties setEncryptionAlgorithm(String encryptionAlgorithm)

Sets the encryption algorithm that will be used along with this client encryption key to encrypt/decrypt data.
CosmosClientEncryptionKeyProperties setEncryptionKeyWrapMetadata(EncryptionKeyWrapMetadata encryptionKeyWrapMetadata)

Sets the metadata for the wrapping provider that can be used to unwrap the wrapped client encryption key.
CosmosClientEncryptionKeyProperties setId(String id)

Sets the name of the resource.
CosmosClientEncryptionKeyProperties setWrappedDataEncryptionKey(byte[] wrappedDataEncryptionKey)

Sets the wrapped form of the client encryption key.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

CosmosClientEncryptionKeyProperties

public CosmosClientEncryptionKeyProperties(String id, String encryptionAlgorithm, byte[] wrappedDataEncryptionKey, EncryptionKeyWrapMetadata encryptionKeyWrapMetadata)

Constructor.

Parameters:

id - Unique identifier for the client encryption key.
encryptionAlgorithm - Encryption algorithm that will be used along with this client encryption key to encrypt/decrypt data.
wrappedDataEncryptionKey - Wrapped (encrypted) form of the client encryption key.
encryptionKeyWrapMetadata - Metadata used by the configured key wrapping provider in order to unwrap the key.

Method Details

getETag

public String getETag()

Get the entity tag associated with the resource. This is only relevant when getting response from the server.

Returns:

the e tag.

getEncryptionAlgorithm

public String getEncryptionAlgorithm()

Gets the encryption algorithm that will be used along with this client encryption key to encrypt/decrypt data.

Returns:

encryptionAlgorithm

getEncryptionKeyWrapMetadata

public EncryptionKeyWrapMetadata getEncryptionKeyWrapMetadata()

Gets the metadata for the wrapping provider that can be used to unwrap the wrapped client encryption key.

Returns:

encryptionKeyWrapMetadata

getId

public String getId()

Gets the name of the resource.

Returns:

the name of the resource.

getTimestamp

public Instant getTimestamp()

Get the last modified timestamp associated with the resource. This is only relevant when getting response from the server.

Returns:

the timestamp.

getWrappedDataEncryptionKey

public byte[] getWrappedDataEncryptionKey()

Gets the wrapped form of the client encryption key.

Returns:

wrappedDataEncryptionKey

setEncryptionAlgorithm

public CosmosClientEncryptionKeyProperties setEncryptionAlgorithm(String encryptionAlgorithm)

Sets the encryption algorithm that will be used along with this client encryption key to encrypt/decrypt data.

Parameters:

encryptionAlgorithm - the encryption algorithm that will be used along with this client encryption key to encrypt/decrypt data.

Returns:

CosmosClientEncryptionKeyProperties

setEncryptionKeyWrapMetadata

public CosmosClientEncryptionKeyProperties setEncryptionKeyWrapMetadata(EncryptionKeyWrapMetadata encryptionKeyWrapMetadata)

Sets the metadata for the wrapping provider that can be used to unwrap the wrapped client encryption key.

Parameters:

encryptionKeyWrapMetadata - the metadata for the wrapping provider that can be used to unwrap the wrapped client encryption key.

Returns:

CosmosClientEncryptionKeyProperties

setId

public CosmosClientEncryptionKeyProperties setId(String id)

Sets the name of the resource.

Parameters:

id - the name of the resource.

Returns:

the current instance of CosmosContainerProperties.

setWrappedDataEncryptionKey

public CosmosClientEncryptionKeyProperties setWrappedDataEncryptionKey(byte[] wrappedDataEncryptionKey)

Sets the wrapped form of the client encryption key.

Parameters:

wrappedDataEncryptionKey - the wrapped form of the client encryption key.

Returns:

CosmosClientEncryptionKeyProperties

Applies to