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.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
ListSuppressedDestinationsRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method 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 toListSuppressedDestinations
to indicate the position in the list of suppressed email addresses.Integer
pageSize()
The number of results to show in a single call toListSuppressedDestinations
.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 .Map<String,SdkField<?>>
sdkFieldNameToField()
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.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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 theisEmpty()
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 aNextToken
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 aNextToken
element, which you can use to obtain additional results.
-
toBuilder
public ListSuppressedDestinationsRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<ListSuppressedDestinationsRequest.Builder,ListSuppressedDestinationsRequest>
- Specified by:
toBuilder
in classSesV2Request
-
builder
public static ListSuppressedDestinationsRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends ListSuppressedDestinationsRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
-
-