Package com.azure.cosmos.models

Class ClientEncryptionIncludedPath

java.lang.Object
com.azure.cosmos.models.ClientEncryptionIncludedPath
public final class ClientEncryptionIncludedPath extends Object
Path that needs encryption and the associated settings within ClientEncryptionPolicy.

  • Constructor Details

    • ClientEncryptionIncludedPath

      public ClientEncryptionIncludedPath()

  • Method Details

    • getPath

      public String getPath()
      Gets the path to be encrypted. Must be a top level path, eg. /salary.
      Returns:
      path

    • 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.

    • getClientEncryptionKeyId

      public String getClientEncryptionKeyId()
      Gets the identifier of the Data Encryption Key to be used to encrypt the path.
      Returns:
      clientEncryptionKeyId

    • 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.

    • getEncryptionType

      public String getEncryptionType()
      Gets the type of encryption to be performed. Egs.: Deterministic Randomized.
      Returns:
      encryptionType

    • setEncryptionType

      public ClientEncryptionIncludedPath setEncryptionType(String encryptionType)
      Sets the type of encryption to be performed. Egs.: Deterministic Randomized.
      Parameters:
      encryptionType - type of encryption
      Returns:
      ClientEncryptionIncludedPath.

    • getEncryptionAlgorithm

      public String getEncryptionAlgorithm()
      Gets the type of encryption algorithm to be performed. Eg - AEAD_AES_256_CBC_HMAC_SHA256.
      Returns:
      encryptionAlgorithm

    • 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.