Package com.azure.cosmos.encryption.models

Enum CosmosEncryptionAlgorithm

java.lang.Object

java.lang.Enum<CosmosEncryptionAlgorithm>

com.azure.cosmos.encryption.models.CosmosEncryptionAlgorithm

All Implemented Interfaces:

Serializable, Comparable<CosmosEncryptionAlgorithm>, java.lang.constant.Constable

public enum CosmosEncryptionAlgorithm
extends Enum<CosmosEncryptionAlgorithm>

Algorithms for use with client-side encryption support in Azure Cosmos DB.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AEAD_AES_256_CBC_HMAC_SHA256	Authenticated Encryption algorithm based on https://tools.ietf.org/html/draft-mcgrew-aead-aes-cbc-hmac-sha2-05

Method Summary

Modifier and Type	Method	Description
static CosmosEncryptionAlgorithm	get(String name)	Gets the CosmosEncryptionAlgorithm enum back from the string value
String	getName()	Returns the name of algorithm
String	toString()	Returns the name of algorithm
static CosmosEncryptionAlgorithm	valueOf(String name)	Returns the enum constant of this type with the specified name.
static CosmosEncryptionAlgorithm[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

AEAD_AES_256_CBC_HMAC_SHA256

public static final CosmosEncryptionAlgorithm AEAD_AES_256_CBC_HMAC_SHA256

Authenticated Encryption algorithm based on https://tools.ietf.org/html/draft-mcgrew-aead-aes-cbc-hmac-sha2-05

Method Details

values

public static CosmosEncryptionAlgorithm[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CosmosEncryptionAlgorithm valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Returns the name of algorithm

Overrides:

toString in class Enum<CosmosEncryptionAlgorithm>

Returns:

algorithm name

getName

public String getName()

Returns the name of algorithm

Returns:

algorithm name

get

public static CosmosEncryptionAlgorithm get(String name)

Gets the CosmosEncryptionAlgorithm enum back from the string value

Parameters:

name - the string value

Returns:

CosmosEncryptionAlgorithm enum