Share via

KeyWrapMetadata Class

  • Reference
Package:
com.azure.resourcemanager.cosmos.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-cosmos:2.44.1
  • java.lang.Object
    • com.azure.resourcemanager.cosmos.models.KeyWrapMetadata

Implements

JsonSerializable<KeyWrapMetadata>

public final class KeyWrapMetadata
implements JsonSerializable<KeyWrapMetadata>

Represents key wrap metadata that a key wrapping provider can use to wrap/unwrap a client encryption key.

Constructor Summary

Constructor Description
KeyWrapMetadata()

Creates an instance of KeyWrapMetadata class.

Method Summary

Modifier and Type Method and Description
String algorithm()

Get the algorithm property: Algorithm used in wrapping and unwrapping of the data encryption key.
static KeyWrapMetadata fromJson(JsonReader jsonReader)

Reads an instance of KeyWrapMetadata from the JsonReader.
String name()

Get the name property: The name of associated KeyEncryptionKey (aka CustomerManagedKey).
JsonWriter toJson(JsonWriter jsonWriter)
String type()

Get the type property: ProviderName of KeyStoreProvider.
void validate()

Validates the instance.
String value()

Get the value property: Reference / link to the KeyEncryptionKey.
KeyWrapMetadata withAlgorithm(String algorithm)

Set the algorithm property: Algorithm used in wrapping and unwrapping of the data encryption key.
KeyWrapMetadata withName(String name)

Set the name property: The name of associated KeyEncryptionKey (aka CustomerManagedKey).
KeyWrapMetadata withType(String type)

Set the type property: ProviderName of KeyStoreProvider.
KeyWrapMetadata withValue(String value)

Set the value property: Reference / link to the KeyEncryptionKey.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

KeyWrapMetadata

public KeyWrapMetadata()

Creates an instance of KeyWrapMetadata class.

Method Details

algorithm

public String algorithm()

Get the algorithm property: Algorithm used in wrapping and unwrapping of the data encryption key.

Returns:

the algorithm value.

fromJson

public static KeyWrapMetadata fromJson(JsonReader jsonReader)

Reads an instance of KeyWrapMetadata from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of KeyWrapMetadata 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 KeyWrapMetadata.

name

public String name()

Get the name property: The name of associated KeyEncryptionKey (aka CustomerManagedKey).

Returns:

the name value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public String type()

Get the type property: ProviderName of KeyStoreProvider.

Returns:

the type value.

validate

public void validate()

Validates the instance.

value

public String value()

Get the value property: Reference / link to the KeyEncryptionKey.

Returns:

the value value.

withAlgorithm

public KeyWrapMetadata withAlgorithm(String algorithm)

Set the algorithm property: Algorithm used in wrapping and unwrapping of the data encryption key.

Parameters:

algorithm - the algorithm value to set.

Returns:

the KeyWrapMetadata object itself.

withName

public KeyWrapMetadata withName(String name)

Set the name property: The name of associated KeyEncryptionKey (aka CustomerManagedKey).

Parameters:

name - the name value to set.

Returns:

the KeyWrapMetadata object itself.

withType

public KeyWrapMetadata withType(String type)

Set the type property: ProviderName of KeyStoreProvider.

Parameters:

type - the type value to set.

Returns:

the KeyWrapMetadata object itself.

withValue

public KeyWrapMetadata withValue(String value)

Set the value property: Reference / link to the KeyEncryptionKey.

Parameters:

value - the value value to set.

Returns:

the KeyWrapMetadata object itself.

Applies to