Interface DescribePhoneNumbersRequest.Builder

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

  • Method Details

    • phoneNumberIds

      DescribePhoneNumbersRequest.Builder phoneNumberIds(Collection<String> phoneNumberIds)

      The unique identifier of phone numbers to find information about. This is an array of strings that can be either the PhoneNumberId or PhoneNumberArn.

      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:
      phoneNumberIds - The unique identifier of phone numbers to find information about. This is an array of strings that can be either the PhoneNumberId or PhoneNumberArn.

      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.

    • phoneNumberIds

      DescribePhoneNumbersRequest.Builder phoneNumberIds(String... phoneNumberIds)

      The unique identifier of phone numbers to find information about. This is an array of strings that can be either the PhoneNumberId or PhoneNumberArn.

      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:
      phoneNumberIds - The unique identifier of phone numbers to find information about. This is an array of strings that can be either the PhoneNumberId or PhoneNumberArn.

      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.

    • filters

      DescribePhoneNumbersRequest.Builder filters(Collection<PhoneNumberFilter> filters)

      An array of PhoneNumberFilter objects to filter the results.

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

    • filters

      DescribePhoneNumbersRequest.Builder filters(PhoneNumberFilter... filters)

      An array of PhoneNumberFilter objects to filter the results.

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

    • filters

      DescribePhoneNumbersRequest.Builder filters(Consumer<PhoneNumberFilter.Builder>... filters)

      An array of PhoneNumberFilter objects to filter the results.

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

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

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

    • nextToken

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

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

      DescribePhoneNumbersRequest.Builder owner(String owner)

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

      Parameters:
      owner - Use SELF to filter the list of phone numbers to ones your account owns or use SHARED to filter on phone numbers shared with your account. The Owner and PhoneNumberIds 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

      DescribePhoneNumbersRequest.Builder owner(Owner owner)

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

      Parameters:
      owner - Use SELF to filter the list of phone numbers to ones your account owns or use SHARED to filter on phone numbers shared with your account. The Owner and PhoneNumberIds 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

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

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