Package 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("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	Description
static interface	GetEmailIdentityResponse.Builder

Method Summary

Modifier and Type	Method	Description
static GetEmailIdentityResponse.Builder	builder()
DkimAttributes	dkimAttributes()	An object that contains information about the DKIM attributes for the identity.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Boolean	feedbackForwardingStatus()	The feedback forwarding configuration for the identity.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
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()
List<Tag>	tags()	An array of objects that define the tags (keys and values) that are associated with the email identity.
GetEmailIdentityResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
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

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

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

copy

Method Detail

identityType

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

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags 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.

tags

public final List<Tag> tags()

An array of objects that define the tags (keys and values) that are associated with the email identity.

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 hasTags() method.

Returns:

An array of objects that define the tags (keys and values) that are associated with the email identity.

toBuilder

public GetEmailIdentityResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetEmailIdentityResponse.Builder,GetEmailIdentityResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static GetEmailIdentityResponse.Builder builder()

serializableBuilderClass

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

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo