Interface DescribeSenderIdsRequest.Builder

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

  • Method Details

    • senderIds

      DescribeSenderIdsRequest.Builder senderIds(Collection<SenderIdAndCountry> senderIds)

      An array of SenderIdAndCountry objects to search for.

      If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

      Parameters:
      senderIds - An array of SenderIdAndCountry objects to search for.

      If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

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

    • senderIds

      DescribeSenderIdsRequest.Builder senderIds(SenderIdAndCountry... senderIds)

      An array of SenderIdAndCountry objects to search for.

      If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

      Parameters:
      senderIds - An array of SenderIdAndCountry objects to search for.

      If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

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

    • senderIds

      DescribeSenderIdsRequest.Builder senderIds(Consumer<SenderIdAndCountry.Builder>... senderIds)

      An array of SenderIdAndCountry objects to search for.

      If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

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

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

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

    • filters

      DescribeSenderIdsRequest.Builder filters(Collection<SenderIdFilter> filters)

      An array of SenderIdFilter objects to filter the results.

      Parameters:
      filters - An array of SenderIdFilter objects to filter the results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      DescribeSenderIdsRequest.Builder filters(SenderIdFilter... filters)

      An array of SenderIdFilter objects to filter the results.

      Parameters:
      filters - An array of SenderIdFilter objects to filter the results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      DescribeSenderIdsRequest.Builder filters(Consumer<SenderIdFilter.Builder>... filters)

      An array of SenderIdFilter objects to filter the results.

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

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

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

    • nextToken

      DescribeSenderIdsRequest.Builder nextToken(String nextToken)

      The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.

      Parameters:
      nextToken - The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      DescribeSenderIdsRequest.Builder maxResults(Integer maxResults)

      The maximum number of results to return per each request.

      Parameters:
      maxResults - The maximum number of results to return per each request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • owner

      DescribeSenderIdsRequest.Builder owner(String owner)

      Use SELF to filter the list of Sender Ids to ones your account owns or use SHARED to filter on Sender Ids shared with your account. The Owner and SenderIds parameters can't be used at the same time.

      Parameters:
      owner - Use SELF to filter the list of Sender Ids to ones your account owns or use SHARED to filter on Sender Ids shared with your account. The Owner and SenderIds parameters can't be used at the same time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • owner

      DescribeSenderIdsRequest.Builder owner(Owner owner)

      Use SELF to filter the list of Sender Ids to ones your account owns or use SHARED to filter on Sender Ids shared with your account. The Owner and SenderIds parameters can't be used at the same time.

      Parameters:
      owner - Use SELF to filter the list of Sender Ids to ones your account owns or use SHARED to filter on Sender Ids shared with your account. The Owner and SenderIds parameters can't be used at the same time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

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

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