All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

• Method Summary

  All Methods

  Modifier and Type	Method and Description
  UpdatePhoneNumberRequest	clone () Creates a shallow clone of this object for all fields except the handler context.
  boolean	equals (Object obj)
  Boolean	getDeletionProtectionEnabled () By default this is set to false.
  String	getOptOutListName () The OptOutList to add the phone number to.
  String	getPhoneNumberId () The unique identifier of the phone number.
  Boolean	getSelfManagedOptOutsEnabled () By default this is set to false.
  String	getTwoWayChannelArn () The Amazon Resource Name (ARN) of 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	setDeletionProtectionEnabled (Boolean deletionProtectionEnabled) By default this is set to false.
  void	setOptOutListName (String optOutListName) The OptOutList to add the phone number to.
  void	setPhoneNumberId (String phoneNumberId) The unique identifier of the phone number.
  void	setSelfManagedOptOutsEnabled (Boolean selfManagedOptOutsEnabled) By default this is set to false.
  void	setTwoWayChannelArn (String twoWayChannelArn) The Amazon Resource Name (ARN) of 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.
  UpdatePhoneNumberRequest	withDeletionProtectionEnabled (Boolean deletionProtectionEnabled) By default this is set to false.
  UpdatePhoneNumberRequest	withOptOutListName (String optOutListName) The OptOutList to add the phone number to.
  UpdatePhoneNumberRequest	withPhoneNumberId (String phoneNumberId) The unique identifier of the phone number.
  UpdatePhoneNumberRequest	withSelfManagedOptOutsEnabled (Boolean selfManagedOptOutsEnabled) By default this is set to false.
  UpdatePhoneNumberRequest	withTwoWayChannelArn (String twoWayChannelArn) The Amazon Resource Name (ARN) of the two way channel.
  UpdatePhoneNumberRequest	withTwoWayChannelRole (String twoWayChannelRole) An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
  UpdatePhoneNumberRequest	withTwoWayEnabled (Boolean twoWayEnabled) By default this is set to false.

  • 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

  • UpdatePhoneNumberRequest

    public UpdatePhoneNumberRequest()

• Method Detail

  • setPhoneNumberId

    public void setPhoneNumberId(String phoneNumberId)

    The unique identifier of the phone number. Valid values for this field can be either the PhoneNumberId or PhoneNumberArn.

    Parameters:

    phoneNumberId - The unique identifier of the phone number. Valid values for this field can be either the PhoneNumberId or PhoneNumberArn.

  • getPhoneNumberId

    public String getPhoneNumberId()

    The unique identifier of the phone number. Valid values for this field can be either the PhoneNumberId or PhoneNumberArn.

    Returns:

    The unique identifier of the phone number. Valid values for this field can be either the PhoneNumberId or PhoneNumberArn.

  • withPhoneNumberId

    public UpdatePhoneNumberRequest withPhoneNumberId(String phoneNumberId)

    The unique identifier of the phone number. Valid values for this field can be either the PhoneNumberId or PhoneNumberArn.

    Parameters:

    phoneNumberId - The unique identifier of the phone number. Valid values for this field can be either the PhoneNumberId or PhoneNumberArn.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • setTwoWayEnabled

    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.

    Parameters:

    twoWayEnabled - By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

  • getTwoWayEnabled

    public Boolean getTwoWayEnabled()

    By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

    Returns:

    By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

  • withTwoWayEnabled

    public UpdatePhoneNumberRequest withTwoWayEnabled(Boolean twoWayEnabled)

    By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

    Parameters:

    twoWayEnabled - By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • isTwoWayEnabled

    public Boolean isTwoWayEnabled()

    By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

    Returns:

    By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

  • setTwoWayChannelArn

    public void setTwoWayChannelArn(String twoWayChannelArn)

    The Amazon Resource Name (ARN) of the two way channel.

    Parameters:

    twoWayChannelArn - The Amazon Resource Name (ARN) of the two way channel.

  • getTwoWayChannelArn

    public String getTwoWayChannelArn()

    The Amazon Resource Name (ARN) of the two way channel.

    Returns:

    The Amazon Resource Name (ARN) of the two way channel.

  • withTwoWayChannelArn

    public UpdatePhoneNumberRequest withTwoWayChannelArn(String twoWayChannelArn)

    The Amazon Resource Name (ARN) of the two way channel.

    Parameters:

    twoWayChannelArn - The Amazon Resource Name (ARN) of the two way channel.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • setTwoWayChannelRole

    public void setTwoWayChannelRole(String twoWayChannelRole)

    An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

    Parameters:

    twoWayChannelRole - An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

  • getTwoWayChannelRole

    public String getTwoWayChannelRole()

    An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

    Returns:

    An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

  • withTwoWayChannelRole

    public UpdatePhoneNumberRequest withTwoWayChannelRole(String twoWayChannelRole)

    An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

    Parameters:

    twoWayChannelRole - An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • setSelfManagedOptOutsEnabled

    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.

    Parameters:

    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.

  • getSelfManagedOptOutsEnabled

    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.

    Returns:

    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.

  • withSelfManagedOptOutsEnabled

    public UpdatePhoneNumberRequest 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.

    Parameters:

    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.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • isSelfManagedOptOutsEnabled

    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.

    Returns:

    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.

  • setOptOutListName

    public void setOptOutListName(String optOutListName)

    The OptOutList to add the phone number to. Valid values for this field can be either the OutOutListName or OutOutListArn.

    Parameters:

    optOutListName - The OptOutList to add the phone number to. Valid values for this field can be either the OutOutListName or OutOutListArn.

  • getOptOutListName

    public String getOptOutListName()

    The OptOutList to add the phone number to. Valid values for this field can be either the OutOutListName or OutOutListArn.

    Returns:

    The OptOutList to add the phone number to. Valid values for this field can be either the OutOutListName or OutOutListArn.

  • withOptOutListName

    public UpdatePhoneNumberRequest withOptOutListName(String optOutListName)

    The OptOutList to add the phone number to. Valid values for this field can be either the OutOutListName or OutOutListArn.

    Parameters:

    optOutListName - The OptOutList to add the phone number to. Valid values for this field can be either the OutOutListName or OutOutListArn.

    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 UpdatePhoneNumberRequest 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.

  • 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 UpdatePhoneNumberRequest 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()