Class ListSuppressedDestinationsRequest
- All Implemented Interfaces:
SdkPojo
,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
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
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.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Reasons property.final String
A token returned from a previous call toListSuppressedDestinations
to indicate the position in the list of suppressed email addresses.final Integer
pageSize()
The number of results to show in a single call toListSuppressedDestinations
.final List
<SuppressionListReason> reasons()
The factors that caused the email address to be added to .The factors that caused the email address to be added to .static Class
<? extends ListSuppressedDestinationsRequest.Builder> final Instant
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.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
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
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
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
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
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 interfaceToCopyableBuilder<ListSuppressedDestinationsRequest.Builder,
ListSuppressedDestinationsRequest> - Specified by:
toBuilder
in classSesV2Request
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-