Class EmailChannelResponse

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

Provides information about the status and settings of the email channel for an application.

See Also:

  • Method Details

    • applicationId

      public final String applicationId()

      The unique identifier for the application that the email channel applies to.

      Returns:
      The unique identifier for the application that the email channel applies to.

    • configurationSet

      public final String configurationSet()

      The Amazon SES configuration set that's applied to messages that are sent through the channel.

      Returns:
      The Amazon SES configuration set that's applied to messages that are sent through the channel.

    • creationDate

      public final String creationDate()

      The date and time, in ISO 8601 format, when the email channel was enabled.

      Returns:
      The date and time, in ISO 8601 format, when the email channel was enabled.

    • enabled

      public final Boolean enabled()

      Specifies whether the email channel is enabled for the application.

      Returns:
      Specifies whether the email channel is enabled for the application.

    • fromAddress

      public final String fromAddress()

      The verified email address that email is sent from when you send email through the channel.

      Returns:
      The verified email address that email is sent from when you send email through the channel.

    • hasCredential

      public final Boolean hasCredential()

      (Not used) This property is retained only for backward compatibility.

      Returns:
      (Not used) This property is retained only for backward compatibility.

    • id

      public final String id()

      (Deprecated) An identifier for the email channel. This property is retained only for backward compatibility.

      Returns:
      (Deprecated) An identifier for the email channel. This property is retained only for backward compatibility.

    • identity

      public final String identity()

      The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that's used when you send email through the channel.

      Returns:

      The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that's used when you send email through the channel.

    • isArchived

      public final Boolean isArchived()

      Specifies whether the email channel is archived.

      Returns:
      Specifies whether the email channel is archived.

    • lastModifiedBy

      public final String lastModifiedBy()

      The user who last modified the email channel.

      Returns:
      The user who last modified the email channel.

    • lastModifiedDate

      public final String lastModifiedDate()

      The date and time, in ISO 8601 format, when the email channel was last modified.

      Returns:
      The date and time, in ISO 8601 format, when the email channel was last modified.

    • messagesPerSecond

      public final Integer messagesPerSecond()

      The maximum number of emails that can be sent through the channel each second.

      Returns:
      The maximum number of emails that can be sent through the channel each second.

    • platform

      public final String platform()

      The type of messaging or notification platform for the channel. For the email channel, this value is EMAIL.

      Returns:
      The type of messaging or notification platform for the channel. For the email channel, this value is EMAIL.

    • roleArn

      public final String roleArn()

      The ARN of the AWS Identity and Access Management (IAM) role that Amazon Pinpoint uses to submit email-related event data for the channel.

      Returns:

      The ARN of the AWS Identity and Access Management (IAM) role that Amazon Pinpoint uses to submit email-related event data for the channel.

    • orchestrationSendingRoleArn

      public final String orchestrationSendingRoleArn()

      The ARN of an IAM role for Amazon Pinpoint to use to send email from your campaigns or journeys through Amazon SES.

      Returns:
      The ARN of an IAM role for Amazon Pinpoint to use to send email from your campaigns or journeys through Amazon SES.

    • version

      public final Integer version()

      The current version of the email channel.

      Returns:
      The current version of the email channel.

    • toBuilder

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

    • builder

      public static EmailChannelResponse.Builder builder()

    • serializableBuilderClass

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