software.amazon.awssdk.services.pinpointemail.model

Class CloudWatchDimensionConfiguration

java.lang.Object

software.amazon.awssdk.services.pinpointemail.model.CloudWatchDimensionConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CloudWatchDimensionConfiguration.Builder,CloudWatchDimensionConfiguration>

@Generated(value="software.amazon.awssdk:codegen")
public final class CloudWatchDimensionConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CloudWatchDimensionConfiguration.Builder,CloudWatchDimensionConfiguration>

An object that defines the dimension configuration to use when you send Amazon Pinpoint email events to Amazon CloudWatch.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CloudWatchDimensionConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
static CloudWatchDimensionConfiguration.Builder	builder()
String	defaultDimensionValue() The default value of the dimension that is published to Amazon CloudWatch if you don't provide the value of the dimension when you send an email.
String	dimensionName() The name of an Amazon CloudWatch dimension associated with an email sending metric.
DimensionValueSource	dimensionValueSource() The location where Amazon Pinpoint finds the value of a dimension to publish to Amazon CloudWatch.
String	dimensionValueSourceAsString() The location where Amazon Pinpoint finds the value of a dimension to publish to Amazon CloudWatch.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends CloudWatchDimensionConfiguration.Builder>	serializableBuilderClass()
CloudWatchDimensionConfiguration.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

dimensionName

public String dimensionName()

The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to meet the following criteria:

• It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

• It can contain no more than 256 characters.

Returns:

The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to meet the following criteria:

• It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

• It can contain no more than 256 characters.

dimensionValueSource

public DimensionValueSource 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.

If the service returns an enum value that is not available in the current SDK version, dimensionValueSource will return DimensionValueSource.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dimensionValueSourceAsString().

Returns:

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.

See Also:

DimensionValueSource

dimensionValueSourceAsString

public String dimensionValueSourceAsString()

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.

If the service returns an enum value that is not available in the current SDK version, dimensionValueSource will return DimensionValueSource.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dimensionValueSourceAsString().

Returns:

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.

See Also:

DimensionValueSource

defaultDimensionValue

public String defaultDimensionValue()

The default value of the dimension that is published to Amazon CloudWatch if you don't provide the value of the dimension when you send an email. This value has to meet the following criteria:

• It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

• It can contain no more than 256 characters.

Returns:

The default value of the dimension that is published to Amazon CloudWatch if you don't provide the value of the dimension when you send an email. This value has to meet the following criteria:

• It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

• It can contain no more than 256 characters.

toBuilder

public CloudWatchDimensionConfiguration.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CloudWatchDimensionConfiguration.Builder,CloudWatchDimensionConfiguration>

Returns:

a builder for type T

builder

public static CloudWatchDimensionConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends CloudWatchDimensionConfiguration.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.