Package software.amazon.awssdk.services.ses.model

Class SetIdentityHeadersInNotificationsEnabledRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.ses.model.SesRequest
software.amazon.awssdk.services.ses.model.SetIdentityHeadersInNotificationsEnabledRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<SetIdentityHeadersInNotificationsEnabledRequest.Builder,SetIdentityHeadersInNotificationsEnabledRequest>
@Generated("software.amazon.awssdk:codegen") public final class SetIdentityHeadersInNotificationsEnabledRequest extends SesRequest implements ToCopyableBuilder<SetIdentityHeadersInNotificationsEnabledRequest.Builder,SetIdentityHeadersInNotificationsEnabledRequest>

Represents a request to set whether Amazon SES includes the original email headers in the Amazon SNS notifications of a specified type. For information about notifications, see the Amazon SES Developer Guide.

  • Method Details

    • identity

      public final String identity()

      The identity for which to enable or disable headers in notifications. Examples: user@example.com, example.com.

      Returns:
      The identity for which to enable or disable headers in notifications. Examples: user@example.com, example.com.

    • notificationType

      public final NotificationType notificationType()

      The notification type for which to enable or disable headers in notifications.

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

      Returns:
      The notification type for which to enable or disable headers in notifications.
      See Also:

    • notificationTypeAsString

      public final String notificationTypeAsString()

      The notification type for which to enable or disable headers in notifications.

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

      Returns:
      The notification type for which to enable or disable headers in notifications.
      See Also:

    • enabled

      public final Boolean enabled()

      Sets whether Amazon SES includes the original email headers in Amazon SNS notifications of the specified notification type. A value of true specifies that Amazon SES includes headers in notifications, and a value of false specifies that Amazon SES does not include headers in notifications.

      This value can only be set when NotificationType is already set to use a particular Amazon SNS topic.

      Returns:
      Sets whether Amazon SES includes the original email headers in Amazon SNS notifications of the specified notification type. A value of true specifies that Amazon SES includes headers in notifications, and a value of false specifies that Amazon SES does not include headers in notifications.

      This value can only be set when NotificationType is already set to use a particular Amazon SNS topic.

    • toBuilder

      public SetIdentityHeadersInNotificationsEnabledRequest.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<SetIdentityHeadersInNotificationsEnabledRequest.Builder,SetIdentityHeadersInNotificationsEnabledRequest>
      Specified by:
      toBuilder in class SesRequest
      Returns:
      a builder for type T

    • builder

      public static SetIdentityHeadersInNotificationsEnabledRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SetIdentityHeadersInNotificationsEnabledRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

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

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.