Class PutEmailIdentityDkimSigningAttributesRequest

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.PutEmailIdentityDkimSigningAttributesRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<PutEmailIdentityDkimSigningAttributesRequest.Builder,PutEmailIdentityDkimSigningAttributesRequest>
@Generated("software.amazon.awssdk:codegen") public final class PutEmailIdentityDkimSigningAttributesRequest extends SesV2Request implements ToCopyableBuilder<PutEmailIdentityDkimSigningAttributesRequest.Builder,PutEmailIdentityDkimSigningAttributesRequest>

A request to change the DKIM attributes for an email identity.

  • Method Details

    • emailIdentity

      public final String emailIdentity()

      The email identity.

      Returns:
      The email identity.

    • signingAttributesOrigin

      public final DkimSigningAttributesOrigin signingAttributesOrigin()

      The method to use to configure DKIM for the identity. There are the following possible values:

      • AWS_SES – Configure DKIM for the identity by using Easy DKIM.

      • EXTERNAL – Configure DKIM for the identity by using Bring Your Own DKIM (BYODKIM).

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

      Returns:
      The method to use to configure DKIM for the identity. There are the following possible values:

      • AWS_SES – Configure DKIM for the identity by using Easy DKIM.

      • EXTERNAL – Configure DKIM for the identity by using Bring Your Own DKIM (BYODKIM).

      See Also:

    • signingAttributesOriginAsString

      public final String signingAttributesOriginAsString()

      The method to use to configure DKIM for the identity. There are the following possible values:

      • AWS_SES – Configure DKIM for the identity by using Easy DKIM.

      • EXTERNAL – Configure DKIM for the identity by using Bring Your Own DKIM (BYODKIM).

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

      Returns:
      The method to use to configure DKIM for the identity. There are the following possible values:

      • AWS_SES – Configure DKIM for the identity by using Easy DKIM.

      • EXTERNAL – Configure DKIM for the identity by using Bring Your Own DKIM (BYODKIM).

      See Also:

    • signingAttributes

      public final DkimSigningAttributes signingAttributes()

      An object that contains information about the private key and selector that you want to use to configure DKIM for the identity for Bring Your Own DKIM (BYODKIM) for the identity, or, configures the key length to be used for Easy DKIM.

      Returns:
      An object that contains information about the private key and selector that you want to use to configure DKIM for the identity for Bring Your Own DKIM (BYODKIM) for the identity, or, configures the key length to be used for Easy DKIM.

    • toBuilder

      public PutEmailIdentityDkimSigningAttributesRequest.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<PutEmailIdentityDkimSigningAttributesRequest.Builder,PutEmailIdentityDkimSigningAttributesRequest>
      Specified by:
      toBuilder in class SesV2Request
      Returns:
      a builder for type T

    • builder

      public static PutEmailIdentityDkimSigningAttributesRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PutEmailIdentityDkimSigningAttributesRequest.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)
      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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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 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.