azure-docs-sdk-java/docs-ref-autogen/com.azure.cosmos.models.ClientEncryptionPolicy.yml

### YamlMime:JavaType
uid: "com.azure.cosmos.models.ClientEncryptionPolicy"
fullName: "com.azure.cosmos.models.ClientEncryptionPolicy"
name: "ClientEncryptionPolicy"
nameWithType: "ClientEncryptionPolicy"
summary: "Client encryption policy."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
  methodsRef:
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class ClientEncryptionPolicy"
constructors:
- uid: "com.azure.cosmos.models.ClientEncryptionPolicy.ClientEncryptionPolicy()"
  fullName: "com.azure.cosmos.models.ClientEncryptionPolicy.ClientEncryptionPolicy()"
  name: "ClientEncryptionPolicy()"
  nameWithType: "ClientEncryptionPolicy.ClientEncryptionPolicy()"
  summary: "Constructor."
  syntax: "public ClientEncryptionPolicy()"
  desc: "Constructor."
- uid: "com.azure.cosmos.models.ClientEncryptionPolicy.ClientEncryptionPolicy(java.util.List<com.azure.cosmos.models.ClientEncryptionIncludedPath>)"
  fullName: "com.azure.cosmos.models.ClientEncryptionPolicy.ClientEncryptionPolicy(List<ClientEncryptionIncludedPath> paths)"
  name: "ClientEncryptionPolicy(List<ClientEncryptionIncludedPath> paths)"
  nameWithType: "ClientEncryptionPolicy.ClientEncryptionPolicy(List<ClientEncryptionIncludedPath> paths)"
  summary: "Constructor."
  parameters:
  - description: "list of path of the item that need encryption along with path-specific settings."
    name: "paths"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.cosmos.models.ClientEncryptionIncludedPath?alt=com.azure.cosmos.models.ClientEncryptionIncludedPath&text=ClientEncryptionIncludedPath\" data-throw-if-not-resolved=\"False\" />&gt;"
  syntax: "public ClientEncryptionPolicy(List<ClientEncryptionIncludedPath> paths)"
  desc: "Constructor."
methods:
- uid: "com.azure.cosmos.models.ClientEncryptionPolicy.getIncludedPaths()"
  fullName: "com.azure.cosmos.models.ClientEncryptionPolicy.getIncludedPaths()"
  name: "getIncludedPaths()"
  nameWithType: "ClientEncryptionPolicy.getIncludedPaths()"
  summary: "Gets the list of path of the item that need encryption along with path-specific settings."
  syntax: "public List<ClientEncryptionIncludedPath> getIncludedPaths()"
  desc: "Gets the list of path of the item that need encryption along with path-specific settings."
  returns:
    description: "includedPaths"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.cosmos.models.ClientEncryptionIncludedPath?alt=com.azure.cosmos.models.ClientEncryptionIncludedPath&text=ClientEncryptionIncludedPath\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.cosmos.models.ClientEncryptionPolicy.getPolicyFormatVersion()"
  fullName: "com.azure.cosmos.models.ClientEncryptionPolicy.getPolicyFormatVersion()"
  name: "getPolicyFormatVersion()"
  nameWithType: "ClientEncryptionPolicy.getPolicyFormatVersion()"
  summary: "Version of the client encryption policy definition."
  syntax: "public int getPolicyFormatVersion()"
  desc: "Version of the client encryption policy definition."
  returns:
    description: "policyFormatVersion"
    type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Client encryption policy."
metadata: {}
package: "com.azure.cosmos.models"
artifact: com.azure:azure-cosmos:4.38.1