ClaimPhoneNumberRequest (AWS SDK for Java

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

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

ClaimPhoneNumberRequest()

Constructors
Constructor and Description
`ClaimPhoneNumberRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ClaimPhoneNumberRequest`	`addTagsEntry(String key, String value)` Add a single Tags entry
`ClaimPhoneNumberRequest`	`clearTagsEntries()` Removes all the entries added into Tags.
`ClaimPhoneNumberRequest`	`clone()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals(Object obj)`
`String`	`getClientToken()` A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
`String`	`getInstanceId()` The identifier of the Amazon Connect instance that phone numbers are claimed to.
`String`	`getPhoneNumber()` The phone number you want to claim.
`String`	`getPhoneNumberDescription()` The description of the phone number.
`Map<String,String>`	`getTags()` The tags used to organize, track, or control access for this resource.
`String`	`getTargetArn()` The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through.
`int`	`hashCode()`
`void`	`setClientToken(String clientToken)` A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
`void`	`setInstanceId(String instanceId)` The identifier of the Amazon Connect instance that phone numbers are claimed to.
`void`	`setPhoneNumber(String phoneNumber)` The phone number you want to claim.
`void`	`setPhoneNumberDescription(String phoneNumberDescription)` The description of the phone number.
`void`	`setTags(Map<String,String> tags)` The tags used to organize, track, or control access for this resource.
`void`	`setTargetArn(String targetArn)` The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through.
`String`	`toString()` Returns a string representation of this object.
`ClaimPhoneNumberRequest`	`withClientToken(String clientToken)` A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
`ClaimPhoneNumberRequest`	`withInstanceId(String instanceId)` The identifier of the Amazon Connect instance that phone numbers are claimed to.
`ClaimPhoneNumberRequest`	`withPhoneNumber(String phoneNumber)` The phone number you want to claim.
`ClaimPhoneNumberRequest`	`withPhoneNumberDescription(String phoneNumberDescription)` The description of the phone number.
`ClaimPhoneNumberRequest`	`withTags(Map<String,String> tags)` The tags used to organize, track, or control access for this resource.
`ClaimPhoneNumberRequest`	`withTargetArn(String targetArn)` The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through.

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

- Constructor Detail
  - ClaimPhoneNumberRequest
```
public ClaimPhoneNumberRequest()
```
- Method Detail
  - setTargetArn
```
public void setTargetArn(String targetArn)
```
    The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter InstanceId or TargetArn.
    
    Parameters:
    
    targetArn - The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter InstanceId or TargetArn .
  - getTargetArn
```
public String getTargetArn()
```
    The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter InstanceId or TargetArn.
    
    Returns:
    
    The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter InstanceId or TargetArn.
  - withTargetArn
```
public ClaimPhoneNumberRequest withTargetArn(String targetArn)
```
    The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter InstanceId or TargetArn.
    
    Parameters:
    
    targetArn - The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter InstanceId or TargetArn .
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInstanceId
```
public void setInstanceId(String instanceId)
```
    The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. You must enter InstanceId or TargetArn.
    
    Parameters:
    
    instanceId - The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. You must enter InstanceId or TargetArn.
  - getInstanceId
```
public String getInstanceId()
```
    The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. You must enter InstanceId or TargetArn.
    
    Returns:
    
    The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. You must enter InstanceId or TargetArn.
  - withInstanceId
```
public ClaimPhoneNumberRequest withInstanceId(String instanceId)
```
    The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. You must enter InstanceId or TargetArn.
    
    Parameters:
    
    instanceId - The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. You must enter InstanceId or TargetArn.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPhoneNumber
```
public void setPhoneNumber(String phoneNumber)
```
    The phone number you want to claim. Phone numbers are formatted [+] [country code] [subscriber number including area code].
    
    Parameters:
    
    phoneNumber - The phone number you want to claim. Phone numbers are formatted [+] [country code] [subscriber number including area code].
  - getPhoneNumber
```
public String getPhoneNumber()
```
    The phone number you want to claim. Phone numbers are formatted [+] [country code] [subscriber number including area code].
    
    Returns:
    
    The phone number you want to claim. Phone numbers are formatted [+] [country code] [subscriber number including area code].
  - withPhoneNumber
```
public ClaimPhoneNumberRequest withPhoneNumber(String phoneNumber)
```
    The phone number you want to claim. Phone numbers are formatted [+] [country code] [subscriber number including area code].
    
    Parameters:
    
    phoneNumber - The phone number you want to claim. Phone numbers are formatted [+] [country code] [subscriber number including area code].
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPhoneNumberDescription
```
public void setPhoneNumberDescription(String phoneNumberDescription)
```
    The description of the phone number.
    
    Parameters:
    
    phoneNumberDescription - The description of the phone number.
  - getPhoneNumberDescription
```
public String getPhoneNumberDescription()
```
    The description of the phone number.
    
    Returns:
    
    The description of the phone number.
  - withPhoneNumberDescription
```
public ClaimPhoneNumberRequest withPhoneNumberDescription(String phoneNumberDescription)
```
    The description of the phone number.
    
    Parameters:
    
    phoneNumberDescription - The description of the phone number.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public Map<String,String> getTags()
```
    The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
    
    Returns:
    
    The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
  - setTags
```
public void setTags(Map<String,String> tags)
```
    The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
    
    Parameters:
    
    tags - The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
  - withTags
```
public ClaimPhoneNumberRequest withTags(Map<String,String> tags)
```
    The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
    
    Parameters:
    
    tags - The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public ClaimPhoneNumberRequest addTagsEntry(String key,
                                            String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public ClaimPhoneNumberRequest clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setClientToken
```
public void setClientToken(String clientToken)
```
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
    
    Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
    
    Parameters:
    
    clientToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
    
    Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
  - getClientToken
```
public String getClientToken()
```
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
    
    Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
    
    Returns:
    
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
    
    Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
  - withClientToken
```
public ClaimPhoneNumberRequest withClientToken(String clientToken)
```
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
    
    Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
    
    Parameters:
    
    clientToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
    
    Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
    
    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 ClaimPhoneNumberRequest 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()

AWS SDK for Java 1.x API Reference - 1.12.773

Class ClaimPhoneNumberRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

ClaimPhoneNumberRequest

Method Detail

setTargetArn

getTargetArn

withTargetArn

setInstanceId

getInstanceId

withInstanceId

setPhoneNumber

getPhoneNumber

withPhoneNumber

setPhoneNumberDescription

getPhoneNumberDescription

withPhoneNumberDescription

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

setClientToken

getClientToken

withClientToken

toString

equals

hashCode

clone