Package com.azure.resourcemanager.cosmos.models

Class ClientEncryptionPolicy

java.lang.Object

com.azure.resourcemanager.cosmos.models.ClientEncryptionPolicy

public final class ClientEncryptionPolicy
extends Object

Cosmos DB client encryption policy.

Constructor Summary

Constructors

Constructor	Description
ClientEncryptionPolicy()	Creates an instance of ClientEncryptionPolicy class.

Method Summary

Modifier and Type	Method	Description
List<ClientEncryptionIncludedPath>	includedPaths()	Get the includedPaths property: Paths of the item that need encryption along with path-specific settings.
int	policyFormatVersion()	Get the policyFormatVersion property: Version of the client encryption policy definition.
void	validate()	Validates the instance.
ClientEncryptionPolicy	withIncludedPaths(List<ClientEncryptionIncludedPath> includedPaths)	Set the includedPaths property: Paths of the item that need encryption along with path-specific settings.
ClientEncryptionPolicy	withPolicyFormatVersion(int policyFormatVersion)	Set the policyFormatVersion property: 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

public ClientEncryptionPolicy()

Creates an instance of ClientEncryptionPolicy class.

Method Details

includedPaths

public List<ClientEncryptionIncludedPath> includedPaths()

Get the includedPaths property: Paths of the item that need encryption along with path-specific settings.

Returns:

the includedPaths value.

withIncludedPaths

public ClientEncryptionPolicy withIncludedPaths(List<ClientEncryptionIncludedPath> includedPaths)

Set the includedPaths property: Paths of the item that need encryption along with path-specific settings.

Parameters:

includedPaths - the includedPaths value to set.

Returns:

the ClientEncryptionPolicy object itself.

policyFormatVersion

public int policyFormatVersion()

Get the policyFormatVersion property: Version of the client encryption policy definition. Supported versions are 1 and 2. Version 2 supports id and partition key path encryption.

Returns:

the policyFormatVersion value.

withPolicyFormatVersion

public ClientEncryptionPolicy withPolicyFormatVersion(int policyFormatVersion)

Set the policyFormatVersion property: Version of the client encryption policy definition. Supported versions are 1 and 2. Version 2 supports id and partition key path encryption.

Parameters:

policyFormatVersion - the policyFormatVersion value to set.

Returns:

the ClientEncryptionPolicy object itself.

validate

public void validate()

Validates the instance.

Throws:

IllegalArgumentException - thrown if the instance is not valid.