Class Metadata

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

The metadata about the email.

See Also:

  • Method Details

    • configurationSet

      public final String configurationSet()

      The name of the configuration set used when sent through a configuration set with archiving enabled.

      Returns:
      The name of the configuration set used when sent through a configuration set with archiving enabled.

    • ingressPointId

      public final String ingressPointId()

      The ID of the ingress endpoint through which the email was received.

      Returns:
      The ID of the ingress endpoint through which the email was received.

    • ruleSetId

      public final String ruleSetId()

      The ID of the rule set that processed the email.

      Returns:
      The ID of the rule set that processed the email.

    • senderHostname

      public final String senderHostname()

      The name of the host from which the email was received.

      Returns:
      The name of the host from which the email was received.

    • senderIpAddress

      public final String senderIpAddress()

      The IP address of the host from which the email was received.

      Returns:
      The IP address of the host from which the email was received.

    • sendingMethod

      public final String sendingMethod()

      The name of the API call used when sent through a configuration set with archiving enabled.

      Returns:
      The name of the API call used when sent through a configuration set with archiving enabled.

    • sendingPool

      public final String sendingPool()

      The name of the dedicated IP pool used when sent through a configuration set with archiving enabled.

      Returns:
      The name of the dedicated IP pool used when sent through a configuration set with archiving enabled.

    • sourceArn

      public final String sourceArn()

      Specifies the archived email source, identified by either a Rule Set's ARN with an Archive action, or a Configuration Set's Archive ARN.

      Returns:
      Specifies the archived email source, identified by either a Rule Set's ARN with an Archive action, or a Configuration Set's Archive ARN.

    • sourceIdentity

      public final String sourceIdentity()

      The identity name used to authorize the sending action when sent through a configuration set with archiving enabled.

      Returns:
      The identity name used to authorize the sending action when sent through a configuration set with archiving enabled.

    • timestamp

      public final Instant timestamp()

      The timestamp of when the email was received.

      Returns:
      The timestamp of when the email was received.

    • tlsCipherSuite

      public final String tlsCipherSuite()

      The TLS cipher suite used to communicate with the host from which the email was received.

      Returns:
      The TLS cipher suite used to communicate with the host from which the email was received.

    • tlsProtocol

      public final String tlsProtocol()

      The TLS protocol used to communicate with the host from which the email was received.

      Returns:
      The TLS protocol used to communicate with the host from which the email was received.

    • trafficPolicyId

      public final String trafficPolicyId()

      The ID of the traffic policy that was in effect when the email was received.

      Returns:
      The ID of the traffic policy that was in effect when the email was received.

    • toBuilder

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

    • builder

      public static Metadata.Builder builder()

    • serializableBuilderClass

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