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

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class ListPhoneNumbersV2Request
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable
```
Lists phone numbers claimed to your Amazon Connect instance or traffic distribution group. If the provided TargetArn is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with traffic distribution group.

For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide.
- When given an instance ARN, ListPhoneNumbersV2 returns only the phone numbers claimed to the instance.
- When given a traffic distribution group ARN ListPhoneNumbersV2 returns only the phone numbers claimed to the traffic distribution group.
See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

ListPhoneNumbersV2Request()

Constructors
Constructor and Description
`ListPhoneNumbersV2Request()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`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.lang.String`	`getPhoneNumberPrefix()` The prefix of the phone number.
`java.util.List<java.lang.String>`	`getPhoneNumberTypes()` The type of phone number.
`java.lang.String`	`getTargetArn()` The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.
`int`	`hashCode()`
`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`	`setPhoneNumberPrefix(java.lang.String phoneNumberPrefix)` The prefix of the phone number.
`void`	`setPhoneNumberTypes(java.util.Collection<java.lang.String> phoneNumberTypes)` The type of phone number.
`void`	`setTargetArn(java.lang.String targetArn)` The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`ListPhoneNumbersV2Request`	`withMaxResults(java.lang.Integer maxResults)` The maximum number of results to return per page.
`ListPhoneNumbersV2Request`	`withNextToken(java.lang.String nextToken)` The token for the next set of results.
`ListPhoneNumbersV2Request`	`withPhoneNumberCountryCodes(java.util.Collection<java.lang.String> phoneNumberCountryCodes)` The ISO country code.
`ListPhoneNumbersV2Request`	`withPhoneNumberCountryCodes(java.lang.String... phoneNumberCountryCodes)` The ISO country code.
`ListPhoneNumbersV2Request`	`withPhoneNumberPrefix(java.lang.String phoneNumberPrefix)` The prefix of the phone number.
`ListPhoneNumbersV2Request`	`withPhoneNumberTypes(java.util.Collection<java.lang.String> phoneNumberTypes)` The type of phone number.
`ListPhoneNumbersV2Request`	`withPhoneNumberTypes(java.lang.String... phoneNumberTypes)` The type of phone number.
`ListPhoneNumbersV2Request`	`withTargetArn(java.lang.String targetArn)` The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.

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
  - ListPhoneNumbersV2Request
```
public ListPhoneNumbersV2Request()
```
- Method Detail
  - getTargetArn
```
public java.lang.String getTargetArn()
```
    The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to. If TargetArn input is not provided, this API lists numbers claimed to all the Amazon Connect instances belonging to your account in the same Amazon Web Services Region as the request.
    
    Returns:
    
    The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to. If TargetArn input is not provided, this API lists numbers claimed to all the Amazon Connect instances belonging to your account in the same Amazon Web Services Region as the request.
  - setTargetArn
```
public void setTargetArn(java.lang.String targetArn)
```
    The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to. If TargetArn input is not provided, this API lists numbers claimed to all the Amazon Connect instances belonging to your account in the same Amazon Web Services Region as the request.
    
    Parameters:
    
    targetArn -
    The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to. If TargetArn input is not provided, this API lists numbers claimed to all the Amazon Connect instances belonging to your account in the same Amazon Web Services Region as the request.
  - withTargetArn
```
public ListPhoneNumbersV2Request withTargetArn(java.lang.String targetArn)
```
    The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to. If TargetArn input is not provided, this API lists numbers claimed to all the Amazon Connect instances belonging to your account in the same Amazon Web Services Region as the request.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    targetArn -
    The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to. If TargetArn input is not provided, this API lists numbers claimed to all the Amazon Connect instances belonging to your account in the same Amazon Web Services Region as the request.
    
    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.
    
    Constraints:
    Range: 1 - 1000
    
    Returns:
    
    The maximum number of results to return per page.
  - setMaxResults
```
public void setMaxResults(java.lang.Integer maxResults)
```
    The maximum number of results to return per page.
    
    Constraints:
    Range: 1 - 1000
    
    Parameters:
    
    maxResults -
    The maximum number of results to return per page.
  - withMaxResults
```
public ListPhoneNumbersV2Request withMaxResults(java.lang.Integer maxResults)
```
    The maximum number of results to return per page.
    
    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.
    
    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.
    
    Constraints:
    Length: 1 - 100000
    
    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.
    
    Constraints:
    Length: 1 - 100000
    
    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 ListPhoneNumbersV2Request 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.
    Constraints:
    Length: 1 - 100000
    
    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.
  - 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 ListPhoneNumbersV2Request 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 ListPhoneNumbersV2Request 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.
  - 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 ListPhoneNumbersV2Request 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 ListPhoneNumbersV2Request 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.
  - getPhoneNumberPrefix
```
public java.lang.String getPhoneNumberPrefix()
```
    The prefix of the phone number. If provided, it must contain + as part of the country code.
    
    Constraints:
    Pattern: \\+?[0-9]{1,11}
    
    Returns:
    
    The prefix of the phone number. If provided, it must contain + as part of the country code.
  - setPhoneNumberPrefix
```
public void setPhoneNumberPrefix(java.lang.String phoneNumberPrefix)
```
    The prefix of the phone number. If provided, it must contain + as part of the country code.
    
    Constraints:
    Pattern: \\+?[0-9]{1,11}
    
    Parameters:
    
    phoneNumberPrefix -
    The prefix of the phone number. If provided, it must contain + as part of the country code.
  - withPhoneNumberPrefix
```
public ListPhoneNumbersV2Request withPhoneNumberPrefix(java.lang.String phoneNumberPrefix)
```
    The prefix of the phone number. If provided, it must contain + as part of the country code.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Pattern: \\+?[0-9]{1,11}
    
    Parameters:
    
    phoneNumberPrefix -
    The prefix of the phone number. If provided, it must contain + as part of the country code.
    
    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 ListPhoneNumbersV2Request

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

ListPhoneNumbersV2Request

Method Detail

getTargetArn

setTargetArn

withTargetArn

getMaxResults

setMaxResults

withMaxResults

getNextToken

setNextToken

withNextToken

getPhoneNumberCountryCodes

setPhoneNumberCountryCodes

withPhoneNumberCountryCodes

withPhoneNumberCountryCodes

getPhoneNumberTypes

setPhoneNumberTypes

withPhoneNumberTypes

withPhoneNumberTypes

getPhoneNumberPrefix

setPhoneNumberPrefix

withPhoneNumberPrefix

toString

hashCode

equals