Package com.azure.cosmos.models
Class ClientEncryptionIncludedPath
java.lang.Object
com.azure.cosmos.models.ClientEncryptionIncludedPath
@Beta(value=V4_14_0,
warningText="Preview API - subject to change in non-backwards compatible way")
public final class ClientEncryptionIncludedPath
extends Object
Path that needs encryption and the associated settings within
ClientEncryptionPolicy
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGets the identifier of the Data Encryption Key to be used to encrypt the path.Gets the type of encryption algorithm to be performed.Gets the type of encryption to be performed.getPath()
Gets the path to be encrypted.setClientEncryptionKeyId
(String clientEncryptionKeyId) Sets the identifier of the Data Encryption Key to be used to encrypt the path.setEncryptionAlgorithm
(String encryptionAlgorithm) Sets the type of encryption algorithm to be performed.setEncryptionType
(String encryptionType) Sets the type of encryption to be performed.Sets the path to be encrypted.
-
Constructor Details
-
ClientEncryptionIncludedPath
public ClientEncryptionIncludedPath()
-
-
Method Details
-
getPath
@Beta(value=V4_14_0, warningText="Preview API - subject to change in non-backwards compatible way") public String getPath()Gets the path to be encrypted. Must be a top level path, eg. /salary.- Returns:
- path
-
setPath
@Beta(value=V4_14_0, warningText="Preview API - subject to change in non-backwards compatible way") 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.
-
getClientEncryptionKeyId
@Beta(value=V4_14_0, warningText="Preview API - subject to change in non-backwards compatible way") public String getClientEncryptionKeyId()Gets the identifier of the Data Encryption Key to be used to encrypt the path.- Returns:
- clientEncryptionKeyId
-
setClientEncryptionKeyId
@Beta(value=V4_14_0, warningText="Preview API - subject to change in non-backwards compatible way") 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.
-
getEncryptionType
@Beta(value=V4_14_0, warningText="Preview API - subject to change in non-backwards compatible way") public String getEncryptionType()Gets the type of encryption to be performed. Egs.: Deterministic Randomized.- Returns:
- encryptionType
-
setEncryptionType
@Beta(value=V4_14_0, warningText="Preview API - subject to change in non-backwards compatible way") public ClientEncryptionIncludedPath setEncryptionType(String encryptionType) Sets the type of encryption to be performed. Egs.: Deterministic Randomized.- Parameters:
encryptionType
- type of encryption- Returns:
- ClientEncryptionIncludedPath.
-
getEncryptionAlgorithm
@Beta(value=V4_14_0, warningText="Preview API - subject to change in non-backwards compatible way") public String getEncryptionAlgorithm()Gets the type of encryption algorithm to be performed. Eg - AEAD_AES_256_CBC_HMAC_SHA256.- Returns:
- encryptionAlgorithm
-
setEncryptionAlgorithm
@Beta(value=V4_14_0, warningText="Preview API - subject to change in non-backwards compatible way") 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.
-