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

Constructors
Constructor Description

ClientEncryptionIncludedPath()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	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 class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- ClientEncryptionIncludedPath
```
public ClientEncryptionIncludedPath()
```

Method Detail

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.

Class ClientEncryptionIncludedPath

Constructor Summary