Package com.azure.cosmos.models

Class ClientEncryptionPolicy

java.lang.Object

com.azure.cosmos.models.ClientEncryptionPolicy

@Beta(value=V4_14_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public final class ClientEncryptionPolicy
extends Object

Client encryption policy.

Constructor Summary

Constructors

Constructor	Description
ClientEncryptionPolicy()	Constructor.
ClientEncryptionPolicy(List<ClientEncryptionIncludedPath> paths)	Constructor.

Method Summary

Modifier and Type	Method	Description
List<ClientEncryptionIncludedPath>	getIncludedPaths()	Gets the list of path of the item that need encryption along with path-specific settings.
int	getPolicyFormatVersion()	Version of the client encryption policy definition.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ClientEncryptionPolicy

@Beta(value=V4_14_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public ClientEncryptionPolicy(List<ClientEncryptionIncludedPath> paths)

Constructor.

Parameters:

paths - list of path of the item that need encryption along with path-specific settings.

ClientEncryptionPolicy

public ClientEncryptionPolicy()

Constructor.

Method Details

getIncludedPaths

@Beta(value=V4_11_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public List<ClientEncryptionIncludedPath> getIncludedPaths()

Gets the list of path of the item that need encryption along with path-specific settings.

Returns:

includedPaths

getPolicyFormatVersion

@Beta(value=V4_16_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public int getPolicyFormatVersion()

Version of the client encryption policy definition.

Returns:

policyFormatVersion