174 строки
14 KiB
YAML
174 строки
14 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.resourcemanager.cosmos.models.ClientEncryptionKeyResource"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.ClientEncryptionKeyResource"
|
|
name: "ClientEncryptionKeyResource"
|
|
nameWithType: "ClientEncryptionKeyResource"
|
|
summary: "Cosmos DB client encryption key resource object."
|
|
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 class **ClientEncryptionKeyResource**</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.ClientEncryptionKeyResource?alt=com.azure.resourcemanager.cosmos.models.ClientEncryptionKeyResource&text=ClientEncryptionKeyResource\" data-throw-if-not-resolved=\"False\" />>"
|
|
constructors:
|
|
- uid: "com.azure.resourcemanager.cosmos.models.ClientEncryptionKeyResource.ClientEncryptionKeyResource()"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.ClientEncryptionKeyResource.ClientEncryptionKeyResource()"
|
|
name: "ClientEncryptionKeyResource()"
|
|
nameWithType: "ClientEncryptionKeyResource.ClientEncryptionKeyResource()"
|
|
summary: "Creates an instance of Client<wbr>Encryption<wbr>Key<wbr>Resource class."
|
|
syntax: "public ClientEncryptionKeyResource()"
|
|
desc: "Creates an instance of ClientEncryptionKeyResource class."
|
|
methods:
|
|
- uid: "com.azure.resourcemanager.cosmos.models.ClientEncryptionKeyResource.encryptionAlgorithm()"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.ClientEncryptionKeyResource.encryptionAlgorithm()"
|
|
name: "encryptionAlgorithm()"
|
|
nameWithType: "ClientEncryptionKeyResource.encryptionAlgorithm()"
|
|
summary: "Get the encryption<wbr>Algorithm property: Encryption algorithm that will be used along with this client encryption key to encrypt/decrypt data."
|
|
syntax: "public String encryptionAlgorithm()"
|
|
desc: "Get the encryptionAlgorithm property: Encryption algorithm that will be used along with this client encryption key to encrypt/decrypt data."
|
|
returns:
|
|
description: "the encryptionAlgorithm value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.ClientEncryptionKeyResource.fromJson(com.azure.json.JsonReader)"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.ClientEncryptionKeyResource.fromJson(JsonReader jsonReader)"
|
|
name: "fromJson(JsonReader jsonReader)"
|
|
nameWithType: "ClientEncryptionKeyResource.fromJson(JsonReader jsonReader)"
|
|
summary: "Reads an instance of Client<wbr>Encryption<wbr>Key<wbr>Resource 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 ClientEncryptionKeyResource fromJson(JsonReader jsonReader)"
|
|
exceptions:
|
|
- description: "If an error occurs while reading the ClientEncryptionKeyResource."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Reads an instance of ClientEncryptionKeyResource from the JsonReader."
|
|
returns:
|
|
description: "An instance of ClientEncryptionKeyResource if the JsonReader was pointing to an instance of it, or null\n if it was pointing to JSON null."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmos.models.ClientEncryptionKeyResource?alt=com.azure.resourcemanager.cosmos.models.ClientEncryptionKeyResource&text=ClientEncryptionKeyResource\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.ClientEncryptionKeyResource.id()"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.ClientEncryptionKeyResource.id()"
|
|
name: "id()"
|
|
nameWithType: "ClientEncryptionKeyResource.id()"
|
|
summary: "Get the id property: Name of the Client<wbr>Encryption<wbr>Key."
|
|
syntax: "public String id()"
|
|
desc: "Get the id property: Name of the ClientEncryptionKey."
|
|
returns:
|
|
description: "the id value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.ClientEncryptionKeyResource.keyWrapMetadata()"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.ClientEncryptionKeyResource.keyWrapMetadata()"
|
|
name: "keyWrapMetadata()"
|
|
nameWithType: "ClientEncryptionKeyResource.keyWrapMetadata()"
|
|
summary: "Get the key<wbr>Wrap<wbr>Metadata property: Metadata for the wrapping provider that can be used to unwrap the wrapped client encryption key."
|
|
syntax: "public KeyWrapMetadata keyWrapMetadata()"
|
|
desc: "Get the keyWrapMetadata property: Metadata for the wrapping provider that can be used to unwrap the wrapped client encryption key."
|
|
returns:
|
|
description: "the keyWrapMetadata value."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmos.models.KeyWrapMetadata?alt=com.azure.resourcemanager.cosmos.models.KeyWrapMetadata&text=KeyWrapMetadata\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.ClientEncryptionKeyResource.toJson(com.azure.json.JsonWriter)"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.ClientEncryptionKeyResource.toJson(JsonWriter jsonWriter)"
|
|
name: "toJson(JsonWriter jsonWriter)"
|
|
nameWithType: "ClientEncryptionKeyResource.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.ClientEncryptionKeyResource.validate()"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.ClientEncryptionKeyResource.validate()"
|
|
name: "validate()"
|
|
nameWithType: "ClientEncryptionKeyResource.validate()"
|
|
summary: "Validates the instance."
|
|
syntax: "public void validate()"
|
|
desc: "Validates the instance."
|
|
- uid: "com.azure.resourcemanager.cosmos.models.ClientEncryptionKeyResource.withEncryptionAlgorithm(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.ClientEncryptionKeyResource.withEncryptionAlgorithm(String encryptionAlgorithm)"
|
|
name: "withEncryptionAlgorithm(String encryptionAlgorithm)"
|
|
nameWithType: "ClientEncryptionKeyResource.withEncryptionAlgorithm(String encryptionAlgorithm)"
|
|
summary: "Set the encryption<wbr>Algorithm property: Encryption algorithm that will be used along with this client encryption key to encrypt/decrypt data."
|
|
parameters:
|
|
- description: "the encryptionAlgorithm value to set."
|
|
name: "encryptionAlgorithm"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public ClientEncryptionKeyResource withEncryptionAlgorithm(String encryptionAlgorithm)"
|
|
desc: "Set the encryptionAlgorithm property: Encryption algorithm that will be used along with this client encryption key to encrypt/decrypt data."
|
|
returns:
|
|
description: "the ClientEncryptionKeyResource object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmos.models.ClientEncryptionKeyResource?alt=com.azure.resourcemanager.cosmos.models.ClientEncryptionKeyResource&text=ClientEncryptionKeyResource\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.ClientEncryptionKeyResource.withId(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.ClientEncryptionKeyResource.withId(String id)"
|
|
name: "withId(String id)"
|
|
nameWithType: "ClientEncryptionKeyResource.withId(String id)"
|
|
summary: "Set the id property: Name of the Client<wbr>Encryption<wbr>Key."
|
|
parameters:
|
|
- description: "the id value to set."
|
|
name: "id"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public ClientEncryptionKeyResource withId(String id)"
|
|
desc: "Set the id property: Name of the ClientEncryptionKey."
|
|
returns:
|
|
description: "the ClientEncryptionKeyResource object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmos.models.ClientEncryptionKeyResource?alt=com.azure.resourcemanager.cosmos.models.ClientEncryptionKeyResource&text=ClientEncryptionKeyResource\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.ClientEncryptionKeyResource.withKeyWrapMetadata(com.azure.resourcemanager.cosmos.models.KeyWrapMetadata)"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.ClientEncryptionKeyResource.withKeyWrapMetadata(KeyWrapMetadata keyWrapMetadata)"
|
|
name: "withKeyWrapMetadata(KeyWrapMetadata keyWrapMetadata)"
|
|
nameWithType: "ClientEncryptionKeyResource.withKeyWrapMetadata(KeyWrapMetadata keyWrapMetadata)"
|
|
summary: "Set the key<wbr>Wrap<wbr>Metadata property: Metadata for the wrapping provider that can be used to unwrap the wrapped client encryption key."
|
|
parameters:
|
|
- description: "the keyWrapMetadata value to set."
|
|
name: "keyWrapMetadata"
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmos.models.KeyWrapMetadata?alt=com.azure.resourcemanager.cosmos.models.KeyWrapMetadata&text=KeyWrapMetadata\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ClientEncryptionKeyResource withKeyWrapMetadata(KeyWrapMetadata keyWrapMetadata)"
|
|
desc: "Set the keyWrapMetadata property: Metadata for the wrapping provider that can be used to unwrap the wrapped client encryption key."
|
|
returns:
|
|
description: "the ClientEncryptionKeyResource object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmos.models.ClientEncryptionKeyResource?alt=com.azure.resourcemanager.cosmos.models.ClientEncryptionKeyResource&text=ClientEncryptionKeyResource\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.ClientEncryptionKeyResource.withWrappedDataEncryptionKey(byte[])"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.ClientEncryptionKeyResource.withWrappedDataEncryptionKey(byte[] wrappedDataEncryptionKey)"
|
|
name: "withWrappedDataEncryptionKey(byte[] wrappedDataEncryptionKey)"
|
|
nameWithType: "ClientEncryptionKeyResource.withWrappedDataEncryptionKey(byte[] wrappedDataEncryptionKey)"
|
|
summary: "Set the wrapped<wbr>Data<wbr>Encryption<wbr>Key property: Wrapped (encrypted) form of the key represented as a byte array."
|
|
parameters:
|
|
- description: "the wrappedDataEncryptionKey value to set."
|
|
name: "wrappedDataEncryptionKey"
|
|
type: "<xref href=\"byte?alt=byte&text=byte\" data-throw-if-not-resolved=\"False\" />[]"
|
|
syntax: "public ClientEncryptionKeyResource withWrappedDataEncryptionKey(byte[] wrappedDataEncryptionKey)"
|
|
desc: "Set the wrappedDataEncryptionKey property: Wrapped (encrypted) form of the key represented as a byte array."
|
|
returns:
|
|
description: "the ClientEncryptionKeyResource object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmos.models.ClientEncryptionKeyResource?alt=com.azure.resourcemanager.cosmos.models.ClientEncryptionKeyResource&text=ClientEncryptionKeyResource\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.ClientEncryptionKeyResource.wrappedDataEncryptionKey()"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.ClientEncryptionKeyResource.wrappedDataEncryptionKey()"
|
|
name: "wrappedDataEncryptionKey()"
|
|
nameWithType: "ClientEncryptionKeyResource.wrappedDataEncryptionKey()"
|
|
summary: "Get the wrapped<wbr>Data<wbr>Encryption<wbr>Key property: Wrapped (encrypted) form of the key represented as a byte array."
|
|
syntax: "public byte[] wrappedDataEncryptionKey()"
|
|
desc: "Get the wrappedDataEncryptionKey property: Wrapped (encrypted) form of the key represented as a byte array."
|
|
returns:
|
|
description: "the wrappedDataEncryptionKey value."
|
|
type: "<xref href=\"byte?alt=byte&text=byte\" data-throw-if-not-resolved=\"False\" />[]"
|
|
type: "class"
|
|
desc: "Cosmos DB client encryption key resource object."
|
|
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.ClientEncryptionKeyResource?alt=com.azure.resourcemanager.cosmos.models.ClientEncryptionKeyResource&text=ClientEncryptionKeyResource\" data-throw-if-not-resolved=\"False\" />>"
|
|
metadata: {}
|
|
package: "com.azure.resourcemanager.cosmos.models"
|
|
artifact: com.azure.resourcemanager:azure-resourcemanager-cosmos:2.44.0
|