Interface DescribeAgentsRequest.Builder

All Superinterfaces:
ApplicationDiscoveryRequest.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<DescribeAgentsRequest.Builder,DescribeAgentsRequest>, SdkBuilder<DescribeAgentsRequest.Builder,DescribeAgentsRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
DescribeAgentsRequest
public static interface DescribeAgentsRequest.Builder extends ApplicationDiscoveryRequest.Builder, SdkPojo, CopyableBuilder<DescribeAgentsRequest.Builder,DescribeAgentsRequest>

  • Method Details

    • agentIds

      DescribeAgentsRequest.Builder agentIds(Collection<String> agentIds)

      The agent or the collector IDs for which you want information. If you specify no IDs, the system returns information about all agents/collectors associated with your user.

      Parameters:
      agentIds - The agent or the collector IDs for which you want information. If you specify no IDs, the system returns information about all agents/collectors associated with your user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • agentIds

      DescribeAgentsRequest.Builder agentIds(String... agentIds)

      The agent or the collector IDs for which you want information. If you specify no IDs, the system returns information about all agents/collectors associated with your user.

      Parameters:
      agentIds - The agent or the collector IDs for which you want information. If you specify no IDs, the system returns information about all agents/collectors associated with your user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      DescribeAgentsRequest.Builder filters(Collection<Filter> filters)

      You can filter the request using various logical operators and a key-value format. For example:

      {"key": "collectionStatus", "value": "STARTED"}

      Parameters:
      filters - You can filter the request using various logical operators and a key-value format. For example:

      {"key": "collectionStatus", "value": "STARTED"}

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

    • filters

      DescribeAgentsRequest.Builder filters(Filter... filters)

      You can filter the request using various logical operators and a key-value format. For example:

      {"key": "collectionStatus", "value": "STARTED"}

      Parameters:
      filters - You can filter the request using various logical operators and a key-value format. For example:

      {"key": "collectionStatus", "value": "STARTED"}

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

    • filters

      DescribeAgentsRequest.Builder filters(Consumer<Filter.Builder>... filters)

      You can filter the request using various logical operators and a key-value format. For example:

      {"key": "collectionStatus", "value": "STARTED"}

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

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

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

    • maxResults

      DescribeAgentsRequest.Builder maxResults(Integer maxResults)

      The total number of agents/collectors to return in a single page of output. The maximum value is 100.

      Parameters:
      maxResults - The total number of agents/collectors to return in a single page of output. The maximum value is 100.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      DescribeAgentsRequest.Builder nextToken(String nextToken)

      Token to retrieve the next set of results. For example, if you previously specified 100 IDs for DescribeAgentsRequest$agentIds but set DescribeAgentsRequest$maxResults to 10, you received a set of 10 results along with a token. Use that token in this query to get the next set of 10.

      Parameters:
      nextToken - Token to retrieve the next set of results. For example, if you previously specified 100 IDs for DescribeAgentsRequest$agentIds but set DescribeAgentsRequest$maxResults to 10, you received a set of 10 results along with a token. Use that token in this query to get the next set of 10.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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