com.amazonaws.services.simpleemailv2.model

Class ListSuppressedDestinationsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.simpleemailv2.model.ListSuppressedDestinationsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ListSuppressedDestinationsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

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

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListSuppressedDestinationsRequest()

Method Summary

Modifier and Type	Method and Description
ListSuppressedDestinationsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Date	getEndDate() 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.
String	getNextToken() A token returned from a previous call to ListSuppressedDestinations to indicate the position in the list of suppressed email addresses.
Integer	getPageSize() The number of results to show in a single call to ListSuppressedDestinations.
List<String>	getReasons() The factors that caused the email address to be added to .
Date	getStartDate() 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.
int	hashCode()
void	setEndDate(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.
void	setNextToken(String nextToken) A token returned from a previous call to ListSuppressedDestinations to indicate the position in the list of suppressed email addresses.
void	setPageSize(Integer pageSize) The number of results to show in a single call to ListSuppressedDestinations.
void	setReasons(Collection<String> reasons) The factors that caused the email address to be added to .
void	setStartDate(Date 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.
String	toString() Returns a string representation of this object.
ListSuppressedDestinationsRequest	withEndDate(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.
ListSuppressedDestinationsRequest	withNextToken(String nextToken) A token returned from a previous call to ListSuppressedDestinations to indicate the position in the list of suppressed email addresses.
ListSuppressedDestinationsRequest	withPageSize(Integer pageSize) The number of results to show in a single call to ListSuppressedDestinations.
ListSuppressedDestinationsRequest	withReasons(Collection<String> reasons) The factors that caused the email address to be added to .
ListSuppressedDestinationsRequest	withReasons(String... reasons) The factors that caused the email address to be added to .
ListSuppressedDestinationsRequest	withReasons(SuppressionListReason... reasons) The factors that caused the email address to be added to .
ListSuppressedDestinationsRequest	withStartDate(Date 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.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListSuppressedDestinationsRequest

public ListSuppressedDestinationsRequest()

Method Detail

getReasons

public List<String> getReasons()

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

Returns:

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

See Also:

SuppressionListReason

setReasons

public void setReasons(Collection<String> reasons)

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

Parameters:

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

See Also:

SuppressionListReason

withReasons

public ListSuppressedDestinationsRequest withReasons(String... reasons)

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

NOTE: This method appends the values to the existing list (if any). Use setReasons(java.util.Collection) or withReasons(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SuppressionListReason

withReasons

public ListSuppressedDestinationsRequest withReasons(Collection<String> reasons)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SuppressionListReason

withReasons

public ListSuppressedDestinationsRequest withReasons(SuppressionListReason... reasons)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SuppressionListReason

setStartDate

public void setStartDate(Date 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. The date that you specify should be in Unix time format.

Parameters:

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. The date that you specify should be in Unix time format.

getStartDate

public Date getStartDate()

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. The date that you specify should be in Unix time format.

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. The date that you specify should be in Unix time format.

withStartDate

public ListSuppressedDestinationsRequest withStartDate(Date 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. The date that you specify should be in Unix time format.

Parameters:

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. The date that you specify should be in Unix time format.

Returns:

Returns a reference to this object so that method calls can be chained together.

setEndDate

public void setEndDate(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. The date that you specify should be in Unix time format.

Parameters:

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. The date that you specify should be in Unix time format.

getEndDate

public Date getEndDate()

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. The date that you specify should be in Unix time format.

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. The date that you specify should be in Unix time format.

withEndDate

public ListSuppressedDestinationsRequest withEndDate(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. The date that you specify should be in Unix time format.

Parameters:

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. The date that you specify should be in Unix time format.

Returns:

Returns a reference to this object so that method calls can be chained together.

setNextToken

public void setNextToken(String nextToken)

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

Parameters:

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

getNextToken

public String getNextToken()

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.

withNextToken

public ListSuppressedDestinationsRequest withNextToken(String nextToken)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setPageSize

public void setPageSize(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.

Parameters:

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.

getPageSize

public Integer getPageSize()

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.

withPageSize

public ListSuppressedDestinationsRequest withPageSize(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ListSuppressedDestinationsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()