Interface ListScrapersRequest.Builder

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

  • Method Details

    • filters

      ListScrapersRequest.Builder filters(Map<String,? extends Collection<String>> filters)

      (Optional) A list of key-value pairs to filter the list of scrapers returned. Keys include status, sourceArn, destinationArn, and alias.

      Filters on the same key are OR'd together, and filters on different keys are AND'd together. For example, status=ACTIVE&status=CREATING&alias=Test, will return all scrapers that have the alias Test, and are either in status ACTIVE or CREATING.

      To find all active scrapers that are sending metrics to a specific Amazon Managed Service for Prometheus workspace, you would use the ARN of the workspace in a query:

      status=ACTIVE&destinationArn=arn:aws:aps:us-east-1:123456789012:workspace/ws-example1-1234-abcd-56ef-123456789012

      If this is included, it filters the results to only the scrapers that match the filter.

      Parameters:
      filters - (Optional) A list of key-value pairs to filter the list of scrapers returned. Keys include status, sourceArn, destinationArn, and alias.

      Filters on the same key are OR'd together, and filters on different keys are AND'd together. For example, status=ACTIVE&status=CREATING&alias=Test, will return all scrapers that have the alias Test, and are either in status ACTIVE or CREATING.

      To find all active scrapers that are sending metrics to a specific Amazon Managed Service for Prometheus workspace, you would use the ARN of the workspace in a query:

      status=ACTIVE&destinationArn=arn:aws:aps:us-east-1:123456789012:workspace/ws-example1-1234-abcd-56ef-123456789012

      If this is included, it filters the results to only the scrapers that match the filter.

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

    • maxResults

      ListScrapersRequest.Builder maxResults(Integer maxResults)

      Optional) The maximum number of scrapers to return in one ListScrapers operation. The range is 1-1000.

      If you omit this parameter, the default of 100 is used.

      Parameters:
      maxResults - Optional) The maximum number of scrapers to return in one ListScrapers operation. The range is 1-1000.

      If you omit this parameter, the default of 100 is used.

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

    • nextToken

      ListScrapersRequest.Builder nextToken(String nextToken)

      (Optional) The token for the next set of items to return. (You received this token from a previous call.)

      Parameters:
      nextToken - (Optional) The token for the next set of items to return. (You received this token from a previous call.)
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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