Interface DescribeRcsAgentsRequest.Builder

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

  • Method Details

    • rcsAgentIds

      DescribeRcsAgentsRequest.Builder rcsAgentIds(Collection<String> rcsAgentIds)

      An array of unique identifiers for the RCS agents. This is an array of strings that can be either the RcsAgentId or RcsAgentArn.

      Parameters:
      rcsAgentIds - An array of unique identifiers for the RCS agents. This is an array of strings that can be either the RcsAgentId or RcsAgentArn.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • rcsAgentIds

      DescribeRcsAgentsRequest.Builder rcsAgentIds(String... rcsAgentIds)

      An array of unique identifiers for the RCS agents. This is an array of strings that can be either the RcsAgentId or RcsAgentArn.

      Parameters:
      rcsAgentIds - An array of unique identifiers for the RCS agents. This is an array of strings that can be either the RcsAgentId or RcsAgentArn.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • owner

      DescribeRcsAgentsRequest.Builder owner(String owner)

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

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

      DescribeRcsAgentsRequest.Builder owner(Owner owner)

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

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

    • filters

      DescribeRcsAgentsRequest.Builder filters(Collection<RcsAgentFilter> filters)

      An array of RcsAgentFilter objects to filter the results.

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

    • filters

      DescribeRcsAgentsRequest.Builder filters(RcsAgentFilter... filters)

      An array of RcsAgentFilter objects to filter the results.

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

    • filters

      DescribeRcsAgentsRequest.Builder filters(Consumer<RcsAgentFilter.Builder>... filters)

      An array of RcsAgentFilter objects to filter the results.

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

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

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

    • nextToken

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

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

    • overrideConfiguration

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

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