126 строки
10 KiB
YAML
126 строки
10 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.resourcemanager.cosmos.models.ClientEncryptionPolicy"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.ClientEncryptionPolicy"
|
|
name: "ClientEncryptionPolicy"
|
|
nameWithType: "ClientEncryptionPolicy"
|
|
summary: "Cosmos DB 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**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.cosmos.models.ClientEncryptionPolicy?alt=com.azure.resourcemanager.cosmos.models.ClientEncryptionPolicy&text=ClientEncryptionPolicy\" data-throw-if-not-resolved=\"False\" />>"
|
|
constructors:
|
|
- uid: "com.azure.resourcemanager.cosmos.models.ClientEncryptionPolicy.ClientEncryptionPolicy()"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.ClientEncryptionPolicy.ClientEncryptionPolicy()"
|
|
name: "ClientEncryptionPolicy()"
|
|
nameWithType: "ClientEncryptionPolicy.ClientEncryptionPolicy()"
|
|
summary: "Creates an instance of Client<wbr>Encryption<wbr>Policy class."
|
|
syntax: "public ClientEncryptionPolicy()"
|
|
desc: "Creates an instance of ClientEncryptionPolicy class."
|
|
methods:
|
|
- uid: "com.azure.resourcemanager.cosmos.models.ClientEncryptionPolicy.fromJson(com.azure.json.JsonReader)"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.ClientEncryptionPolicy.fromJson(JsonReader jsonReader)"
|
|
name: "fromJson(JsonReader jsonReader)"
|
|
nameWithType: "ClientEncryptionPolicy.fromJson(JsonReader jsonReader)"
|
|
summary: "Reads an instance of Client<wbr>Encryption<wbr>Policy from the Json<wbr>Reader."
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "The JsonReader being read."
|
|
name: "jsonReader"
|
|
type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static ClientEncryptionPolicy fromJson(JsonReader jsonReader)"
|
|
exceptions:
|
|
- description: "If the deserialized JSON object was missing any required properties."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Reads an instance of ClientEncryptionPolicy from the JsonReader."
|
|
returns:
|
|
description: "An instance of ClientEncryptionPolicy if the JsonReader was pointing to an instance of it, or null if it\n was pointing to JSON null."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmos.models.ClientEncryptionPolicy?alt=com.azure.resourcemanager.cosmos.models.ClientEncryptionPolicy&text=ClientEncryptionPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.ClientEncryptionPolicy.includedPaths()"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.ClientEncryptionPolicy.includedPaths()"
|
|
name: "includedPaths()"
|
|
nameWithType: "ClientEncryptionPolicy.includedPaths()"
|
|
summary: "Get the included<wbr>Paths property: Paths of the item that need encryption along with path-specific settings."
|
|
syntax: "public List<ClientEncryptionIncludedPath> includedPaths()"
|
|
desc: "Get the includedPaths property: Paths of the item that need encryption along with path-specific settings."
|
|
returns:
|
|
description: "the includedPaths value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.resourcemanager.cosmos.models.ClientEncryptionIncludedPath?alt=com.azure.resourcemanager.cosmos.models.ClientEncryptionIncludedPath&text=ClientEncryptionIncludedPath\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.ClientEncryptionPolicy.policyFormatVersion()"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.ClientEncryptionPolicy.policyFormatVersion()"
|
|
name: "policyFormatVersion()"
|
|
nameWithType: "ClientEncryptionPolicy.policyFormatVersion()"
|
|
summary: "Get the policy<wbr>Format<wbr>Version property: Version of the client encryption policy definition."
|
|
syntax: "public int policyFormatVersion()"
|
|
desc: "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:
|
|
description: "the policyFormatVersion value."
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.ClientEncryptionPolicy.toJson(com.azure.json.JsonWriter)"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.ClientEncryptionPolicy.toJson(JsonWriter jsonWriter)"
|
|
name: "toJson(JsonWriter jsonWriter)"
|
|
nameWithType: "ClientEncryptionPolicy.toJson(JsonWriter jsonWriter)"
|
|
parameters:
|
|
- name: "jsonWriter"
|
|
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
|
|
exceptions:
|
|
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
returns:
|
|
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.ClientEncryptionPolicy.validate()"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.ClientEncryptionPolicy.validate()"
|
|
name: "validate()"
|
|
nameWithType: "ClientEncryptionPolicy.validate()"
|
|
summary: "Validates the instance."
|
|
syntax: "public void validate()"
|
|
desc: "Validates the instance."
|
|
- uid: "com.azure.resourcemanager.cosmos.models.ClientEncryptionPolicy.withIncludedPaths(java.util.List<com.azure.resourcemanager.cosmos.models.ClientEncryptionIncludedPath>)"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.ClientEncryptionPolicy.withIncludedPaths(List<ClientEncryptionIncludedPath> includedPaths)"
|
|
name: "withIncludedPaths(List<ClientEncryptionIncludedPath> includedPaths)"
|
|
nameWithType: "ClientEncryptionPolicy.withIncludedPaths(List<ClientEncryptionIncludedPath> includedPaths)"
|
|
summary: "Set the included<wbr>Paths property: Paths of the item that need encryption along with path-specific settings."
|
|
parameters:
|
|
- description: "the includedPaths value to set."
|
|
name: "includedPaths"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.resourcemanager.cosmos.models.ClientEncryptionIncludedPath?alt=com.azure.resourcemanager.cosmos.models.ClientEncryptionIncludedPath&text=ClientEncryptionIncludedPath\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public ClientEncryptionPolicy withIncludedPaths(List<ClientEncryptionIncludedPath> includedPaths)"
|
|
desc: "Set the includedPaths property: Paths of the item that need encryption along with path-specific settings."
|
|
returns:
|
|
description: "the ClientEncryptionPolicy object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmos.models.ClientEncryptionPolicy?alt=com.azure.resourcemanager.cosmos.models.ClientEncryptionPolicy&text=ClientEncryptionPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.ClientEncryptionPolicy.withPolicyFormatVersion(int)"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.ClientEncryptionPolicy.withPolicyFormatVersion(int policyFormatVersion)"
|
|
name: "withPolicyFormatVersion(int policyFormatVersion)"
|
|
nameWithType: "ClientEncryptionPolicy.withPolicyFormatVersion(int policyFormatVersion)"
|
|
summary: "Set the policy<wbr>Format<wbr>Version property: Version of the client encryption policy definition."
|
|
parameters:
|
|
- description: "the policyFormatVersion value to set."
|
|
name: "policyFormatVersion"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ClientEncryptionPolicy withPolicyFormatVersion(int policyFormatVersion)"
|
|
desc: "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."
|
|
returns:
|
|
description: "the ClientEncryptionPolicy object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmos.models.ClientEncryptionPolicy?alt=com.azure.resourcemanager.cosmos.models.ClientEncryptionPolicy&text=ClientEncryptionPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Cosmos DB client encryption policy."
|
|
implements:
|
|
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.cosmos.models.ClientEncryptionPolicy?alt=com.azure.resourcemanager.cosmos.models.ClientEncryptionPolicy&text=ClientEncryptionPolicy\" data-throw-if-not-resolved=\"False\" />>"
|
|
metadata: {}
|
|
package: "com.azure.resourcemanager.cosmos.models"
|
|
artifact: com.azure.resourcemanager:azure-resourcemanager-cosmos:2.44.0
|