Share via

ClientEncryptionIncludedPath Class

  • Reference
Package:
com.azure.cosmos.models
Maven Artifact:
com.azure:azure-cosmos:4.63.4
  • java.lang.Object
    • com.azure.cosmos.models.ClientEncryptionIncludedPath

public final class ClientEncryptionIncludedPath

Path that needs encryption and the associated settings within ClientEncryptionPolicy.

Constructor Summary

Constructor Description
ClientEncryptionIncludedPath()

Method Summary

Modifier and Type Method and Description
String getClientEncryptionKeyId()

Gets the identifier of the Data Encryption Key to be used to encrypt the path.
String getEncryptionAlgorithm()

Gets the type of encryption algorithm to be performed.
String getEncryptionType()

Gets the type of encryption to be performed.
String getPath()

Gets the path to be encrypted.
ClientEncryptionIncludedPath setClientEncryptionKeyId(String clientEncryptionKeyId)

Sets the identifier of the Data Encryption Key to be used to encrypt the path.
ClientEncryptionIncludedPath setEncryptionAlgorithm(String encryptionAlgorithm)

Sets the type of encryption algorithm to be performed.
ClientEncryptionIncludedPath setEncryptionType(String encryptionType)

Sets the type of encryption to be performed.
ClientEncryptionIncludedPath setPath(String path)

Sets the path to be encrypted.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ClientEncryptionIncludedPath

public ClientEncryptionIncludedPath()

Method Details

getClientEncryptionKeyId

public String getClientEncryptionKeyId()

Gets the identifier of the Data Encryption Key to be used to encrypt the path.

Returns:

clientEncryptionKeyId

getEncryptionAlgorithm

public String getEncryptionAlgorithm()

Gets the type of encryption algorithm to be performed. Eg - AEAD_AES_256_CBC_HMAC_SHA256.

Returns:

encryptionAlgorithm

getEncryptionType

public String getEncryptionType()

Gets the type of encryption to be performed. Egs.: Deterministic Randomized.

Returns:

encryptionType

getPath

public String getPath()

Gets the path to be encrypted. Must be a top level path, eg. /salary.

Returns:

path

setClientEncryptionKeyId

public ClientEncryptionIncludedPath setClientEncryptionKeyId(String clientEncryptionKeyId)

Sets the identifier of the Data Encryption Key to be used to encrypt the path.

Parameters:

clientEncryptionKeyId - identifier of the Data Encryption Key

Returns:

ClientEncryptionIncludedPath.

setEncryptionAlgorithm

public ClientEncryptionIncludedPath setEncryptionAlgorithm(String encryptionAlgorithm)

Sets the type of encryption algorithm to be performed. Eg - AEAD_AES_256_CBC_HMAC_SHA256.

Parameters:

encryptionAlgorithm - type of encryption algorithm

Returns:

ClientEncryptionIncludedPath.

setEncryptionType

public ClientEncryptionIncludedPath setEncryptionType(String encryptionType)

Sets the type of encryption to be performed. Egs.: Deterministic Randomized.

Parameters:

encryptionType - type of encryption

Returns:

ClientEncryptionIncludedPath.

setPath

public ClientEncryptionIncludedPath setPath(String path)

Sets the path to be encrypted. Must be a top level path, eg. /salary.

Parameters:

path - path to be encrypted

Returns:

ClientEncryptionIncludedPath.

Applies to