RequestPhoneNumberRequest (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.793

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.pinpointsmsvoicev2.model

Class RequestPhoneNumberRequest

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.pinpointsmsvoicev2.model.RequestPhoneNumberRequest

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

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

RequestPhoneNumberRequest ()

Constructors
Constructor and Description
`RequestPhoneNumberRequest ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`RequestPhoneNumberRequest`	`clone ()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals (Object obj)`
`String`	`getClientToken ()` Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
`Boolean`	`getDeletionProtectionEnabled ()` By default this is set to false.
`String`	`getIsoCountryCode ()` The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
`String`	`getMessageType ()` The type of message.
`List<String>`	`getNumberCapabilities ()` Indicates if the phone number will be used for text messages, voice messages, or both.
`String`	`getNumberType ()` The type of phone number to request.
`String`	`getOptOutListName ()` The name of the OptOutList to associate with the phone number.
`String`	`getPoolId ()` The pool to associated with the phone number.
`String`	`getRegistrationId ()` Use this field to attach your phone number for an external registration process.
`List<Tag>`	`getTags ()` An array of tags (key and value pairs) associate with the requested phone number.
`int`	`hashCode ()`
`Boolean`	`isDeletionProtectionEnabled ()` By default this is set to false.
`void`	`setClientToken (String clientToken)` Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
`void`	`setDeletionProtectionEnabled (Boolean deletionProtectionEnabled)` By default this is set to false.
`void`	`setIsoCountryCode (String isoCountryCode)` The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
`void`	`setMessageType (String messageType)` The type of message.
`void`	`setNumberCapabilities (Collection<String> numberCapabilities)` Indicates if the phone number will be used for text messages, voice messages, or both.
`void`	`setNumberType (String numberType)` The type of phone number to request.
`void`	`setOptOutListName (String optOutListName)` The name of the OptOutList to associate with the phone number.
`void`	`setPoolId (String poolId)` The pool to associated with the phone number.
`void`	`setRegistrationId (String registrationId)` Use this field to attach your phone number for an external registration process.
`void`	`setTags (Collection<Tag> tags)` An array of tags (key and value pairs) associate with the requested phone number.
`String`	`toString ()` Returns a string representation of this object.
`RequestPhoneNumberRequest`	`withClientToken (String clientToken)` Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
`RequestPhoneNumberRequest`	`withDeletionProtectionEnabled (Boolean deletionProtectionEnabled)` By default this is set to false.
`RequestPhoneNumberRequest`	`withIsoCountryCode (String isoCountryCode)` The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
`RequestPhoneNumberRequest`	`withMessageType (MessageType messageType)` The type of message.
`RequestPhoneNumberRequest`	`withMessageType (String messageType)` The type of message.
`RequestPhoneNumberRequest`	`withNumberCapabilities (Collection<String> numberCapabilities)` Indicates if the phone number will be used for text messages, voice messages, or both.
`RequestPhoneNumberRequest`	`withNumberCapabilities (NumberCapability... numberCapabilities)` Indicates if the phone number will be used for text messages, voice messages, or both.
`RequestPhoneNumberRequest`	`withNumberCapabilities (String... numberCapabilities)` Indicates if the phone number will be used for text messages, voice messages, or both.
`RequestPhoneNumberRequest`	`withNumberType (RequestableNumberType numberType)` The type of phone number to request.
`RequestPhoneNumberRequest`	`withNumberType (String numberType)` The type of phone number to request.
`RequestPhoneNumberRequest`	`withOptOutListName (String optOutListName)` The name of the OptOutList to associate with the phone number.
`RequestPhoneNumberRequest`	`withPoolId (String poolId)` The pool to associated with the phone number.
`RequestPhoneNumberRequest`	`withRegistrationId (String registrationId)` Use this field to attach your phone number for an external registration process.
`RequestPhoneNumberRequest`	`withTags (Collection<Tag> tags)` An array of tags (key and value pairs) associate with the requested phone number.
`RequestPhoneNumberRequest`	`withTags (Tag... tags)` An array of tags (key and value pairs) associate with the requested phone number.

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
  - RequestPhoneNumberRequest
```
public RequestPhoneNumberRequest()
```
- Method Detail
  - setIsoCountryCode
```
public void setIsoCountryCode(String isoCountryCode)
```
    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
    
    Parameters:
    
    isoCountryCode - The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
  - getIsoCountryCode
```
public String getIsoCountryCode()
```
    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
    
    Returns:
    
    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
  - withIsoCountryCode
```
public RequestPhoneNumberRequest withIsoCountryCode(String isoCountryCode)
```
    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
    
    Parameters:
    
    isoCountryCode - The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMessageType
```
public void setMessageType(String messageType)
```
    The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
    
    Parameters:
    
    messageType - The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
    
    See Also:
    
    MessageType
  - getMessageType
```
public String getMessageType()
```
    The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
    
    Returns:
    
    The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
    
    See Also:
    
    MessageType
  - withMessageType
```
public RequestPhoneNumberRequest withMessageType(String messageType)
```
    The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
    
    Parameters:
    
    messageType - The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MessageType
  - withMessageType
```
public RequestPhoneNumberRequest withMessageType(MessageType messageType)
```
    The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
    
    Parameters:
    
    messageType - The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MessageType
  - getNumberCapabilities
```
public List<String> getNumberCapabilities()
```
    Indicates if the phone number will be used for text messages, voice messages, or both.
    
    Returns:
    
    Indicates if the phone number will be used for text messages, voice messages, or both.
    
    See Also:
    
    NumberCapability
  - setNumberCapabilities
```
public void setNumberCapabilities(Collection<String> numberCapabilities)
```
    Indicates if the phone number will be used for text messages, voice messages, or both.
    
    Parameters:
    
    numberCapabilities - Indicates if the phone number will be used for text messages, voice messages, or both.
    
    See Also:
    
    NumberCapability
  - withNumberCapabilities
```
public RequestPhoneNumberRequest withNumberCapabilities(String... numberCapabilities)
```
    Indicates if the phone number will be used for text messages, voice messages, or both.
    
    NOTE: This method appends the values to the existing list (if any). Use setNumberCapabilities(java.util.Collection) or withNumberCapabilities(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    numberCapabilities - Indicates if the phone number will be used for text messages, voice messages, or both.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    NumberCapability
  - withNumberCapabilities
```
public RequestPhoneNumberRequest withNumberCapabilities(Collection<String> numberCapabilities)
```
    Indicates if the phone number will be used for text messages, voice messages, or both.
    
    Parameters:
    
    numberCapabilities - Indicates if the phone number will be used for text messages, voice messages, or both.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    NumberCapability
  - withNumberCapabilities
```
public RequestPhoneNumberRequest withNumberCapabilities(NumberCapability... numberCapabilities)
```
    Indicates if the phone number will be used for text messages, voice messages, or both.
    
    Parameters:
    
    numberCapabilities - Indicates if the phone number will be used for text messages, voice messages, or both.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    NumberCapability
  - setNumberType
```
public void setNumberType(String numberType)
```
    The type of phone number to request.
    
    Parameters:
    
    numberType - The type of phone number to request.
    
    See Also:
    
    RequestableNumberType
  - getNumberType
```
public String getNumberType()
```
    The type of phone number to request.
    
    Returns:
    
    The type of phone number to request.
    
    See Also:
    
    RequestableNumberType
  - withNumberType
```
public RequestPhoneNumberRequest withNumberType(String numberType)
```
    The type of phone number to request.
    
    Parameters:
    
    numberType - The type of phone number to request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RequestableNumberType
  - withNumberType
```
public RequestPhoneNumberRequest withNumberType(RequestableNumberType numberType)
```
    The type of phone number to request.
    
    Parameters:
    
    numberType - The type of phone number to request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RequestableNumberType
  - setOptOutListName
```
public void setOptOutListName(String optOutListName)
```
    The name of the OptOutList to associate with the phone number. You can use the OptOutListName or OptOutListArn.
    
    Parameters:
    
    optOutListName - The name of the OptOutList to associate with the phone number. You can use the OptOutListName or OptOutListArn.
  - getOptOutListName
```
public String getOptOutListName()
```
    The name of the OptOutList to associate with the phone number. You can use the OptOutListName or OptOutListArn.
    
    Returns:
    
    The name of the OptOutList to associate with the phone number. You can use the OptOutListName or OptOutListArn.
  - withOptOutListName
```
public RequestPhoneNumberRequest withOptOutListName(String optOutListName)
```
    The name of the OptOutList to associate with the phone number. You can use the OptOutListName or OptOutListArn.
    
    Parameters:
    
    optOutListName - The name of the OptOutList to associate with the phone number. You can use the OptOutListName or OptOutListArn.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPoolId
```
public void setPoolId(String poolId)
```
    The pool to associated with the phone number. You can use the PoolId or PoolArn.
    
    Parameters:
    
    poolId - The pool to associated with the phone number. You can use the PoolId or PoolArn.
  - getPoolId
```
public String getPoolId()
```
    The pool to associated with the phone number. You can use the PoolId or PoolArn.
    
    Returns:
    
    The pool to associated with the phone number. You can use the PoolId or PoolArn.
  - withPoolId
```
public RequestPhoneNumberRequest withPoolId(String poolId)
```
    The pool to associated with the phone number. You can use the PoolId or PoolArn.
    
    Parameters:
    
    poolId - The pool to associated with the phone number. You can use the PoolId or PoolArn.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRegistrationId
```
public void setRegistrationId(String registrationId)
```
    Use this field to attach your phone number for an external registration process.
    
    Parameters:
    
    registrationId - Use this field to attach your phone number for an external registration process.
  - getRegistrationId
```
public String getRegistrationId()
```
    Use this field to attach your phone number for an external registration process.
    
    Returns:
    
    Use this field to attach your phone number for an external registration process.
  - withRegistrationId
```
public RequestPhoneNumberRequest withRegistrationId(String registrationId)
```
    Use this field to attach your phone number for an external registration process.
    
    Parameters:
    
    registrationId - Use this field to attach your phone number for an external registration process.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDeletionProtectionEnabled
```
public void setDeletionProtectionEnabled(Boolean deletionProtectionEnabled)
```
    By default this is set to false. When set to true the phone number can't be deleted.
    
    Parameters:
    
    deletionProtectionEnabled - By default this is set to false. When set to true the phone number can't be deleted.
  - getDeletionProtectionEnabled
```
public Boolean getDeletionProtectionEnabled()
```
    By default this is set to false. When set to true the phone number can't be deleted.
    
    Returns:
    
    By default this is set to false. When set to true the phone number can't be deleted.
  - withDeletionProtectionEnabled
```
public RequestPhoneNumberRequest withDeletionProtectionEnabled(Boolean deletionProtectionEnabled)
```
    By default this is set to false. When set to true the phone number can't be deleted.
    
    Parameters:
    
    deletionProtectionEnabled - By default this is set to false. When set to true the phone number can't be deleted.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isDeletionProtectionEnabled
```
public Boolean isDeletionProtectionEnabled()
```
    By default this is set to false. When set to true the phone number can't be deleted.
    
    Returns:
    
    By default this is set to false. When set to true the phone number can't be deleted.
  - getTags
```
public List<Tag> getTags()
```
    An array of tags (key and value pairs) associate with the requested phone number.
    
    Returns:
    
    An array of tags (key and value pairs) associate with the requested phone number.
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    An array of tags (key and value pairs) associate with the requested phone number.
    
    Parameters:
    
    tags - An array of tags (key and value pairs) associate with the requested phone number.
  - withTags
```
public RequestPhoneNumberRequest withTags(Tag... tags)
```
    An array of tags (key and value pairs) associate with the requested phone number.
    
    NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    tags - An array of tags (key and value pairs) associate with the requested phone number.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public RequestPhoneNumberRequest withTags(Collection<Tag> tags)
```
    An array of tags (key and value pairs) associate with the requested phone number.
    
    Parameters:
    
    tags - An array of tags (key and value pairs) associate with the requested phone number.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setClientToken
```
public void setClientToken(String clientToken)
```
    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
    
    Parameters:
    
    clientToken - Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
  - getClientToken
```
public String getClientToken()
```
    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
    
    Returns:
    
    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
  - withClientToken
```
public RequestPhoneNumberRequest withClientToken(String clientToken)
```
    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
    
    Parameters:
    
    clientToken - Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
    
    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 RequestPhoneNumberRequest 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()

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.793

Class RequestPhoneNumberRequest

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

RequestPhoneNumberRequest

Method Detail

setIsoCountryCode

getIsoCountryCode

withIsoCountryCode

setMessageType

getMessageType

withMessageType

withMessageType

getNumberCapabilities

setNumberCapabilities

withNumberCapabilities

withNumberCapabilities

withNumberCapabilities

setNumberType

getNumberType

withNumberType

withNumberType

setOptOutListName

getOptOutListName

withOptOutListName

setPoolId

getPoolId

withPoolId

setRegistrationId

getRegistrationId

withRegistrationId

setDeletionProtectionEnabled

getDeletionProtectionEnabled

withDeletionProtectionEnabled

isDeletionProtectionEnabled

getTags

setTags

withTags

withTags

setClientToken

getClientToken

withClientToken

toString

equals

hashCode

clone