Package software.amazon.awssdk.crt.auth.signing

Enum AwsSigningConfig.AwsSignatureType

java.lang.Object

java.lang.Enum<AwsSigningConfig.AwsSignatureType>

software.amazon.awssdk.crt.auth.signing.AwsSigningConfig.AwsSignatureType

All Implemented Interfaces:

Serializable, Comparable<AwsSigningConfig.AwsSignatureType>

Enclosing class:

AwsSigningConfig

public static enum AwsSigningConfig.AwsSignatureType
extends Enum<AwsSigningConfig.AwsSignatureType>

What sort of signature should be computed from the signable?

Enum Constant Summary

Enum Constants

Enum Constant	Description
HTTP_REQUEST_CHUNK	Compute a signature for a payload chunk.
HTTP_REQUEST_EVENT	Compute a signature for an event stream event.
HTTP_REQUEST_TRAILING_HEADERS	Compute a signature for a payloads trailing headers.
HTTP_REQUEST_VIA_HEADERS	A signature for a full http request should be computed, with header updates applied to the signing result.
HTTP_REQUEST_VIA_QUERY_PARAMS	A signature for a full http request should be computed, with query param updates applied to the signing result.

Method Summary

Modifier and Type	Method	Description
static AwsSigningConfig.AwsSignatureType	getEnumValueFromInteger(int value)	Creates a Java enum value from a native enum value as an integer
int	getNativeValue()	Gets the native enum value as an integer that is associated with this Java enum value
static AwsSigningConfig.AwsSignatureType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static AwsSigningConfig.AwsSignatureType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

HTTP_REQUEST_VIA_HEADERS

public static final AwsSigningConfig.AwsSignatureType HTTP_REQUEST_VIA_HEADERS

A signature for a full http request should be computed, with header updates applied to the signing result.

HTTP_REQUEST_VIA_QUERY_PARAMS

public static final AwsSigningConfig.AwsSignatureType HTTP_REQUEST_VIA_QUERY_PARAMS

A signature for a full http request should be computed, with query param updates applied to the signing result.

HTTP_REQUEST_CHUNK

public static final AwsSigningConfig.AwsSignatureType HTTP_REQUEST_CHUNK

Compute a signature for a payload chunk.

HTTP_REQUEST_EVENT

public static final AwsSigningConfig.AwsSignatureType HTTP_REQUEST_EVENT

Compute a signature for an event stream event. This option is not yet supported.

HTTP_REQUEST_TRAILING_HEADERS

public static final AwsSigningConfig.AwsSignatureType HTTP_REQUEST_TRAILING_HEADERS

Compute a signature for a payloads trailing headers.

Method Detail

values

public static AwsSigningConfig.AwsSignatureType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AwsSigningConfig.AwsSignatureType c : AwsSigningConfig.AwsSignatureType.values())
    System.out.println(c);

Returns:

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

valueOf

public static AwsSigningConfig.AwsSignatureType 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

getNativeValue

public int getNativeValue()

Gets the native enum value as an integer that is associated with this Java enum value

Returns:

this value's associated native enum value

getEnumValueFromInteger

public static AwsSigningConfig.AwsSignatureType getEnumValueFromInteger(int value)

Creates a Java enum value from a native enum value as an integer

Parameters:

value - native enum value

Returns:

the corresponding Java enum value