Package software.amazon.awssdk.services.lightsail.model

Interface GetContainerServiceMetricDataRequest.Builder

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

  • Method Details

    • serviceName

      GetContainerServiceMetricDataRequest.Builder serviceName(String serviceName)

      The name of the container service for which to get metric data.

      Parameters:
      serviceName - The name of the container service for which to get metric data.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • metricName

      GetContainerServiceMetricDataRequest.Builder metricName(String metricName)

      The metric for which you want to return information.

      Valid container service metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.

      • CPUUtilization - The average percentage of compute units that are currently in use across all nodes of the container service. This metric identifies the processing power required to run containers on each node of the container service.

        Statistics: The most useful statistics are Maximum and Average.

        Unit: The published unit is Percent.

      • MemoryUtilization - The average percentage of available memory that is currently in use across all nodes of the container service. This metric identifies the memory required to run containers on each node of the container service.

        Statistics: The most useful statistics are Maximum and Average.

        Unit: The published unit is Percent.

      Parameters:
      metricName - The metric for which you want to return information.

      Valid container service metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.

      • CPUUtilization - The average percentage of compute units that are currently in use across all nodes of the container service. This metric identifies the processing power required to run containers on each node of the container service.

        Statistics: The most useful statistics are Maximum and Average.

        Unit: The published unit is Percent.

      • MemoryUtilization - The average percentage of available memory that is currently in use across all nodes of the container service. This metric identifies the memory required to run containers on each node of the container service.

        Statistics: The most useful statistics are Maximum and Average.

        Unit: The published unit is Percent.

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

    • metricName

      GetContainerServiceMetricDataRequest.Builder metricName(ContainerServiceMetricName metricName)

      The metric for which you want to return information.

      Valid container service metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.

      • CPUUtilization - The average percentage of compute units that are currently in use across all nodes of the container service. This metric identifies the processing power required to run containers on each node of the container service.

        Statistics: The most useful statistics are Maximum and Average.

        Unit: The published unit is Percent.

      • MemoryUtilization - The average percentage of available memory that is currently in use across all nodes of the container service. This metric identifies the memory required to run containers on each node of the container service.

        Statistics: The most useful statistics are Maximum and Average.

        Unit: The published unit is Percent.

      Parameters:
      metricName - The metric for which you want to return information.

      Valid container service metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.

      • CPUUtilization - The average percentage of compute units that are currently in use across all nodes of the container service. This metric identifies the processing power required to run containers on each node of the container service.

        Statistics: The most useful statistics are Maximum and Average.

        Unit: The published unit is Percent.

      • MemoryUtilization - The average percentage of available memory that is currently in use across all nodes of the container service. This metric identifies the memory required to run containers on each node of the container service.

        Statistics: The most useful statistics are Maximum and Average.

        Unit: The published unit is Percent.

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

    • startTime

      GetContainerServiceMetricDataRequest.Builder startTime(Instant startTime)

      The start time of the time period.

      Parameters:
      startTime - The start time of the time period.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endTime

      GetContainerServiceMetricDataRequest.Builder endTime(Instant endTime)

      The end time of the time period.

      Parameters:
      endTime - The end time of the time period.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • period

      GetContainerServiceMetricDataRequest.Builder period(Integer period)

      The granularity, in seconds, of the returned data points.

      All container service metric data is available in 5-minute (300 seconds) granularity.

      Parameters:
      period - The granularity, in seconds, of the returned data points.

      All container service metric data is available in 5-minute (300 seconds) granularity.

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

    • statisticsWithStrings

      GetContainerServiceMetricDataRequest.Builder statisticsWithStrings(Collection<String> statistics)

      The statistic for the metric.

      The following statistics are available:

      • Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.

      • Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.

      • Sum - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric.

      • Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.

      • SampleCount - The count, or number, of data points used for the statistical calculation.

      Parameters:
      statistics - The statistic for the metric.

      The following statistics are available:

      • Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.

      • Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.

      • Sum - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric.

      • Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.

      • SampleCount - The count, or number, of data points used for the statistical calculation.

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

    • statisticsWithStrings

      GetContainerServiceMetricDataRequest.Builder statisticsWithStrings(String... statistics)

      The statistic for the metric.

      The following statistics are available:

      • Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.

      • Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.

      • Sum - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric.

      • Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.

      • SampleCount - The count, or number, of data points used for the statistical calculation.

      Parameters:
      statistics - The statistic for the metric.

      The following statistics are available:

      • Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.

      • Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.

      • Sum - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric.

      • Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.

      • SampleCount - The count, or number, of data points used for the statistical calculation.

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

    • statistics

      GetContainerServiceMetricDataRequest.Builder statistics(Collection<MetricStatistic> statistics)

      The statistic for the metric.

      The following statistics are available:

      • Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.

      • Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.

      • Sum - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric.

      • Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.

      • SampleCount - The count, or number, of data points used for the statistical calculation.

      Parameters:
      statistics - The statistic for the metric.

      The following statistics are available:

      • Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.

      • Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.

      • Sum - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric.

      • Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.

      • SampleCount - The count, or number, of data points used for the statistical calculation.

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

    • statistics

      GetContainerServiceMetricDataRequest.Builder statistics(MetricStatistic... statistics)

      The statistic for the metric.

      The following statistics are available:

      • Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.

      • Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.

      • Sum - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric.

      • Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.

      • SampleCount - The count, or number, of data points used for the statistical calculation.

      Parameters:
      statistics - The statistic for the metric.

      The following statistics are available:

      • Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.

      • Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.

      • Sum - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric.

      • Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.

      • SampleCount - The count, or number, of data points used for the statistical calculation.

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

    • overrideConfiguration

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

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