2021-04-07 22:42:11 +03:00
### YamlMime:JavaType
uid : "com.azure.cosmos.models.ClientEncryptionPolicy"
fullName : "com.azure.cosmos.models.ClientEncryptionPolicy"
name : "ClientEncryptionPolicy"
nameWithType : "ClientEncryptionPolicy"
summary : "Client encryption policy."
inheritances :
2022-08-11 07:43:16 +03:00
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
2022-09-27 07:22:51 +03:00
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>"
2022-11-01 07:30:49 +03:00
syntax : "public final class **ClientEncryptionPolicy**"
2021-04-07 22:42:11 +03:00
constructors :
2022-08-22 08:55:24 +03:00
- 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 :
2023-04-27 07:30:19 +03:00
- description : "list of path of the item that need encryption along with path-specific settings.\n the PolicyFormatVersion will be set to 1 which is the default value.\n Note: If you need to include partition key or id field paths as part of the ClientEncryptionPolicy, please set PolicyFormatVersion to 2."
2022-08-22 08:55:24 +03:00
name : "paths"
2022-09-07 07:25:44 +03:00
type : "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.cosmos.models.ClientEncryptionIncludedPath?alt=com.azure.cosmos.models.ClientEncryptionIncludedPath&text=ClientEncryptionIncludedPath\" data-throw-if-not-resolved=\"False\" />>"
2022-08-22 08:55:24 +03:00
syntax : "public ClientEncryptionPolicy(List<ClientEncryptionIncludedPath> paths)"
desc : "Constructor."
2023-04-27 07:30:19 +03:00
- uid : "com.azure.cosmos.models.ClientEncryptionPolicy.ClientEncryptionPolicy(java.util.List<com.azure.cosmos.models.ClientEncryptionIncludedPath>,int)"
fullName : "com.azure.cosmos.models.ClientEncryptionPolicy.ClientEncryptionPolicy(List<ClientEncryptionIncludedPath> paths, int policyFormatVersion)"
name : "ClientEncryptionPolicy(List<ClientEncryptionIncludedPath> paths, int policyFormatVersion)"
nameWithType : "ClientEncryptionPolicy.ClientEncryptionPolicy(List<ClientEncryptionIncludedPath> paths, int policyFormatVersion)"
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><<xref href=\"com.azure.cosmos.models.ClientEncryptionIncludedPath?alt=com.azure.cosmos.models.ClientEncryptionIncludedPath&text=ClientEncryptionIncludedPath\" data-throw-if-not-resolved=\"False\" />>"
- description : "version of the client encryption policy definition. Current supported versions are 1 and 2. Default version is 1.\n Note: If you need to include partition key or id field paths as part of the ClientEncryptionPolicy, please set PolicyFormatVersion to 2."
name : "policyFormatVersion"
type : "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
syntax : "public ClientEncryptionPolicy(List<ClientEncryptionIncludedPath> paths, int policyFormatVersion)"
desc : "Constructor."
2021-04-07 22:42:11 +03:00
methods :
2022-08-22 08:55:24 +03:00
- uid : "com.azure.cosmos.models.ClientEncryptionPolicy.getIncludedPaths()"
fullName : "com.azure.cosmos.models.ClientEncryptionPolicy.getIncludedPaths()"
name : "getIncludedPaths()"
nameWithType : "ClientEncryptionPolicy.getIncludedPaths()"
2023-04-27 07:30:19 +03:00
summary : "Gets the list of paths of the item that need encryption along with path-specific settings."
2022-08-22 08:55:24 +03:00
syntax : "public List<ClientEncryptionIncludedPath> getIncludedPaths()"
2023-04-27 07:30:19 +03:00
desc : "Gets the list of paths of the item that need encryption along with path-specific settings."
2022-08-22 08:55:24 +03:00
returns :
description : "includedPaths"
2022-09-07 07:25:44 +03:00
type : "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.cosmos.models.ClientEncryptionIncludedPath?alt=com.azure.cosmos.models.ClientEncryptionIncludedPath&text=ClientEncryptionIncludedPath\" data-throw-if-not-resolved=\"False\" />>"
2022-08-22 08:55:24 +03:00
- 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\" />"
2021-04-07 22:42:11 +03:00
type : "class"
2022-08-11 07:43:16 +03:00
desc : "Client encryption policy."
2021-04-07 22:42:11 +03:00
metadata : {}
package : "com.azure.cosmos.models"
2024-09-12 07:59:27 +03:00
artifact : com.azure:azure-cosmos:4.63.3
