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

Class ListSuppressedDestinationsRequest

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

A request to obtain a list of email destinations that are on the suppression list for your account.

  • Method Details

    • reasons

      public final List<SuppressionListReason> reasons()

      The factors that caused the email address to be added to .

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

      Returns:
      The factors that caused the email address to be added to .

    • hasReasons

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

    • reasonsAsStrings

      public final List<String> reasonsAsStrings()

      The factors that caused the email address to be added to .

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

      Returns:
      The factors that caused the email address to be added to .

    • startDate

      public final Instant startDate()

      Used to filter the list of suppressed email destinations so that it only includes addresses that were added to the list after a specific date.

      Returns:
      Used to filter the list of suppressed email destinations so that it only includes addresses that were added to the list after a specific date.

    • endDate

      public final Instant endDate()

      Used to filter the list of suppressed email destinations so that it only includes addresses that were added to the list before a specific date.

      Returns:
      Used to filter the list of suppressed email destinations so that it only includes addresses that were added to the list before a specific date.

    • nextToken

      public final String nextToken()

      A token returned from a previous call to ListSuppressedDestinations to indicate the position in the list of suppressed email addresses.

      Returns:
      A token returned from a previous call to ListSuppressedDestinations to indicate the position in the list of suppressed email addresses.

    • pageSize

      public final Integer pageSize()

      The number of results to show in a single call to ListSuppressedDestinations. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

      Returns:
      The number of results to show in a single call to ListSuppressedDestinations. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

    • toBuilder

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

    • builder

      public static ListSuppressedDestinationsRequest.Builder builder()

    • serializableBuilderClass

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