Class CloudWatchDimensionConfiguration
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
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.final String
The name of an Amazon CloudWatch dimension associated with an email sending metric.final DimensionValueSource
The location where Amazon Pinpoint finds the value of a dimension to publish to Amazon CloudWatch.final String
The location where Amazon Pinpoint finds the value of a dimension to publish to Amazon CloudWatch.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
static Class
<? extends CloudWatchDimensionConfiguration.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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, chooseemailHeader
. If you want Amazon Pinpoint to use link tags, chooselinkTags
.If the service returns an enum value that is not available in the current SDK version,
dimensionValueSource
will returnDimensionValueSource.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdimensionValueSourceAsString()
.- 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, chooseemailHeader
. If you want Amazon Pinpoint to use link tags, chooselinkTags
. - See Also:
-
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, chooseemailHeader
. If you want Amazon Pinpoint to use link tags, chooselinkTags
.If the service returns an enum value that is not available in the current SDK version,
dimensionValueSource
will returnDimensionValueSource.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdimensionValueSourceAsString()
.- 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, chooseemailHeader
. If you want Amazon Pinpoint to use link tags, chooselinkTags
. - See Also:
-
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
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 interfaceToCopyableBuilder<CloudWatchDimensionConfiguration.Builder,
CloudWatchDimensionConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-