Interface RequestSenderIdRequest.Builder

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

  • Method Details

    • senderId

      RequestSenderIdRequest.Builder senderId(String senderId)

      The sender ID string to request.

      Parameters:
      senderId - The sender ID string to request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • isoCountryCode

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

    • messageTypesWithStrings

      RequestSenderIdRequest.Builder messageTypesWithStrings(Collection<String> messageTypes)

      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:
      messageTypes - 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.

    • messageTypesWithStrings

      RequestSenderIdRequest.Builder messageTypesWithStrings(String... messageTypes)

      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:
      messageTypes - 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.

    • messageTypes

      RequestSenderIdRequest.Builder messageTypes(Collection<MessageType> messageTypes)

      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:
      messageTypes - 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.

    • messageTypes

      RequestSenderIdRequest.Builder messageTypes(MessageType... messageTypes)

      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:
      messageTypes - 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.

    • deletionProtectionEnabled

      RequestSenderIdRequest.Builder deletionProtectionEnabled(Boolean deletionProtectionEnabled)

      By default this is set to false. When set to true the sender ID can't be deleted.

      Parameters:
      deletionProtectionEnabled - By default this is set to false. When set to true the sender ID can't be deleted.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      RequestSenderIdRequest.Builder tags(Collection<Tag> tags)

      An array of tags (key and value pairs) to associate with the sender ID.

      Parameters:
      tags - An array of tags (key and value pairs) to associate with the sender ID.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      RequestSenderIdRequest.Builder tags(Tag... tags)

      An array of tags (key and value pairs) to associate with the sender ID.

      Parameters:
      tags - An array of tags (key and value pairs) to associate with the sender ID.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

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

      An array of tags (key and value pairs) to associate with the sender ID.

      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

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

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

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