Class GetMessageInsightsResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.sesv2.model.SesV2Response
software.amazon.awssdk.services.sesv2.model.GetMessageInsightsResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetMessageInsightsResponse.Builder,GetMessageInsightsResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetMessageInsightsResponse extends SesV2Response implements ToCopyableBuilder<GetMessageInsightsResponse.Builder,GetMessageInsightsResponse>

Information about a message.

  • Method Details

    • messageId

      public final String messageId()

      A unique identifier for the message.

      Returns:
      A unique identifier for the message.

    • fromEmailAddress

      public final String fromEmailAddress()

      The from address used to send the message.

      Returns:
      The from address used to send the message.

    • subject

      public final String subject()

      The subject line of the message.

      Returns:
      The subject line of the message.

    • hasEmailTags

      public final boolean hasEmailTags()
      For responses, this returns true if the service returned a value for the EmailTags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • emailTags

      public final List<MessageTag> emailTags()

      A list of tags, in the form of name/value pairs, that were applied to the email you sent, along with Amazon SES Auto-Tags.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEmailTags() method.

      Returns:
      A list of tags, in the form of name/value pairs, that were applied to the email you sent, along with Amazon SES Auto-Tags.

    • hasInsights

      public final boolean hasInsights()
      For responses, this returns true if the service returned a value for the Insights property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • insights

      public final List<EmailInsights> insights()

      A set of insights associated with the message.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasInsights() method.

      Returns:
      A set of insights associated with the message.

    • toBuilder

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

    • builder

      public static GetMessageInsightsResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.