Share via

EncryptionKeyWrapMetadata Class

Package:
com.azure.cosmos.models
Maven Artifact:
com.azure:azure-cosmos:4.75.0
  • java.lang.Object
    • com.azure.cosmos.models.EncryptionKeyWrapMetadata

public final class EncryptionKeyWrapMetadata

Metadata that can be used to wrap/unwrap a Data Encryption Key using a Customer Managed Key. See https://aka.ms/CosmosClientEncryption for more information on client-side encryption support in Azure Cosmos DB.

Constructor Summary

Constructor Description
EncryptionKeyWrapMetadata()

For JSON deserialize
EncryptionKeyWrapMetadata(EncryptionKeyWrapMetadata source)

Creates a new instance of key wrap metadata based on an existing instance.
EncryptionKeyWrapMetadata(String type, String name, String value)

Creates a new instance of key wrap metadata based on an existing instance.
EncryptionKeyWrapMetadata(String type, String name, String value, String algorithm)

Creates a new instance of key wrap metadata based on an existing instance.

Method Summary

Modifier and Type Method and Description
boolean equals(Object obj)

Returns whether the properties of the passed in key wrap metadata matches with those in the current instance.
String getAlgorithm()

Serialized form of metadata.
String getName()

Serialized form of metadata.
String getType()

Serialized form of metadata.
String getValue()

Serialized form of metadata.
int hashCode()

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

EncryptionKeyWrapMetadata

public EncryptionKeyWrapMetadata()

For JSON deserialize

EncryptionKeyWrapMetadata

public EncryptionKeyWrapMetadata(EncryptionKeyWrapMetadata source)

Creates a new instance of key wrap metadata based on an existing instance.

Parameters:

source - Existing instance from which to initialize.

EncryptionKeyWrapMetadata

@Deprecated
public EncryptionKeyWrapMetadata(String type, String name, String value)

Creates a new instance of key wrap metadata based on an existing instance.

Parameters:

type - Type of the metadata.
name - Name of the metadata.
value - Value of the metadata.

EncryptionKeyWrapMetadata

public EncryptionKeyWrapMetadata(String type, String name, String value, String algorithm)

Creates a new instance of key wrap metadata based on an existing instance.

Parameters:

type - Type of the metadata.
name - Name of the metadata.
value - Value of the metadata.
algorithm - Algorithm of the metadata.

Method Details

equals

public boolean equals(Object obj)

Returns whether the properties of the passed in key wrap metadata matches with those in the current instance.

Overrides:

EncryptionKeyWrapMetadata.equals(Object obj)

Parameters:

obj - Key wrap metadata to be compared with current instance.

Returns:

True if the properties of the key wrap metadata passed in matches with those in the current instance, else false.

getAlgorithm

public String getAlgorithm()

Serialized form of metadata. Note: This value is saved in the Cosmos DB service. implementors of derived implementations should ensure that this does not have (private) key material or credential information.

Returns:

algorithm of metadata.

getName

public String getName()

Serialized form of metadata. Note: This value is saved in the Cosmos DB service. implementors of derived implementations should ensure that this does not have (private) key material or credential information.

Returns:

name of metadata.

getType

public String getType()

Serialized form of metadata. Note: This value is saved in the Cosmos DB service. implementors of derived implementations should ensure that this does not have (private) key material or credential information.

Returns:

type of metadata.

getValue

public String getValue()

Serialized form of metadata. Note: This value is saved in the Cosmos DB service. implementors of derived implementations should ensure that this does not have (private) key material or credential information.

Returns:

value of metadata

hashCode

public int hashCode()

Overrides:

EncryptionKeyWrapMetadata.hashCode()

Applies to