Package software.amazon.awssdk.services.pinpointsmsvoicev2.model

Class UpdatePhoneNumberRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.pinpointsmsvoicev2.model.PinpointSmsVoiceV2Request
software.amazon.awssdk.services.pinpointsmsvoicev2.model.UpdatePhoneNumberRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdatePhoneNumberRequest.Builder,UpdatePhoneNumberRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdatePhoneNumberRequest extends PinpointSmsVoiceV2Request implements ToCopyableBuilder<UpdatePhoneNumberRequest.Builder,UpdatePhoneNumberRequest>

  • Method Details

    • phoneNumberId

      public final String phoneNumberId()

      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.

    • twoWayEnabled

      public final Boolean twoWayEnabled()

      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.

    • twoWayChannelArn

      public final String twoWayChannelArn()

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

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

    • twoWayChannelRole

      public final String twoWayChannelRole()

      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.

    • selfManagedOptOutsEnabled

      public final 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, Amazon Pinpoint 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, Amazon Pinpoint 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.

    • optOutListName

      public final String optOutListName()

      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.

    • deletionProtectionEnabled

      public final Boolean deletionProtectionEnabled()

      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.

    • toBuilder

      public UpdatePhoneNumberRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<UpdatePhoneNumberRequest.Builder,UpdatePhoneNumberRequest>
      Specified by:
      toBuilder in class PinpointSmsVoiceV2Request
      Returns:
      a builder for type T

    • builder

      public static UpdatePhoneNumberRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdatePhoneNumberRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.