Package com.azure.cosmos.models

Class EncryptionKeyWrapMetadata

java.lang.Object

com.azure.cosmos.models.EncryptionKeyWrapMetadata

@Beta(value=V4_14_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public final class EncryptionKeyWrapMetadata
extends Object

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

Constructors

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)	Deprecated.
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	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 class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EncryptionKeyWrapMetadata

@Beta(value=V4_14_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public EncryptionKeyWrapMetadata()

For JSON deserialize

EncryptionKeyWrapMetadata

@Beta(value=V4_14_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
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

@Beta(value=V4_16_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
@Deprecated
public EncryptionKeyWrapMetadata(String type,
                                 String name,
                                 String value)

Deprecated.

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

@Beta(value=V4_27_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
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 Detail

getValue

@Beta(value=V4_14_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
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

getName

@Beta(value=V4_14_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
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

@Beta(value=V4_16_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
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.

getAlgorithm

@Beta(value=V4_16_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
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.

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:

equals in class Object

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.

hashCode

public int hashCode()

Overrides:

hashCode in class Object