com.amazonaws.services.pinpointsmsvoicev2.model

Class DescribePhoneNumbersRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.pinpointsmsvoicev2.model.DescribePhoneNumbersRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribePhoneNumbersRequest
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
DescribePhoneNumbersRequest()

Method Summary

Modifier and Type	Method and Description
DescribePhoneNumbersRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<PhoneNumberFilter>	getFilters() An array of PhoneNumberFilter objects to filter the results.
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>	getPhoneNumberIds() The unique identifier of phone numbers to find information about.
int	hashCode()
void	setFilters(Collection<PhoneNumberFilter> filters) An array of PhoneNumberFilter objects to filter the results.
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	setPhoneNumberIds(Collection<String> phoneNumberIds) The unique identifier of phone numbers to find information about.
String	toString() Returns a string representation of this object.
DescribePhoneNumbersRequest	withFilters(Collection<PhoneNumberFilter> filters) An array of PhoneNumberFilter objects to filter the results.
DescribePhoneNumbersRequest	withFilters(PhoneNumberFilter... filters) An array of PhoneNumberFilter objects to filter the results.
DescribePhoneNumbersRequest	withMaxResults(Integer maxResults) The maximum number of results to return per each request.
DescribePhoneNumbersRequest	withNextToken(String nextToken) The token to be used for the next set of paginated results.
DescribePhoneNumbersRequest	withPhoneNumberIds(Collection<String> phoneNumberIds) The unique identifier of phone numbers to find information about.
DescribePhoneNumbersRequest	withPhoneNumberIds(String... phoneNumberIds) The unique identifier of phone numbers to find information about.

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

DescribePhoneNumbersRequest

public DescribePhoneNumbersRequest()

Method Detail

getPhoneNumberIds

public List<String> getPhoneNumberIds()

The unique identifier of phone numbers to find information about. This is an array of strings that can be either the PhoneNumberId or PhoneNumberArn.

Returns:

The unique identifier of phone numbers to find information about. This is an array of strings that can be either the PhoneNumberId or PhoneNumberArn.

setPhoneNumberIds

public void setPhoneNumberIds(Collection<String> phoneNumberIds)

The unique identifier of phone numbers to find information about. This is an array of strings that can be either the PhoneNumberId or PhoneNumberArn.

Parameters:

phoneNumberIds - The unique identifier of phone numbers to find information about. This is an array of strings that can be either the PhoneNumberId or PhoneNumberArn.

withPhoneNumberIds

public DescribePhoneNumbersRequest withPhoneNumberIds(String... phoneNumberIds)

The unique identifier of phone numbers to find information about. This is an array of strings that can be either the PhoneNumberId or PhoneNumberArn.

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

Parameters:

phoneNumberIds - The unique identifier of phone numbers to find information about. This is an array of strings that can be either the PhoneNumberId or PhoneNumberArn.

Returns:

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

withPhoneNumberIds

public DescribePhoneNumbersRequest withPhoneNumberIds(Collection<String> phoneNumberIds)

The unique identifier of phone numbers to find information about. This is an array of strings that can be either the PhoneNumberId or PhoneNumberArn.

Parameters:

phoneNumberIds - The unique identifier of phone numbers to find information about. This is an array of strings that can be either the PhoneNumberId or PhoneNumberArn.

Returns:

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

getFilters

public List<PhoneNumberFilter> getFilters()

An array of PhoneNumberFilter objects to filter the results.

Returns:

An array of PhoneNumberFilter objects to filter the results.

setFilters

public void setFilters(Collection<PhoneNumberFilter> filters)

An array of PhoneNumberFilter objects to filter the results.

Parameters:

filters - An array of PhoneNumberFilter objects to filter the results.

withFilters

public DescribePhoneNumbersRequest withFilters(PhoneNumberFilter... filters)

An array of PhoneNumberFilter objects to filter the results.

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 PhoneNumberFilter objects to filter the results.

Returns:

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

withFilters

public DescribePhoneNumbersRequest withFilters(Collection<PhoneNumberFilter> filters)

An array of PhoneNumberFilter objects to filter the results.

Parameters:

filters - An array of PhoneNumberFilter objects to filter the results.

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