Share via

ClientEncryptionKeyGetPropertiesResource Class

  • Reference
Package:
com.azure.resourcemanager.cosmos.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-cosmos:2.44.1

public final class ClientEncryptionKeyGetPropertiesResource
extends ClientEncryptionKeyResource

The ClientEncryptionKeyGetPropertiesResource model.

Constructor Summary

Constructor Description
ClientEncryptionKeyGetPropertiesResource()

Creates an instance of ClientEncryptionKeyGetPropertiesResource class.

Method Summary

Modifier and Type Method and Description
String etag()

Get the etag property: A system generated property representing the resource etag required for optimistic concurrency control.
static ClientEncryptionKeyGetPropertiesResource fromJson(JsonReader jsonReader)

Reads an instance of ClientEncryptionKeyGetPropertiesResource from the JsonReader.
String rid()

Get the rid property: A system generated property.
JsonWriter toJson(JsonWriter jsonWriter)
Float ts()

Get the ts property: A system generated property that denotes the last updated timestamp of the resource.
void validate()

Validates the instance.
ClientEncryptionKeyGetPropertiesResource withEncryptionAlgorithm(String encryptionAlgorithm)

Set the encryptionAlgorithm property: Encryption algorithm that will be used along with this client encryption key to encrypt/decrypt data.
ClientEncryptionKeyGetPropertiesResource withId(String id)

Set the id property: Name of the ClientEncryptionKey.
ClientEncryptionKeyGetPropertiesResource withKeyWrapMetadata(KeyWrapMetadata keyWrapMetadata)

Set the keyWrapMetadata property: Metadata for the wrapping provider that can be used to unwrap the wrapped client encryption key.
ClientEncryptionKeyGetPropertiesResource withWrappedDataEncryptionKey(byte[] wrappedDataEncryptionKey)

Set the wrappedDataEncryptionKey property: Wrapped (encrypted) form of the key represented as a byte array.

Methods inherited from ClientEncryptionKeyResource

encryptionAlgorithm fromJson id keyWrapMetadata toJson validate withEncryptionAlgorithm withId withKeyWrapMetadata withWrappedDataEncryptionKey wrappedDataEncryptionKey

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ClientEncryptionKeyGetPropertiesResource

public ClientEncryptionKeyGetPropertiesResource()

Creates an instance of ClientEncryptionKeyGetPropertiesResource class.

Method Details

etag

public String etag()

Get the etag property: A system generated property representing the resource etag required for optimistic concurrency control.

Returns:

the etag value.

fromJson

public static ClientEncryptionKeyGetPropertiesResource fromJson(JsonReader jsonReader)

Reads an instance of ClientEncryptionKeyGetPropertiesResource from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ClientEncryptionKeyGetPropertiesResource if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If an error occurs while reading the ClientEncryptionKeyGetPropertiesResource.

rid

public String rid()

Get the rid property: A system generated property. A unique identifier.

Returns:

the rid value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

ClientEncryptionKeyGetPropertiesResource.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

ts

public Float ts()

Get the ts property: A system generated property that denotes the last updated timestamp of the resource.

Returns:

the ts value.

validate

public void validate()

Validates the instance.

Overrides:

ClientEncryptionKeyGetPropertiesResource.validate()

withEncryptionAlgorithm

public ClientEncryptionKeyGetPropertiesResource withEncryptionAlgorithm(String encryptionAlgorithm)

Set the encryptionAlgorithm property: Encryption algorithm that will be used along with this client encryption key to encrypt/decrypt data.

Overrides:

ClientEncryptionKeyGetPropertiesResource.withEncryptionAlgorithm(String encryptionAlgorithm)

Parameters:

encryptionAlgorithm

withId

public ClientEncryptionKeyGetPropertiesResource withId(String id)

Set the id property: Name of the ClientEncryptionKey.

Overrides:

ClientEncryptionKeyGetPropertiesResource.withId(String id)

Parameters:

id

withKeyWrapMetadata

public ClientEncryptionKeyGetPropertiesResource withKeyWrapMetadata(KeyWrapMetadata keyWrapMetadata)

Set the keyWrapMetadata property: Metadata for the wrapping provider that can be used to unwrap the wrapped client encryption key.

Overrides:

ClientEncryptionKeyGetPropertiesResource.withKeyWrapMetadata(KeyWrapMetadata keyWrapMetadata)

Parameters:

keyWrapMetadata

withWrappedDataEncryptionKey

public ClientEncryptionKeyGetPropertiesResource withWrappedDataEncryptionKey(byte[] wrappedDataEncryptionKey)

Set the wrappedDataEncryptionKey property: Wrapped (encrypted) form of the key represented as a byte array.

Overrides:

ClientEncryptionKeyGetPropertiesResource.withWrappedDataEncryptionKey(byte[] wrappedDataEncryptionKey)

Parameters:

wrappedDataEncryptionKey

Applies to