Class IdentityInfo
- java.lang.Object
-
- software.amazon.awssdk.services.sesv2.model.IdentityInfo
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<IdentityInfo.Builder,IdentityInfo>
@Generated("software.amazon.awssdk:codegen") public final class IdentityInfo extends Object implements SdkPojo, Serializable, ToCopyableBuilder<IdentityInfo.Builder,IdentityInfo>
Information about an email identity.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
IdentityInfo.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static IdentityInfo.Builder
builder()
boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
String
identityName()
The address or domain of the identity.IdentityType
identityType()
The email identity type.String
identityTypeAsString()
The email identity type.Map<String,SdkField<?>>
sdkFieldNameToField()
List<SdkField<?>>
sdkFields()
Boolean
sendingEnabled()
Indicates whether or not you can send email from the identity.static Class<? extends IdentityInfo.Builder>
serializableBuilderClass()
IdentityInfo.Builder
toBuilder()
String
toString()
Returns a string representation of this object.VerificationStatus
verificationStatus()
The verification status of the identity.String
verificationStatusAsString()
The verification status of the identity.-
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. Note: the
MANAGED_DOMAIN
type is not supported for email identity types.If the service returns an enum value that is not available in the current SDK version,
identityType
will returnIdentityType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromidentityTypeAsString()
.- Returns:
- The email identity type. Note: the
MANAGED_DOMAIN
type is not supported for email identity types. - See Also:
IdentityType
-
identityTypeAsString
public final String identityTypeAsString()
The email identity type. Note: the
MANAGED_DOMAIN
type is not supported for email identity types.If the service returns an enum value that is not available in the current SDK version,
identityType
will returnIdentityType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromidentityTypeAsString()
.- Returns:
- The email identity type. Note: the
MANAGED_DOMAIN
type is not supported for email identity types. - See Also:
IdentityType
-
identityName
public final String identityName()
The address or domain of the identity.
- Returns:
- The address or domain of the identity.
-
sendingEnabled
public final Boolean sendingEnabled()
Indicates whether or not you can send email from the identity.
An identity is an email address or domain that you send email from. Before you can send email from an identity, you have to demostrate that you own the identity, and that you authorize Amazon SES to send email from that identity.
- Returns:
- Indicates whether or not you can send email from the identity.
An identity is an email address or domain that you send email from. Before you can send email from an identity, you have to demostrate that you own the identity, and that you authorize Amazon SES to send email from that identity.
-
verificationStatus
public final VerificationStatus verificationStatus()
The verification status of the identity. The status can be one of the following:
-
PENDING
– The verification process was initiated, but Amazon SES hasn't yet been able to verify the identity. -
SUCCESS
– The verification process completed successfully. -
FAILED
– The verification process failed. -
TEMPORARY_FAILURE
– A temporary issue is preventing Amazon SES from determining the verification status of the identity. -
NOT_STARTED
– The verification process hasn't been initiated for the identity.
If the service returns an enum value that is not available in the current SDK version,
verificationStatus
will returnVerificationStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromverificationStatusAsString()
.- Returns:
- The verification status of the identity. The status can be one of the following:
-
PENDING
– The verification process was initiated, but Amazon SES hasn't yet been able to verify the identity. -
SUCCESS
– The verification process completed successfully. -
FAILED
– The verification process failed. -
TEMPORARY_FAILURE
– A temporary issue is preventing Amazon SES from determining the verification status of the identity. -
NOT_STARTED
– The verification process hasn't been initiated for the identity.
-
- See Also:
VerificationStatus
-
-
verificationStatusAsString
public final String verificationStatusAsString()
The verification status of the identity. The status can be one of the following:
-
PENDING
– The verification process was initiated, but Amazon SES hasn't yet been able to verify the identity. -
SUCCESS
– The verification process completed successfully. -
FAILED
– The verification process failed. -
TEMPORARY_FAILURE
– A temporary issue is preventing Amazon SES from determining the verification status of the identity. -
NOT_STARTED
– The verification process hasn't been initiated for the identity.
If the service returns an enum value that is not available in the current SDK version,
verificationStatus
will returnVerificationStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromverificationStatusAsString()
.- Returns:
- The verification status of the identity. The status can be one of the following:
-
PENDING
– The verification process was initiated, but Amazon SES hasn't yet been able to verify the identity. -
SUCCESS
– The verification process completed successfully. -
FAILED
– The verification process failed. -
TEMPORARY_FAILURE
– A temporary issue is preventing Amazon SES from determining the verification status of the identity. -
NOT_STARTED
– The verification process hasn't been initiated for the identity.
-
- See Also:
VerificationStatus
-
-
toBuilder
public IdentityInfo.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<IdentityInfo.Builder,IdentityInfo>
-
builder
public static IdentityInfo.Builder builder()
-
serializableBuilderClass
public static Class<? extends IdentityInfo.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
-
-