Package software.amazon.awssdk.services.pinpointemail.model

Enum DimensionValueSource

java.lang.Object

java.lang.Enum<DimensionValueSource>

software.amazon.awssdk.services.pinpointemail.model.DimensionValueSource

All Implemented Interfaces:

Serializable, Comparable<DimensionValueSource>

@Generated("software.amazon.awssdk:codegen")
public enum DimensionValueSource
extends Enum<DimensionValueSource>

The location where Amazon Pinpoint finds the value of a dimension to publish to Amazon CloudWatch. If you want Amazon Pinpoint to use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail/SendRawEmail API, choose messageTag. If you want Amazon Pinpoint to use your own email headers, choose emailHeader. If you want Amazon Pinpoint to use link tags, choose linkTags.

Enum Constant Summary

Enum Constants

Enum Constant	Description
EMAIL_HEADER
LINK_TAG
MESSAGE_TAG
UNKNOWN_TO_SDK_VERSION

Method Summary

Modifier and Type	Method	Description
static DimensionValueSource	fromValue(String value)	Use this in place of valueOf to convert the raw string returned by the service into the enum value.
static Set<DimensionValueSource>	knownValues()	Use this in place of values() to return a Set of all values known to the SDK.
String	toString()
static DimensionValueSource	valueOf(String name)	Returns the enum constant of this type with the specified name.
static DimensionValueSource[]	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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

MESSAGE_TAG

public static final DimensionValueSource MESSAGE_TAG

EMAIL_HEADER

public static final DimensionValueSource EMAIL_HEADER

LINK_TAG

public static final DimensionValueSource LINK_TAG

UNKNOWN_TO_SDK_VERSION

public static final DimensionValueSource UNKNOWN_TO_SDK_VERSION

Method Detail

values

public static DimensionValueSource[] 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 (DimensionValueSource c : DimensionValueSource.values())
    System.out.println(c);

Returns:

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

valueOf

public static DimensionValueSource 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()

Overrides:

toString in class Enum<DimensionValueSource>

fromValue

public static DimensionValueSource fromValue(String value)

Use this in place of valueOf to convert the raw string returned by the service into the enum value.

Parameters:

value - real value

Returns:

DimensionValueSource corresponding to the value

knownValues

public static Set<DimensionValueSource> knownValues()

Use this in place of values() to return a Set of all values known to the SDK. This will return all known enum values except UNKNOWN_TO_SDK_VERSION.

Returns:

a Set of known DimensionValueSources