Class SigningScheme

java.lang.Object
software.amazon.awssdk.services.sesv2.model.SigningScheme
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<SigningScheme.Builder,SigningScheme>
@Generated("software.amazon.awssdk:codegen") public final class SigningScheme extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SigningScheme.Builder,SigningScheme>

Specifies the signing scheme to apply to messages sent with a configuration set. This is a union type, so you specify exactly one of its members.

See Also:

  • Method Details

    • defaultScheme

      public final DefaultSigningScheme defaultScheme()

      Use the default signing behavior. When you select this option, Amazon SES API v2 doesn't add an S/MIME signature to messages sent with the configuration set.

      Returns:
      Use the default signing behavior. When you select this option, Amazon SES API v2 doesn't add an S/MIME signature to messages sent with the configuration set.

    • smimeScheme

      public final SmimeSigningScheme smimeScheme()

      Sign messages sent with the configuration set using S/MIME. For signing to apply, the email identity used to send a message must have an active S/MIME certificate association.

      Returns:
      Sign messages sent with the configuration set using S/MIME. For signing to apply, the email identity used to send a message must have an active S/MIME certificate association.

    • toBuilder

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

    • builder

      public static SigningScheme.Builder builder()

    • serializableBuilderClass

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

    • fromDefaultScheme

      public static SigningScheme fromDefaultScheme(DefaultSigningScheme defaultScheme)
      Create an instance of this class with defaultScheme() initialized to the given value.

      Use the default signing behavior. When you select this option, Amazon SES API v2 doesn't add an S/MIME signature to messages sent with the configuration set.

      Parameters:
      defaultScheme - Use the default signing behavior. When you select this option, Amazon SES API v2 doesn't add an S/MIME signature to messages sent with the configuration set.

    • fromDefaultScheme

      public static SigningScheme fromDefaultScheme(Consumer<DefaultSigningScheme.Builder> defaultScheme)
      Create an instance of this class with defaultScheme() initialized to the given value.

      Use the default signing behavior. When you select this option, Amazon SES API v2 doesn't add an S/MIME signature to messages sent with the configuration set.

      Parameters:
      defaultScheme - Use the default signing behavior. When you select this option, Amazon SES API v2 doesn't add an S/MIME signature to messages sent with the configuration set.

    • fromSmimeScheme

      public static SigningScheme fromSmimeScheme(SmimeSigningScheme smimeScheme)
      Create an instance of this class with smimeScheme() initialized to the given value.

      Sign messages sent with the configuration set using S/MIME. For signing to apply, the email identity used to send a message must have an active S/MIME certificate association.

      Parameters:
      smimeScheme - Sign messages sent with the configuration set using S/MIME. For signing to apply, the email identity used to send a message must have an active S/MIME certificate association.

    • fromSmimeScheme

      public static SigningScheme fromSmimeScheme(Consumer<SmimeSigningScheme.Builder> smimeScheme)
      Create an instance of this class with smimeScheme() initialized to the given value.

      Sign messages sent with the configuration set using S/MIME. For signing to apply, the email identity used to send a message must have an active S/MIME certificate association.

      Parameters:
      smimeScheme - Sign messages sent with the configuration set using S/MIME. For signing to apply, the email identity used to send a message must have an active S/MIME certificate association.

    • type

      public SigningScheme.Type type()
      Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be SigningScheme.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be SigningScheme.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

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