Class PutConfigurationSetDeliveryOptionsRequest

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

A request to associate a configuration set with a dedicated IP pool.

  • Method Details

    • configurationSetName

      public final String configurationSetName()

      The name of the configuration set that you want to associate with a dedicated IP pool.

      Returns:
      The name of the configuration set that you want to associate with a dedicated IP pool.

    • tlsPolicy

      public final TlsPolicy tlsPolicy()

      Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). If the value is Require, messages are only delivered if a TLS connection can be established. If the value is Optional, messages can be delivered in plain text if a TLS connection can't be established.

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

      Returns:
      Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). If the value is Require, messages are only delivered if a TLS connection can be established. If the value is Optional, messages can be delivered in plain text if a TLS connection can't be established.
      See Also:

    • tlsPolicyAsString

      public final String tlsPolicyAsString()

      Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). If the value is Require, messages are only delivered if a TLS connection can be established. If the value is Optional, messages can be delivered in plain text if a TLS connection can't be established.

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

      Returns:
      Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). If the value is Require, messages are only delivered if a TLS connection can be established. If the value is Optional, messages can be delivered in plain text if a TLS connection can't be established.
      See Also:

    • sendingPoolName

      public final String sendingPoolName()

      The name of the dedicated IP pool that you want to associate with the configuration set.

      Returns:
      The name of the dedicated IP pool that you want to associate with the configuration set.

    • toBuilder

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

    • builder

      public static PutConfigurationSetDeliveryOptionsRequest.Builder builder()

    • serializableBuilderClass

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