Interface DescribePoolsRequest.Builder

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

  • Method Details

    • poolIds

      DescribePoolsRequest.Builder poolIds(Collection<String> poolIds)

      The unique identifier of pools to find. This is an array of strings that can be either the PoolId or PoolArn.

      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:
      poolIds - The unique identifier of pools to find. This is an array of strings that can be either the PoolId or PoolArn.

      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.

    • poolIds

      DescribePoolsRequest.Builder poolIds(String... poolIds)

      The unique identifier of pools to find. This is an array of strings that can be either the PoolId or PoolArn.

      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:
      poolIds - The unique identifier of pools to find. This is an array of strings that can be either the PoolId or PoolArn.

      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

      DescribePoolsRequest.Builder filters(Collection<PoolFilter> filters)

      An array of PoolFilter objects to filter the results.

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

    • filters

      DescribePoolsRequest.Builder filters(PoolFilter... filters)

      An array of PoolFilter objects to filter the results.

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

    • filters

      DescribePoolsRequest.Builder filters(Consumer<PoolFilter.Builder>... filters)

      An array of PoolFilter objects to filter the results.

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

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

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

    • nextToken

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

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

      DescribePoolsRequest.Builder owner(String owner)

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

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

      DescribePoolsRequest.Builder owner(Owner owner)

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

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

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

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