Class EmailChannelRequest

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

Specifies the status and settings of the email channel for an application.

See Also:

  • Method Details

    • configurationSet

      public final String configurationSet()

      The Amazon SES configuration set that you want to apply to messages that you send through the channel.

      Returns:
      The Amazon SES configuration set that you want to apply to messages that you send through the channel.

    • enabled

      public final Boolean enabled()

      Specifies whether to enable the email channel for the application.

      Returns:
      Specifies whether to enable the email channel for the application.

    • fromAddress

      public final String fromAddress()

      The verified email address that you want to send email from when you send email through the channel.

      Returns:

      The verified email address that you want to send email from when you send email through the channel.

    • identity

      public final String identity()

      The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that you want to use 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 you want to use when you send email through the channel.

    • roleArn

      public final String roleArn()

      The ARN of the AWS Identity and Access Management (IAM) role that you want Amazon Pinpoint to use when it submits email-related event data for the channel.

      Returns:

      The ARN of the AWS Identity and Access Management (IAM) role that you want Amazon Pinpoint to use when it submits 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.

    • toBuilder

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

    • builder

      public static EmailChannelRequest.Builder builder()

    • serializableBuilderClass

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