Package software.amazon.awssdk.services.sesv2.model

Class CreateEmailIdentityRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.sesv2.model.SesV2Request
software.amazon.awssdk.services.sesv2.model.CreateEmailIdentityRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateEmailIdentityRequest.Builder,CreateEmailIdentityRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateEmailIdentityRequest extends SesV2Request implements ToCopyableBuilder<CreateEmailIdentityRequest.Builder,CreateEmailIdentityRequest>

A request to begin the verification process for an email identity (an email address or domain).

  • Method Details

    • emailIdentity

      public final String emailIdentity()

      The email address or domain to verify.

      Returns:
      The email address or domain to verify.

    • 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) to associate 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) to associate with the email identity.

    • dkimSigningAttributes

      public final DkimSigningAttributes dkimSigningAttributes()

      If your request includes this object, Amazon SES configures the identity to use Bring Your Own DKIM (BYODKIM) for DKIM authentication purposes, or, configures the key length to be used for Easy DKIM.

      You can only specify this object if the email identity is a domain, as opposed to an address.

      Returns:
      If your request includes this object, Amazon SES configures the identity to use Bring Your Own DKIM (BYODKIM) for DKIM authentication purposes, or, configures the key length to be used for Easy DKIM.

      You can only specify this object if the email identity is a domain, as opposed to an address.

    • configurationSetName

      public final String configurationSetName()

      The configuration set to use by default when sending from this identity. Note that any configuration set defined in the email sending request takes precedence.

      Returns:
      The configuration set to use by default when sending from this identity. Note that any configuration set defined in the email sending request takes precedence.

    • toBuilder

      public CreateEmailIdentityRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateEmailIdentityRequest.Builder,CreateEmailIdentityRequest>
      Specified by:
      toBuilder in class SesV2Request

    • builder

      public static CreateEmailIdentityRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

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

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo