Class TrackingOptions

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

An object that defines the tracking options for a configuration set. When you use the Amazon SES API v2 to send an email, it contains an invisible image that's used to track when recipients open your email. If your email contains links, those links are changed slightly in order to track when recipients click them.

These images and links include references to a domain operated by Amazon Web Services. You can optionally configure the Amazon SES to use a domain that you operate for these images and links.

See Also:

  • Method Details

    • customRedirectDomain

      public final String customRedirectDomain()

      The domain to use for tracking open and click events.

      Returns:
      The domain to use for tracking open and click events.

    • httpsPolicy

      public final HttpsPolicy httpsPolicy()

      The https policy to use for tracking open and click events.

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

      Returns:
      The https policy to use for tracking open and click events.
      See Also:

    • httpsPolicyAsString

      public final String httpsPolicyAsString()

      The https policy to use for tracking open and click events.

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

      Returns:
      The https policy to use for tracking open and click events.
      See Also:

    • toBuilder

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

    • builder

      public static TrackingOptions.Builder builder()

    • serializableBuilderClass

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