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

Interface RequestPhoneNumberRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<RequestPhoneNumberRequest.Builder,RequestPhoneNumberRequest>, PinpointSmsVoiceV2Request.Builder, SdkBuilder<RequestPhoneNumberRequest.Builder,RequestPhoneNumberRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
RequestPhoneNumberRequest
public static interface RequestPhoneNumberRequest.Builder extends PinpointSmsVoiceV2Request.Builder, SdkPojo, CopyableBuilder<RequestPhoneNumberRequest.Builder,RequestPhoneNumberRequest>

  • Method Details

    • isoCountryCode

      RequestPhoneNumberRequest.Builder isoCountryCode(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.

    • messageType

      RequestPhoneNumberRequest.Builder messageType(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

      RequestPhoneNumberRequest.Builder messageType(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:

    • numberCapabilitiesWithStrings

      RequestPhoneNumberRequest.Builder numberCapabilitiesWithStrings(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.

    • numberCapabilitiesWithStrings

      RequestPhoneNumberRequest.Builder numberCapabilitiesWithStrings(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.

    • numberCapabilities

      RequestPhoneNumberRequest.Builder numberCapabilities(Collection<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.

    • numberCapabilities

      RequestPhoneNumberRequest.Builder numberCapabilities(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.

    • numberType

      RequestPhoneNumberRequest.Builder numberType(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:

    • numberType

      RequestPhoneNumberRequest.Builder numberType(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:

    • optOutListName

      RequestPhoneNumberRequest.Builder optOutListName(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.

    • poolId

      RequestPhoneNumberRequest.Builder poolId(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.

    • registrationId

      RequestPhoneNumberRequest.Builder registrationId(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.

    • deletionProtectionEnabled

      RequestPhoneNumberRequest.Builder deletionProtectionEnabled(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.

    • tags

      RequestPhoneNumberRequest.Builder tags(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.

    • tags

      RequestPhoneNumberRequest.Builder tags(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.

    • tags

      RequestPhoneNumberRequest.Builder tags(Consumer<Tag.Builder>... tags)

      An array of tags (key and value pairs) associate with the requested phone number.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • clientToken

      RequestPhoneNumberRequest.Builder clientToken(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.

    • overrideConfiguration

      RequestPhoneNumberRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      RequestPhoneNumberRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.