Share via

ClientEncryptionPolicy Class

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

public final class ClientEncryptionPolicy

Client encryption policy.

Constructor Summary

Constructor Description
ClientEncryptionPolicy()

Constructor.
ClientEncryptionPolicy(List<ClientEncryptionIncludedPath> paths)

Constructor.
ClientEncryptionPolicy(List<ClientEncryptionIncludedPath> paths, int policyFormatVersion)

Constructor.

Method Summary

Modifier and Type Method and Description
List<ClientEncryptionIncludedPath> getIncludedPaths()

Gets the list of paths of the item that need encryption along with path-specific settings.
int getPolicyFormatVersion()

Version of the client encryption policy definition.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ClientEncryptionPolicy

public ClientEncryptionPolicy()

Constructor.

ClientEncryptionPolicy

public ClientEncryptionPolicy(List paths)

Constructor.

Parameters:

paths - list of path of the item that need encryption along with path-specific settings. the PolicyFormatVersion will be set to 1 which is the default value. Note: If you need to include partition key or id field paths as part of the ClientEncryptionPolicy, please set PolicyFormatVersion to 2.

ClientEncryptionPolicy

public ClientEncryptionPolicy(List paths, int policyFormatVersion)

Constructor.

Parameters:

paths - list of path of the item that need encryption along with path-specific settings.
policyFormatVersion - version of the client encryption policy definition. Current supported versions are 1 and 2. Default version is 1. Note: If you need to include partition key or id field paths as part of the ClientEncryptionPolicy, please set PolicyFormatVersion to 2.

Method Details

getIncludedPaths

public List getIncludedPaths()

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

Returns:

includedPaths

getPolicyFormatVersion

public int getPolicyFormatVersion()

Version of the client encryption policy definition.

Returns:

policyFormatVersion

Applies to