Package software.amazon.awssdk.services.pinpoint.model

Class MessageHeader

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

Contains the name and value pair of an email header to add to your email. You can have up to 15 MessageHeaders. A header can contain information such as the sender, receiver, route, or timestamp.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the message header. The header name can contain up to 126 characters.

      Returns:
      The name of the message header. The header name can contain up to 126 characters.

    • value

      public final String value()

      The value of the message header. The header value can contain up to 870 characters, including the length of any rendered attributes. For example if you add the {CreationDate} attribute, it renders as YYYY-MM-DDTHH:MM:SS.SSSZ and is 24 characters in length.

      Returns:
      The value of the message header. The header value can contain up to 870 characters, including the length of any rendered attributes. For example if you add the {CreationDate} attribute, it renders as YYYY-MM-DDTHH:MM:SS.SSSZ and is 24 characters in length.

    • toBuilder

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

    • builder

      public static MessageHeader.Builder builder()

    • serializableBuilderClass

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