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

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EmailChannelResponse.Builder

Method Summary

Modifier and Type	Method	Description
String	applicationId()	The unique identifier for the application that the email channel applies to.
static EmailChannelResponse.Builder	builder()
String	configurationSet()	The Amazon SES configuration set that's applied to messages that are sent through the channel.
String	creationDate()	The date and time, in ISO 8601 format, when the email channel was enabled.
Boolean	enabled()	Specifies whether the email channel is enabled for the application.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	fromAddress()	The verified email address that email is sent from when you send email through the channel.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
Boolean	hasCredential()	(Not used) This property is retained only for backward compatibility.
int	hashCode()
String	id()	(Deprecated) An identifier for the email channel.
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.
Boolean	isArchived()	Specifies whether the email channel is archived.
String	lastModifiedBy()	The user who last modified the email channel.
String	lastModifiedDate()	The date and time, in ISO 8601 format, when the email channel was last modified.
Integer	messagesPerSecond()	The maximum number of emails that can be sent through the channel each second.
String	orchestrationSendingRoleArn()	The ARN of an IAM role for Amazon Pinpoint to use to send email from your campaigns or journeys through Amazon SES.
String	platform()	The type of messaging or notification platform for the channel.
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.
List<SdkField<?>>	sdkFields()
static Class<? extends EmailChannelResponse.Builder>	serializableBuilderClass()
EmailChannelResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Integer	version()	The current version of the email channel.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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()

Specified by:

toBuilder in interface ToCopyableBuilder<EmailChannelResponse.Builder,EmailChannelResponse>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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