Class IdentityInfo

java.lang.Object
software.amazon.awssdk.services.pinpointemail.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:

  • Method Details

    • identityType

      public final IdentityType identityType()

      The email identity type. The identity type can be one of the following:

      • EMAIL_ADDRESS – The identity is an email address.

      • DOMAIN – The identity is a domain.

      • MANAGED_DOMAIN – The identity is a domain that is managed by AWS.

      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. The identity type can be one of the following:

      • EMAIL_ADDRESS – The identity is an email address.

      • DOMAIN – The identity is a domain.

      • MANAGED_DOMAIN – The identity is a domain that is managed by AWS.

      See Also:

    • identityTypeAsString

      public final String identityTypeAsString()

      The email identity type. The identity type can be one of the following:

      • EMAIL_ADDRESS – The identity is an email address.

      • DOMAIN – The identity is a domain.

      • MANAGED_DOMAIN – The identity is a domain that is managed by AWS.

      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. The identity type can be one of the following:

      • EMAIL_ADDRESS – The identity is an email address.

      • DOMAIN – The identity is a domain.

      • MANAGED_DOMAIN – The identity is a domain that is managed by AWS.

      See Also:

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

      In Amazon Pinpoint, 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 Pinpoint to send email from that identity.

      Returns:
      Indicates whether or not you can send email from the identity.

      In Amazon Pinpoint, 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 Pinpoint to send email from that identity.

    • toBuilder

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

    • builder

      public static IdentityInfo.Builder builder()

    • serializableBuilderClass

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