Package software.amazon.awssdk.services.amp.model

Interface ScraperDescription.Builder

All Superinterfaces:
Buildable, CopyableBuilder<ScraperDescription.Builder,ScraperDescription>, SdkBuilder<ScraperDescription.Builder,ScraperDescription>, SdkPojo
Enclosing class:
ScraperDescription
public static interface ScraperDescription.Builder extends SdkPojo, CopyableBuilder<ScraperDescription.Builder,ScraperDescription>

  • Method Details

    • alias

      ScraperDescription.Builder alias(String alias)

      (Optional) A name associated with the scraper.

      Parameters:
      alias - (Optional) A name associated with the scraper.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • arn

      ScraperDescription.Builder arn(String arn)

      The Amazon Resource Name (ARN) of the scraper.

      Parameters:
      arn - The Amazon Resource Name (ARN) of the scraper.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • createdAt

      ScraperDescription.Builder createdAt(Instant createdAt)

      The date and time that the scraper was created.

      Parameters:
      createdAt - The date and time that the scraper was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • destination

      ScraperDescription.Builder destination(Destination destination)

      The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.

      Parameters:
      destination - The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • destination

      default ScraperDescription.Builder destination(Consumer<Destination.Builder> destination)

      The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to destination(Destination).

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

    • lastModifiedAt

      ScraperDescription.Builder lastModifiedAt(Instant lastModifiedAt)

      The date and time that the scraper was last modified.

      Parameters:
      lastModifiedAt - The date and time that the scraper was last modified.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • roleArn

      ScraperDescription.Builder roleArn(String roleArn)

      The Amazon Resource Name (ARN) of the IAM role that provides permissions for the scraper to discover and collect metrics on your behalf.

      Parameters:
      roleArn - The Amazon Resource Name (ARN) of the IAM role that provides permissions for the scraper to discover and collect metrics on your behalf.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scrapeConfiguration

      ScraperDescription.Builder scrapeConfiguration(ScrapeConfiguration scrapeConfiguration)

      The configuration file in use by the scraper.

      Parameters:
      scrapeConfiguration - The configuration file in use by the scraper.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scrapeConfiguration

      default ScraperDescription.Builder scrapeConfiguration(Consumer<ScrapeConfiguration.Builder> scrapeConfiguration)

      The configuration file in use by the scraper.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to scrapeConfiguration(ScrapeConfiguration).

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

    • scraperId

      ScraperDescription.Builder scraperId(String scraperId)

      The ID of the scraper.

      Parameters:
      scraperId - The ID of the scraper.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • source

      ScraperDescription.Builder source(Source source)

      The Amazon EKS cluster from which the scraper collects metrics.

      Parameters:
      source - The Amazon EKS cluster from which the scraper collects metrics.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • source

      default ScraperDescription.Builder source(Consumer<Source.Builder> source)

      The Amazon EKS cluster from which the scraper collects metrics.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to source(Source).

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

    • status

      ScraperDescription.Builder status(ScraperStatus status)

      A structure that contains the current status of the scraper.

      Parameters:
      status - A structure that contains the current status of the scraper.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      default ScraperDescription.Builder status(Consumer<ScraperStatus.Builder> status)

      A structure that contains the current status of the scraper.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to status(ScraperStatus).

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

    • statusReason

      ScraperDescription.Builder statusReason(String statusReason)

      If there is a failure, the reason for the failure.

      Parameters:
      statusReason - If there is a failure, the reason for the failure.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      ScraperDescription.Builder tags(Map<String,String> tags)

      (Optional) The list of tag keys and values associated with the scraper.

      Parameters:
      tags - (Optional) The list of tag keys and values associated with the scraper.
      Returns:
      Returns a reference to this object so that method calls can be chained together.