Class TrackingConfigurationOverrides

java.lang.Object
software.amazon.awssdk.services.sesv2.model.TrackingConfigurationOverrides
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<TrackingConfigurationOverrides.Builder,TrackingConfigurationOverrides>
@Generated("software.amazon.awssdk:codegen") public final class TrackingConfigurationOverrides extends Object implements SdkPojo, Serializable, ToCopyableBuilder<TrackingConfigurationOverrides.Builder,TrackingConfigurationOverrides>

An object that overrides, for a single email sending request, the engagement tracking settings that would otherwise apply. Use these overrides to turn open tracking or click tracking on or off for an individual message, for example to suppress tracking in a transactional message that you send from an account or a configuration set that has tracking enabled.

Without an override, engagement tracking is determined by your account-level EngagementMetrics setting, which you configure using the PutAccountVdmAttributes operation, by the EngagementMetrics setting of the configuration set that the message uses, which you configure using the PutConfigurationSetVdmOptions operation, and by whether that configuration set has an event destination whose MatchingEventTypes include the OPEN or CLICK event types.

For more information about tracking open and click events, see the Amazon SES Developer Guide.

See Also:

  • Method Details

    • openTrackingEnabled

      public final FeatureStatus openTrackingEnabled()

      Specifies whether Amazon SES tracks when the recipient opens this message. Can be one of the following:

      • ENABLED – Amazon SES tracks opens for this message, even when your account-level and configuration set settings don't enable open tracking.

      • DISABLED – Amazon SES doesn't track opens for this message, even when your account-level or configuration set settings enable open tracking. Amazon SES doesn't add the tracking image to the message.

      If you don't specify this value, Amazon SES uses the open tracking setting that would otherwise apply to the message.

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

      Returns:
      Specifies whether Amazon SES tracks when the recipient opens this message. Can be one of the following:

      • ENABLED – Amazon SES tracks opens for this message, even when your account-level and configuration set settings don't enable open tracking.

      • DISABLED – Amazon SES doesn't track opens for this message, even when your account-level or configuration set settings enable open tracking. Amazon SES doesn't add the tracking image to the message.

      If you don't specify this value, Amazon SES uses the open tracking setting that would otherwise apply to the message.

      See Also:

    • openTrackingEnabledAsString

      public final String openTrackingEnabledAsString()

      Specifies whether Amazon SES tracks when the recipient opens this message. Can be one of the following:

      • ENABLED – Amazon SES tracks opens for this message, even when your account-level and configuration set settings don't enable open tracking.

      • DISABLED – Amazon SES doesn't track opens for this message, even when your account-level or configuration set settings enable open tracking. Amazon SES doesn't add the tracking image to the message.

      If you don't specify this value, Amazon SES uses the open tracking setting that would otherwise apply to the message.

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

      Returns:
      Specifies whether Amazon SES tracks when the recipient opens this message. Can be one of the following:

      • ENABLED – Amazon SES tracks opens for this message, even when your account-level and configuration set settings don't enable open tracking.

      • DISABLED – Amazon SES doesn't track opens for this message, even when your account-level or configuration set settings enable open tracking. Amazon SES doesn't add the tracking image to the message.

      If you don't specify this value, Amazon SES uses the open tracking setting that would otherwise apply to the message.

      See Also:

    • clickTrackingEnabled

      public final FeatureStatus clickTrackingEnabled()

      Specifies whether Amazon SES tracks when the recipient clicks a link in this message. Can be one of the following:

      • ENABLED – Amazon SES tracks clicks for this message, even when your account-level and configuration set settings don't enable click tracking.

      • DISABLED – Amazon SES doesn't track clicks for this message, even when your account-level or configuration set settings enable click tracking. Amazon SES doesn't rewrite the links in the message.

      If you don't specify this value, Amazon SES uses the click tracking setting that would otherwise apply to the message.

      Enabling open or click tracking with an override doesn't create an event destination. Amazon SES records the resulting open and click events in VDM, where you can review them using VDM metrics and Message Insights. To also receive these events at a destination that you own, the configuration set that the message uses must have an event destination that publishes open and click events.

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

      Returns:
      Specifies whether Amazon SES tracks when the recipient clicks a link in this message. Can be one of the following:

      • ENABLED – Amazon SES tracks clicks for this message, even when your account-level and configuration set settings don't enable click tracking.

      • DISABLED – Amazon SES doesn't track clicks for this message, even when your account-level or configuration set settings enable click tracking. Amazon SES doesn't rewrite the links in the message.

      If you don't specify this value, Amazon SES uses the click tracking setting that would otherwise apply to the message.

      Enabling open or click tracking with an override doesn't create an event destination. Amazon SES records the resulting open and click events in VDM, where you can review them using VDM metrics and Message Insights. To also receive these events at a destination that you own, the configuration set that the message uses must have an event destination that publishes open and click events.

      See Also:

    • clickTrackingEnabledAsString

      public final String clickTrackingEnabledAsString()

      Specifies whether Amazon SES tracks when the recipient clicks a link in this message. Can be one of the following:

      • ENABLED – Amazon SES tracks clicks for this message, even when your account-level and configuration set settings don't enable click tracking.

      • DISABLED – Amazon SES doesn't track clicks for this message, even when your account-level or configuration set settings enable click tracking. Amazon SES doesn't rewrite the links in the message.

      If you don't specify this value, Amazon SES uses the click tracking setting that would otherwise apply to the message.

      Enabling open or click tracking with an override doesn't create an event destination. Amazon SES records the resulting open and click events in VDM, where you can review them using VDM metrics and Message Insights. To also receive these events at a destination that you own, the configuration set that the message uses must have an event destination that publishes open and click events.

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

      Returns:
      Specifies whether Amazon SES tracks when the recipient clicks a link in this message. Can be one of the following:

      • ENABLED – Amazon SES tracks clicks for this message, even when your account-level and configuration set settings don't enable click tracking.

      • DISABLED – Amazon SES doesn't track clicks for this message, even when your account-level or configuration set settings enable click tracking. Amazon SES doesn't rewrite the links in the message.

      If you don't specify this value, Amazon SES uses the click tracking setting that would otherwise apply to the message.

      Enabling open or click tracking with an override doesn't create an event destination. Amazon SES records the resulting open and click events in VDM, where you can review them using VDM metrics and Message Insights. To also receive these events at a destination that you own, the configuration set that the message uses must have an event destination that publishes open and click events.

      See Also:

    • toBuilder

      public TrackingConfigurationOverrides.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<TrackingConfigurationOverrides.Builder,TrackingConfigurationOverrides>
      Returns:
      a builder for type T

    • builder

      public static TrackingConfigurationOverrides.Builder builder()

    • serializableBuilderClass

      public static Class<? extends TrackingConfigurationOverrides.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.