software.amazon.awssdk.services.pinpointemail.model

Class GetEmailIdentityResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.pinpointemail.model.PinpointEmailResponse

software.amazon.awssdk.services.pinpointemail.model.GetEmailIdentityResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetEmailIdentityResponse.Builder,GetEmailIdentityResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetEmailIdentityResponse
extends PinpointEmailResponse
implements ToCopyableBuilder<GetEmailIdentityResponse.Builder,GetEmailIdentityResponse>

Details about an email identity.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetEmailIdentityResponse.Builder

Method Summary

Modifier and Type	Method and Description
static GetEmailIdentityResponse.Builder	builder()
DkimAttributes	dkimAttributes() An object that contains information about the DKIM attributes for the identity.
boolean	equals(Object obj)
Boolean	feedbackForwardingStatus() The feedback forwarding configuration for the identity.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkResponse.
int	hashCode()
IdentityType	identityType() The email identity type.
String	identityTypeAsString() The email identity type.
MailFromAttributes	mailFromAttributes() An object that contains information about the Mail-From attributes for the email identity.
List<SdkField<?>>	sdkFields()
static Class<? extends GetEmailIdentityResponse.Builder>	serializableBuilderClass()
GetEmailIdentityResponse.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
Boolean	verifiedForSendingStatus() Specifies whether or not the identity is verified.

Methods inherited from class software.amazon.awssdk.services.pinpointemail.model.PinpointEmailResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

identityType

public IdentityType identityType()

The email identity type.

If the service returns an enum value that is not available in the current SDK version, identityType will return IdentityType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from identityTypeAsString().

Returns:

The email identity type.

See Also:

IdentityType

identityTypeAsString

public String identityTypeAsString()

The email identity type.

If the service returns an enum value that is not available in the current SDK version, identityType will return IdentityType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from identityTypeAsString().

Returns:

The email identity type.

See Also:

IdentityType

feedbackForwardingStatus

public Boolean feedbackForwardingStatus()

The feedback forwarding configuration for the identity.

If the value is true, Amazon Pinpoint sends you email notifications when bounce or complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the original email.

When you set this value to false, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic or another event destination. You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications, Amazon Pinpoint sends an email notification when these events occur (even if this setting is disabled).

Returns:

The feedback forwarding configuration for the identity.

If the value is true, Amazon Pinpoint sends you email notifications when bounce or complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the original email.

When you set this value to false, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic or another event destination. You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications, Amazon Pinpoint sends an email notification when these events occur (even if this setting is disabled).

verifiedForSendingStatus

public Boolean verifiedForSendingStatus()

Specifies whether or not the identity is verified. In Amazon Pinpoint, you can only send email from verified email addresses or domains. For more information about verifying identities, see the Amazon Pinpoint User Guide.

Returns:

Specifies whether or not the identity is verified. In Amazon Pinpoint, you can only send email from verified email addresses or domains. For more information about verifying identities, see the Amazon Pinpoint User Guide.

dkimAttributes

public DkimAttributes dkimAttributes()

An object that contains information about the DKIM attributes for the identity. This object includes the tokens that you use to create the CNAME records that are required to complete the DKIM verification process.

Returns:

An object that contains information about the DKIM attributes for the identity. This object includes the tokens that you use to create the CNAME records that are required to complete the DKIM verification process.

mailFromAttributes

public MailFromAttributes mailFromAttributes()

An object that contains information about the Mail-From attributes for the email identity.

Returns:

An object that contains information about the Mail-From attributes for the email identity.

toBuilder

public GetEmailIdentityResponse.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<GetEmailIdentityResponse.Builder,GetEmailIdentityResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static GetEmailIdentityResponse.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <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 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.