ListPhoneNumbersRequest (aws-android-sdk-connect 2.81.1 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.connect.model.ListPhoneNumbersRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class ListPhoneNumbersRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable
```
Provides information about the phone numbers for the specified Amazon Connect instance.

For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide.

The phone number Arn value that is returned from each of the items in the PhoneNumberSummaryList cannot be used to tag phone number resources. It will fail with a ResourceNotFoundException. Instead, use the ListPhoneNumbersV2 API. It returns the new phone number ARN that can be used to tag phone number resources.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

ListPhoneNumbersRequest()

Constructors
Constructor and Description
`ListPhoneNumbersRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getInstanceId()` The identifier of the Amazon Connect instance.
`java.lang.Integer`	`getMaxResults()` The maximum number of results to return per page.
`java.lang.String`	`getNextToken()` The token for the next set of results.
`java.util.List<java.lang.String>`	`getPhoneNumberCountryCodes()` The ISO country code.
`java.util.List<java.lang.String>`	`getPhoneNumberTypes()` The type of phone number.
`int`	`hashCode()`
`void`	`setInstanceId(java.lang.String instanceId)` The identifier of the Amazon Connect instance.
`void`	`setMaxResults(java.lang.Integer maxResults)` The maximum number of results to return per page.
`void`	`setNextToken(java.lang.String nextToken)` The token for the next set of results.
`void`	`setPhoneNumberCountryCodes(java.util.Collection<java.lang.String> phoneNumberCountryCodes)` The ISO country code.
`void`	`setPhoneNumberTypes(java.util.Collection<java.lang.String> phoneNumberTypes)` The type of phone number.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`ListPhoneNumbersRequest`	`withInstanceId(java.lang.String instanceId)` The identifier of the Amazon Connect instance.
`ListPhoneNumbersRequest`	`withMaxResults(java.lang.Integer maxResults)` The maximum number of results to return per page.
`ListPhoneNumbersRequest`	`withNextToken(java.lang.String nextToken)` The token for the next set of results.
`ListPhoneNumbersRequest`	`withPhoneNumberCountryCodes(java.util.Collection<java.lang.String> phoneNumberCountryCodes)` The ISO country code.
`ListPhoneNumbersRequest`	`withPhoneNumberCountryCodes(java.lang.String... phoneNumberCountryCodes)` The ISO country code.
`ListPhoneNumbersRequest`	`withPhoneNumberTypes(java.util.Collection<java.lang.String> phoneNumberTypes)` The type of phone number.
`ListPhoneNumbersRequest`	`withPhoneNumberTypes(java.lang.String... phoneNumberTypes)` The type of phone number.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ListPhoneNumbersRequest
```
public ListPhoneNumbersRequest()
```
- Method Detail
  - getInstanceId
```
public java.lang.String getInstanceId()
```
    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
    
    Constraints:
    Length: 1 - 100
    
    Returns:
    
    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
  - setInstanceId
```
public void setInstanceId(java.lang.String instanceId)
```
    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
    
    Constraints:
    Length: 1 - 100
    
    Parameters:
    
    instanceId -
    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
  - withInstanceId
```
public ListPhoneNumbersRequest withInstanceId(java.lang.String instanceId)
```
    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 100
    
    Parameters:
    
    instanceId -
    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getPhoneNumberTypes
```
public java.util.List<java.lang.String> getPhoneNumberTypes()
```
    The type of phone number.
    
    Returns:
    
    The type of phone number.
  - setPhoneNumberTypes
```
public void setPhoneNumberTypes(java.util.Collection<java.lang.String> phoneNumberTypes)
```
    The type of phone number.
    
    Parameters:
    
    phoneNumberTypes -
    The type of phone number.
  - withPhoneNumberTypes
```
public ListPhoneNumbersRequest withPhoneNumberTypes(java.lang.String... phoneNumberTypes)
```
    The type of phone number.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    phoneNumberTypes -
    The type of phone number.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withPhoneNumberTypes
```
public ListPhoneNumbersRequest withPhoneNumberTypes(java.util.Collection<java.lang.String> phoneNumberTypes)
```
    The type of phone number.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    phoneNumberTypes -
    The type of phone number.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getPhoneNumberCountryCodes
```
public java.util.List<java.lang.String> getPhoneNumberCountryCodes()
```
    The ISO country code.
    
    Returns:
    
    The ISO country code.
  - setPhoneNumberCountryCodes
```
public void setPhoneNumberCountryCodes(java.util.Collection<java.lang.String> phoneNumberCountryCodes)
```
    The ISO country code.
    
    Parameters:
    
    phoneNumberCountryCodes -
    The ISO country code.
  - withPhoneNumberCountryCodes
```
public ListPhoneNumbersRequest withPhoneNumberCountryCodes(java.lang.String... phoneNumberCountryCodes)
```
    The ISO country code.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    phoneNumberCountryCodes -
    The ISO country code.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withPhoneNumberCountryCodes
```
public ListPhoneNumbersRequest withPhoneNumberCountryCodes(java.util.Collection<java.lang.String> phoneNumberCountryCodes)
```
    The ISO country code.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    phoneNumberCountryCodes -
    The ISO country code.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getNextToken
```
public java.lang.String getNextToken()
```
    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
    
    Returns:
    
    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
  - setNextToken
```
public void setNextToken(java.lang.String nextToken)
```
    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
    
    Parameters:
    
    nextToken -
    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
  - withNextToken
```
public ListPhoneNumbersRequest withNextToken(java.lang.String nextToken)
```
    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    nextToken -
    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getMaxResults
```
public java.lang.Integer getMaxResults()
```
    The maximum number of results to return per page. The default MaxResult size is 100.
    
    Constraints:
    Range: 1 - 1000
    
    Returns:
    
    The maximum number of results to return per page. The default MaxResult size is 100.
  - setMaxResults
```
public void setMaxResults(java.lang.Integer maxResults)
```
    The maximum number of results to return per page. The default MaxResult size is 100.
    
    Constraints:
    Range: 1 - 1000
    
    Parameters:
    
    maxResults -
    The maximum number of results to return per page. The default MaxResult size is 100.
  - withMaxResults
```
public ListPhoneNumbersRequest withMaxResults(java.lang.Integer maxResults)
```
    The maximum number of results to return per page. The default MaxResult size is 100.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Range: 1 - 1000
    
    Parameters:
    
    maxResults -
    The maximum number of results to return per page. The default MaxResult size is 100.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class ListPhoneNumbersRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

ListPhoneNumbersRequest

Method Detail

getInstanceId

setInstanceId

withInstanceId

getPhoneNumberTypes

setPhoneNumberTypes

withPhoneNumberTypes

withPhoneNumberTypes

getPhoneNumberCountryCodes

setPhoneNumberCountryCodes

withPhoneNumberCountryCodes

withPhoneNumberCountryCodes

getNextToken

setNextToken

withNextToken

getMaxResults

setMaxResults

withMaxResults

toString

hashCode

equals