com.amazonaws.services.pinpointsmsvoicev2.model

Class DescribeOptedOutNumbersRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.pinpointsmsvoicev2.model.DescribeOptedOutNumbersRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeOptedOutNumbersRequest()

Method Summary

Modifier and Type	Method and Description
DescribeOptedOutNumbersRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<OptedOutFilter>	getFilters() An array of OptedOutFilter objects to filter the results on.
Integer	getMaxResults() The maximum number of results to return per each request.
String	getNextToken() The token to be used for the next set of paginated results.
List<String>	getOptedOutNumbers() An array of phone numbers to search for in the OptOutList.
String	getOptOutListName() The OptOutListName or OptOutListArn of the OptOutList.
int	hashCode()
void	setFilters(Collection<OptedOutFilter> filters) An array of OptedOutFilter objects to filter the results on.
void	setMaxResults(Integer maxResults) The maximum number of results to return per each request.
void	setNextToken(String nextToken) The token to be used for the next set of paginated results.
void	setOptedOutNumbers(Collection<String> optedOutNumbers) An array of phone numbers to search for in the OptOutList.
void	setOptOutListName(String optOutListName) The OptOutListName or OptOutListArn of the OptOutList.
String	toString() Returns a string representation of this object.
DescribeOptedOutNumbersRequest	withFilters(Collection<OptedOutFilter> filters) An array of OptedOutFilter objects to filter the results on.
DescribeOptedOutNumbersRequest	withFilters(OptedOutFilter... filters) An array of OptedOutFilter objects to filter the results on.
DescribeOptedOutNumbersRequest	withMaxResults(Integer maxResults) The maximum number of results to return per each request.
DescribeOptedOutNumbersRequest	withNextToken(String nextToken) The token to be used for the next set of paginated results.
DescribeOptedOutNumbersRequest	withOptedOutNumbers(Collection<String> optedOutNumbers) An array of phone numbers to search for in the OptOutList.
DescribeOptedOutNumbersRequest	withOptedOutNumbers(String... optedOutNumbers) An array of phone numbers to search for in the OptOutList.
DescribeOptedOutNumbersRequest	withOptOutListName(String optOutListName) The OptOutListName or OptOutListArn of the OptOutList.

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

DescribeOptedOutNumbersRequest

public DescribeOptedOutNumbersRequest()

Method Detail

setOptOutListName

public void setOptOutListName(String optOutListName)

The OptOutListName or OptOutListArn of the OptOutList. You can use DescribeOptOutLists to find the values for OptOutListName and OptOutListArn.

Parameters:

optOutListName - The OptOutListName or OptOutListArn of the OptOutList. You can use DescribeOptOutLists to find the values for OptOutListName and OptOutListArn.

getOptOutListName

public String getOptOutListName()

The OptOutListName or OptOutListArn of the OptOutList. You can use DescribeOptOutLists to find the values for OptOutListName and OptOutListArn.

Returns:

The OptOutListName or OptOutListArn of the OptOutList. You can use DescribeOptOutLists to find the values for OptOutListName and OptOutListArn.

withOptOutListName

public DescribeOptedOutNumbersRequest withOptOutListName(String optOutListName)

The OptOutListName or OptOutListArn of the OptOutList. You can use DescribeOptOutLists to find the values for OptOutListName and OptOutListArn.

Parameters:

optOutListName - The OptOutListName or OptOutListArn of the OptOutList. You can use DescribeOptOutLists to find the values for OptOutListName and OptOutListArn.

Returns:

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

getOptedOutNumbers

public List<String> getOptedOutNumbers()

An array of phone numbers to search for in the OptOutList.

Returns:

An array of phone numbers to search for in the OptOutList.

setOptedOutNumbers

public void setOptedOutNumbers(Collection<String> optedOutNumbers)

An array of phone numbers to search for in the OptOutList.

Parameters:

optedOutNumbers - An array of phone numbers to search for in the OptOutList.

withOptedOutNumbers

public DescribeOptedOutNumbersRequest withOptedOutNumbers(String... optedOutNumbers)

An array of phone numbers to search for in the OptOutList.

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

Parameters:

optedOutNumbers - An array of phone numbers to search for in the OptOutList.

Returns:

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

withOptedOutNumbers

public DescribeOptedOutNumbersRequest withOptedOutNumbers(Collection<String> optedOutNumbers)

An array of phone numbers to search for in the OptOutList.

Parameters:

optedOutNumbers - An array of phone numbers to search for in the OptOutList.

Returns:

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

getFilters

public List<OptedOutFilter> getFilters()

An array of OptedOutFilter objects to filter the results on.

Returns:

An array of OptedOutFilter objects to filter the results on.

setFilters

public void setFilters(Collection<OptedOutFilter> filters)

An array of OptedOutFilter objects to filter the results on.

Parameters:

filters - An array of OptedOutFilter objects to filter the results on.

withFilters

public DescribeOptedOutNumbersRequest withFilters(OptedOutFilter... filters)

An array of OptedOutFilter objects to filter the results on.

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

Parameters:

filters - An array of OptedOutFilter objects to filter the results on.

Returns:

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

withFilters

public DescribeOptedOutNumbersRequest withFilters(Collection<OptedOutFilter> filters)

An array of OptedOutFilter objects to filter the results on.

Parameters:

filters - An array of OptedOutFilter objects to filter the results on.

Returns:

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

setNextToken

public void setNextToken(String nextToken)

The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.

Parameters:

nextToken - The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.

getNextToken

public String getNextToken()

The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.

Returns:

The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.

withNextToken

public DescribeOptedOutNumbersRequest withNextToken(String nextToken)

The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.

Parameters:

nextToken - The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.

Returns:

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

setMaxResults

public void setMaxResults(Integer maxResults)

The maximum number of results to return per each request.

Parameters:

maxResults - The maximum number of results to return per each request.

getMaxResults

public Integer getMaxResults()

The maximum number of results to return per each request.

Returns:

The maximum number of results to return per each request.

withMaxResults

public DescribeOptedOutNumbersRequest withMaxResults(Integer maxResults)

The maximum number of results to return per each request.

Parameters:

maxResults - The maximum number of results to return per each request.

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 DescribeOptedOutNumbersRequest 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()