Class BulkEmailDestination

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

An array that contains one or more Destinations, as well as the tags and replacement data associated with each of those Destinations.

See Also:

  • Method Details

    • destination

      public final Destination destination()
      Returns the value of the Destination property for this object.
      Returns:
      The value of the Destination property for this object.

    • hasReplacementTags

      public final boolean hasReplacementTags()
      For responses, this returns true if the service returned a value for the ReplacementTags 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.

    • replacementTags

      public final List<MessageTag> replacementTags()

      A list of tags, in the form of name/value pairs, to apply to an email that you send using SendBulkTemplatedEmail. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

      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 hasReplacementTags() method.

      Returns:
      A list of tags, in the form of name/value pairs, to apply to an email that you send using SendBulkTemplatedEmail. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

    • replacementTemplateData

      public final String replacementTemplateData()

      A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.

      Returns:
      A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.

    • toBuilder

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

    • builder

      public static BulkEmailDestination.Builder builder()

    • serializableBuilderClass

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