java.lang.Object
- software.amazon.awssdk.services.sesv2.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 email events to Amazon CloudWatch.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface CloudWatchDimensionConfiguration.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	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 the Amazon SES API v2 finds the value of a dimension to publish to Amazon CloudWatch.
`String`	`dimensionValueSourceAsString()`	The location where the Amazon SES API v2 finds the value of a dimension to publish to Amazon CloudWatch.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CloudWatchDimensionConfiguration.Builder>`	`serializableBuilderClass()`
`CloudWatchDimensionConfiguration.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - 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 the Amazon SES API v2 finds the value of a dimension to publish to Amazon CloudWatch. To use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail or SendRawEmail API, choose messageTag. To use your own email headers, choose emailHeader. 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 the Amazon SES API v2 finds the value of a dimension to publish to Amazon CloudWatch. To use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail or SendRawEmail API, choose messageTag. To use your own email headers, choose emailHeader. To use link tags, choose linkTags.
    
    See Also:
    
    DimensionValueSource
  - dimensionValueSourceAsString
```
public final String dimensionValueSourceAsString()
```
    The location where the Amazon SES API v2 finds the value of a dimension to publish to Amazon CloudWatch. To use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail or SendRawEmail API, choose messageTag. To use your own email headers, choose emailHeader. 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 the Amazon SES API v2 finds the value of a dimension to publish to Amazon CloudWatch. To use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail or SendRawEmail API, choose messageTag. To use your own email headers, choose emailHeader. To use link tags, choose linkTags.
    
    See Also:
    
    DimensionValueSource
  - 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:
    
    Can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-), at signs (@), and periods (.).
    
    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:
    
    Can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-), at signs (@), and periods (.).
    
    It can contain no more than 256 characters.
  - toBuilder
```
public CloudWatchDimensionConfiguration.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CloudWatchDimensionConfiguration.Builder,CloudWatchDimensionConfiguration>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class CloudWatchDimensionConfiguration

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

dimensionName

dimensionValueSource

dimensionValueSourceAsString

defaultDimensionValue

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField