@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class RequestPhoneNumberResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable, Cloneable
Constructor and Description |
---|
RequestPhoneNumberResult() |
Modifier and Type | Method and Description |
---|---|
RequestPhoneNumberResult |
clone() |
boolean |
equals(Object obj) |
Date |
getCreatedTimestamp()
The time when the phone number was created, in UNIX epoch time
format.
|
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.
|
String |
getMonthlyLeasingPrice()
The monthly price, in US dollars, to lease the phone number.
|
List<String> |
getNumberCapabilities()
Indicates if the phone number will be used for text messages, voice messages or both.
|
String |
getNumberType()
The type of number that was released.
|
String |
getOptOutListName()
The name of the OptOutList that is associated with the requested phone number.
|
String |
getPhoneNumber()
The new phone number that was requested.
|
String |
getPhoneNumberArn()
The Amazon Resource Name (ARN) of the requested phone number.
|
String |
getPhoneNumberId()
The unique identifier of the new phone number.
|
String |
getPoolId()
The unique identifier of the pool associated with the phone number
|
String |
getRegistrationId()
The unique identifier for the registration.
|
Boolean |
getSelfManagedOptOutsEnabled()
By default this is set to false.
|
String |
getStatus()
The current status of the request.
|
List<Tag> |
getTags()
An array of key and value pair tags that are associated with the phone number.
|
String |
getTwoWayChannelArn()
The ARN used to identify the two way channel.
|
String |
getTwoWayChannelRole()
An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
|
Boolean |
getTwoWayEnabled()
By default this is set to false.
|
int |
hashCode() |
Boolean |
isDeletionProtectionEnabled()
By default this is set to false.
|
Boolean |
isSelfManagedOptOutsEnabled()
By default this is set to false.
|
Boolean |
isTwoWayEnabled()
By default this is set to false.
|
void |
setCreatedTimestamp(Date createdTimestamp)
The time when the phone number was created, in UNIX epoch time
format.
|
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 |
setMonthlyLeasingPrice(String monthlyLeasingPrice)
The monthly price, in US dollars, to lease the phone number.
|
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 number that was released.
|
void |
setOptOutListName(String optOutListName)
The name of the OptOutList that is associated with the requested phone number.
|
void |
setPhoneNumber(String phoneNumber)
The new phone number that was requested.
|
void |
setPhoneNumberArn(String phoneNumberArn)
The Amazon Resource Name (ARN) of the requested phone number.
|
void |
setPhoneNumberId(String phoneNumberId)
The unique identifier of the new phone number.
|
void |
setPoolId(String poolId)
The unique identifier of the pool associated with the phone number
|
void |
setRegistrationId(String registrationId)
The unique identifier for the registration.
|
void |
setSelfManagedOptOutsEnabled(Boolean selfManagedOptOutsEnabled)
By default this is set to false.
|
void |
setStatus(String status)
The current status of the request.
|
void |
setTags(Collection<Tag> tags)
An array of key and value pair tags that are associated with the phone number.
|
void |
setTwoWayChannelArn(String twoWayChannelArn)
The ARN used to identify the two way channel.
|
void |
setTwoWayChannelRole(String twoWayChannelRole)
An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
|
void |
setTwoWayEnabled(Boolean twoWayEnabled)
By default this is set to false.
|
String |
toString()
Returns a string representation of this object.
|
RequestPhoneNumberResult |
withCreatedTimestamp(Date createdTimestamp)
The time when the phone number was created, in UNIX epoch time
format.
|
RequestPhoneNumberResult |
withDeletionProtectionEnabled(Boolean deletionProtectionEnabled)
By default this is set to false.
|
RequestPhoneNumberResult |
withIsoCountryCode(String isoCountryCode)
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
|
RequestPhoneNumberResult |
withMessageType(MessageType messageType)
The type of message.
|
RequestPhoneNumberResult |
withMessageType(String messageType)
The type of message.
|
RequestPhoneNumberResult |
withMonthlyLeasingPrice(String monthlyLeasingPrice)
The monthly price, in US dollars, to lease the phone number.
|
RequestPhoneNumberResult |
withNumberCapabilities(Collection<String> numberCapabilities)
Indicates if the phone number will be used for text messages, voice messages or both.
|
RequestPhoneNumberResult |
withNumberCapabilities(NumberCapability... numberCapabilities)
Indicates if the phone number will be used for text messages, voice messages or both.
|
RequestPhoneNumberResult |
withNumberCapabilities(String... numberCapabilities)
Indicates if the phone number will be used for text messages, voice messages or both.
|
RequestPhoneNumberResult |
withNumberType(RequestableNumberType numberType)
The type of number that was released.
|
RequestPhoneNumberResult |
withNumberType(String numberType)
The type of number that was released.
|
RequestPhoneNumberResult |
withOptOutListName(String optOutListName)
The name of the OptOutList that is associated with the requested phone number.
|
RequestPhoneNumberResult |
withPhoneNumber(String phoneNumber)
The new phone number that was requested.
|
RequestPhoneNumberResult |
withPhoneNumberArn(String phoneNumberArn)
The Amazon Resource Name (ARN) of the requested phone number.
|
RequestPhoneNumberResult |
withPhoneNumberId(String phoneNumberId)
The unique identifier of the new phone number.
|
RequestPhoneNumberResult |
withPoolId(String poolId)
The unique identifier of the pool associated with the phone number
|
RequestPhoneNumberResult |
withRegistrationId(String registrationId)
The unique identifier for the registration.
|
RequestPhoneNumberResult |
withSelfManagedOptOutsEnabled(Boolean selfManagedOptOutsEnabled)
By default this is set to false.
|
RequestPhoneNumberResult |
withStatus(NumberStatus status)
The current status of the request.
|
RequestPhoneNumberResult |
withStatus(String status)
The current status of the request.
|
RequestPhoneNumberResult |
withTags(Collection<Tag> tags)
An array of key and value pair tags that are associated with the phone number.
|
RequestPhoneNumberResult |
withTags(Tag... tags)
An array of key and value pair tags that are associated with the phone number.
|
RequestPhoneNumberResult |
withTwoWayChannelArn(String twoWayChannelArn)
The ARN used to identify the two way channel.
|
RequestPhoneNumberResult |
withTwoWayChannelRole(String twoWayChannelRole)
An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
|
RequestPhoneNumberResult |
withTwoWayEnabled(Boolean twoWayEnabled)
By default this is set to false.
|
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata
public void setPhoneNumberArn(String phoneNumberArn)
The Amazon Resource Name (ARN) of the requested phone number.
phoneNumberArn
- The Amazon Resource Name (ARN) of the requested phone number.public String getPhoneNumberArn()
The Amazon Resource Name (ARN) of the requested phone number.
public RequestPhoneNumberResult withPhoneNumberArn(String phoneNumberArn)
The Amazon Resource Name (ARN) of the requested phone number.
phoneNumberArn
- The Amazon Resource Name (ARN) of the requested phone number.public void setPhoneNumberId(String phoneNumberId)
The unique identifier of the new phone number.
phoneNumberId
- The unique identifier of the new phone number.public String getPhoneNumberId()
The unique identifier of the new phone number.
public RequestPhoneNumberResult withPhoneNumberId(String phoneNumberId)
The unique identifier of the new phone number.
phoneNumberId
- The unique identifier of the new phone number.public void setPhoneNumber(String phoneNumber)
The new phone number that was requested.
phoneNumber
- The new phone number that was requested.public String getPhoneNumber()
The new phone number that was requested.
public RequestPhoneNumberResult withPhoneNumber(String phoneNumber)
The new phone number that was requested.
phoneNumber
- The new phone number that was requested.public void setStatus(String status)
The current status of the request.
status
- The current status of the request.NumberStatus
public String getStatus()
The current status of the request.
NumberStatus
public RequestPhoneNumberResult withStatus(String status)
The current status of the request.
status
- The current status of the request.NumberStatus
public RequestPhoneNumberResult withStatus(NumberStatus status)
The current status of the request.
status
- The current status of the request.NumberStatus
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 RequestPhoneNumberResult 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 RequestPhoneNumberResult 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 RequestPhoneNumberResult 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 RequestPhoneNumberResult 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 RequestPhoneNumberResult 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 RequestPhoneNumberResult 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 number that was released.
numberType
- The type of number that was released.RequestableNumberType
public String getNumberType()
The type of number that was released.
RequestableNumberType
public RequestPhoneNumberResult withNumberType(String numberType)
The type of number that was released.
numberType
- The type of number that was released.RequestableNumberType
public RequestPhoneNumberResult withNumberType(RequestableNumberType numberType)
The type of number that was released.
numberType
- The type of number that was released.RequestableNumberType
public void setMonthlyLeasingPrice(String monthlyLeasingPrice)
The monthly price, in US dollars, to lease the phone number.
monthlyLeasingPrice
- The monthly price, in US dollars, to lease the phone number.public String getMonthlyLeasingPrice()
The monthly price, in US dollars, to lease the phone number.
public RequestPhoneNumberResult withMonthlyLeasingPrice(String monthlyLeasingPrice)
The monthly price, in US dollars, to lease the phone number.
monthlyLeasingPrice
- The monthly price, in US dollars, to lease the phone number.public void setTwoWayEnabled(Boolean twoWayEnabled)
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
twoWayEnabled
- By default this is set to false. When set to true you can receive incoming text messages from your end
recipients.public Boolean getTwoWayEnabled()
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
public RequestPhoneNumberResult withTwoWayEnabled(Boolean twoWayEnabled)
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
twoWayEnabled
- By default this is set to false. When set to true you can receive incoming text messages from your end
recipients.public Boolean isTwoWayEnabled()
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
public void setTwoWayChannelArn(String twoWayChannelArn)
The ARN used to identify the two way channel.
twoWayChannelArn
- The ARN used to identify the two way channel.public String getTwoWayChannelArn()
The ARN used to identify the two way channel.
public RequestPhoneNumberResult withTwoWayChannelArn(String twoWayChannelArn)
The ARN used to identify the two way channel.
twoWayChannelArn
- The ARN used to identify the two way channel.public void setTwoWayChannelRole(String twoWayChannelRole)
An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
twoWayChannelRole
- An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.public String getTwoWayChannelRole()
An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
public RequestPhoneNumberResult withTwoWayChannelRole(String twoWayChannelRole)
An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
twoWayChannelRole
- An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.public void setSelfManagedOptOutsEnabled(Boolean selfManagedOptOutsEnabled)
By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
selfManagedOptOutsEnabled
- By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to
one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a
customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for
responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.public Boolean getSelfManagedOptOutsEnabled()
By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
public RequestPhoneNumberResult withSelfManagedOptOutsEnabled(Boolean selfManagedOptOutsEnabled)
By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
selfManagedOptOutsEnabled
- By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to
one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a
customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for
responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.public Boolean isSelfManagedOptOutsEnabled()
By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
public void setOptOutListName(String optOutListName)
The name of the OptOutList that is associated with the requested phone number.
optOutListName
- The name of the OptOutList that is associated with the requested phone number.public String getOptOutListName()
The name of the OptOutList that is associated with the requested phone number.
public RequestPhoneNumberResult withOptOutListName(String optOutListName)
The name of the OptOutList that is associated with the requested phone number.
optOutListName
- The name of the OptOutList that is associated with the requested phone number.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 RequestPhoneNumberResult 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 void setPoolId(String poolId)
The unique identifier of the pool associated with the phone number
poolId
- The unique identifier of the pool associated with the phone numberpublic String getPoolId()
The unique identifier of the pool associated with the phone number
public RequestPhoneNumberResult withPoolId(String poolId)
The unique identifier of the pool associated with the phone number
poolId
- The unique identifier of the pool associated with the phone numberpublic void setRegistrationId(String registrationId)
The unique identifier for the registration.
registrationId
- The unique identifier for the registration.public String getRegistrationId()
The unique identifier for the registration.
public RequestPhoneNumberResult withRegistrationId(String registrationId)
The unique identifier for the registration.
registrationId
- The unique identifier for the registration.public List<Tag> getTags()
An array of key and value pair tags that are associated with the phone number.
public void setTags(Collection<Tag> tags)
An array of key and value pair tags that are associated with the phone number.
tags
- An array of key and value pair tags that are associated with the phone number.public RequestPhoneNumberResult withTags(Tag... tags)
An array of key and value pair tags that are associated with the 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 key and value pair tags that are associated with the phone number.public RequestPhoneNumberResult withTags(Collection<Tag> tags)
An array of key and value pair tags that are associated with the phone number.
tags
- An array of key and value pair tags that are associated with the phone number.public void setCreatedTimestamp(Date createdTimestamp)
The time when the phone number was created, in UNIX epoch time format.
createdTimestamp
- The time when the phone number was created, in UNIX epoch
time format.public Date getCreatedTimestamp()
The time when the phone number was created, in UNIX epoch time format.
public RequestPhoneNumberResult withCreatedTimestamp(Date createdTimestamp)
The time when the phone number was created, in UNIX epoch time format.
createdTimestamp
- The time when the phone number was created, in UNIX epoch
time format.public String toString()
toString
in class Object
Object.toString()
public RequestPhoneNumberResult clone()