Class AddHeaderAction

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

When included in a receipt rule, this action adds a header to the received email.

For information about adding a header using a receipt rule, see the Amazon SES Developer Guide.

See Also:

  • Method Details

    • headerName

      public final String headerName()

      The name of the header to add to the incoming message. The name must contain at least one character, and can contain up to 50 characters. It consists of alphanumeric (a–z, A–Z, 0–9) characters and dashes.

      Returns:
      The name of the header to add to the incoming message. The name must contain at least one character, and can contain up to 50 characters. It consists of alphanumeric (a–z, A–Z, 0–9) characters and dashes.

    • headerValue

      public final String headerValue()

      The content to include in the header. This value can contain up to 2048 characters. It can't contain newline ( \n) or carriage return (\r) characters.

      Returns:
      The content to include in the header. This value can contain up to 2048 characters. It can't contain newline (\n) or carriage return (\r) characters.

    • toBuilder

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

    • builder

      public static AddHeaderAction.Builder builder()

    • serializableBuilderClass

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