@Generated(value="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.
Modifier and Type | Class and Description |
---|---|
static interface |
ListSuppressedDestinationsRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static ListSuppressedDestinationsRequest.Builder |
builder() |
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.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasReasons()
For responses, this returns true if the service returned a value for the Reasons property.
|
String |
nextToken()
A token returned from a previous call to
ListSuppressedDestinations to indicate the position in the
list of suppressed email addresses. |
Integer |
pageSize()
The number of results to show in a single call to
ListSuppressedDestinations . |
List<SuppressionListReason> |
reasons()
The factors that caused the email address to be added to .
|
List<String> |
reasonsAsStrings()
The factors that caused the email address to be added to .
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends ListSuppressedDestinationsRequest.Builder> |
serializableBuilderClass() |
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.
|
ListSuppressedDestinationsRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfiguration
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
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.
public final boolean hasReasons()
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.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.
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.
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.
public final String nextToken()
A token returned from a previous call to ListSuppressedDestinations
to indicate the position in the
list of suppressed email addresses.
ListSuppressedDestinations
to indicate the position
in the list of suppressed email addresses.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.
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.public ListSuppressedDestinationsRequest.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<ListSuppressedDestinationsRequest.Builder,ListSuppressedDestinationsRequest>
toBuilder
in class SesV2Request
public static ListSuppressedDestinationsRequest.Builder builder()
public static Class<? extends ListSuppressedDestinationsRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField
in class SdkRequest
Copyright © 2023. All rights reserved.