@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class RequestPhoneNumberRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
RequestPhoneNumberRequest() |
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.
|
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
public void setIsoCountryCode(String isoCountryCode)
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
isoCountryCode
- The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.public String getIsoCountryCode()
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
public RequestPhoneNumberRequest withIsoCountryCode(String isoCountryCode)
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
isoCountryCode
- The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.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.
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.MessageType
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.
MessageType
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.
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.MessageType
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.
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.MessageType
public List<String> getNumberCapabilities()
Indicates if the phone number will be used for text messages, voice messages, or both.
NumberCapability
public void setNumberCapabilities(Collection<String> numberCapabilities)
Indicates if the phone number will be used for text messages, voice messages, or both.
numberCapabilities
- Indicates if the phone number will be used for text messages, voice messages, or both.NumberCapability
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.
numberCapabilities
- Indicates if the phone number will be used for text messages, voice messages, or both.NumberCapability
public RequestPhoneNumberRequest withNumberCapabilities(Collection<String> numberCapabilities)
Indicates if the phone number will be used for text messages, voice messages, or both.
numberCapabilities
- Indicates if the phone number will be used for text messages, voice messages, or both.NumberCapability
public RequestPhoneNumberRequest withNumberCapabilities(NumberCapability... numberCapabilities)
Indicates if the phone number will be used for text messages, voice messages, or both.
numberCapabilities
- Indicates if the phone number will be used for text messages, voice messages, or both.NumberCapability
public void setNumberType(String numberType)
The type of phone number to request.
numberType
- The type of phone number to request.RequestableNumberType
public String getNumberType()
The type of phone number to request.
RequestableNumberType
public RequestPhoneNumberRequest withNumberType(String numberType)
The type of phone number to request.
numberType
- The type of phone number to request.RequestableNumberType
public RequestPhoneNumberRequest withNumberType(RequestableNumberType numberType)
The type of phone number to request.
numberType
- The type of phone number to request.RequestableNumberType
public void setOptOutListName(String optOutListName)
The name of the OptOutList to associate with the phone number. You can use the OptOutListName or OptOutListArn.
optOutListName
- The name of the OptOutList to associate with the phone number. You can use the OptOutListName or
OptOutListArn.public String getOptOutListName()
The name of the OptOutList to associate with the phone number. You can use the OptOutListName or OptOutListArn.
public RequestPhoneNumberRequest withOptOutListName(String optOutListName)
The name of the OptOutList to associate with the phone number. You can use the OptOutListName or OptOutListArn.
optOutListName
- The name of the OptOutList to associate with the phone number. You can use the OptOutListName or
OptOutListArn.public void setPoolId(String poolId)
The pool to associated with the phone number. You can use the PoolId or PoolArn.
poolId
- The pool to associated with the phone number. You can use the PoolId or PoolArn.public String getPoolId()
The pool to associated with the phone number. You can use the PoolId or PoolArn.
public RequestPhoneNumberRequest withPoolId(String poolId)
The pool to associated with the phone number. You can use the PoolId or PoolArn.
poolId
- The pool to associated with the phone number. You can use the PoolId or PoolArn.public void setRegistrationId(String registrationId)
Use this field to attach your phone number for an external registration process.
registrationId
- Use this field to attach your phone number for an external registration process.public String getRegistrationId()
Use this field to attach your phone number for an external registration process.
public RequestPhoneNumberRequest withRegistrationId(String registrationId)
Use this field to attach your phone number for an external registration process.
registrationId
- Use this field to attach your phone number for an external registration process.public void setDeletionProtectionEnabled(Boolean deletionProtectionEnabled)
By default this is set to false. When set to true the phone number can't be deleted.
deletionProtectionEnabled
- By default this is set to false. When set to true the phone number can't be deleted.public Boolean getDeletionProtectionEnabled()
By default this is set to false. When set to true the phone number can't be deleted.
public RequestPhoneNumberRequest withDeletionProtectionEnabled(Boolean deletionProtectionEnabled)
By default this is set to false. When set to true the phone number can't be deleted.
deletionProtectionEnabled
- By default this is set to false. When set to true the phone number can't be deleted.public Boolean isDeletionProtectionEnabled()
By default this is set to false. When set to true the phone number can't be deleted.
public List<Tag> getTags()
An array of tags (key and value pairs) associate with the requested phone number.
public void setTags(Collection<Tag> tags)
An array of tags (key and value pairs) associate with the requested phone number.
tags
- An array of tags (key and value pairs) associate with the requested phone number.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.
tags
- An array of tags (key and value pairs) associate with the requested phone number.public RequestPhoneNumberRequest withTags(Collection<Tag> tags)
An array of tags (key and value pairs) associate with the requested phone number.
tags
- An array of tags (key and value pairs) associate with the requested phone number.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.
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.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.
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.
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.public String toString()
toString
in class Object
Object.toString()
public RequestPhoneNumberRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()