Class CloudWatchDimensionConfiguration

java.lang.Object
software.amazon.awssdk.services.pinpointemail.model.CloudWatchDimensionConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<CloudWatchDimensionConfiguration.Builder,CloudWatchDimensionConfiguration>
@Generated("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:

  • Method Details

    • dimensionName

      public final 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 final 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:

    • dimensionValueSourceAsString

      public final 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:

    • defaultDimensionValue

      public final 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 final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String 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.
      Overrides:
      toString in class Object

    • getValueForField

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

    • sdkFields

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