Interface MetricStat.Builder

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

  • Method Details

    • metric

      MetricStat.Builder metric(Metric metric)

      The metric to use as the service level indicator, including the metric name, namespace, and dimensions.

      Parameters:
      metric - The metric to use as the service level indicator, including the metric name, namespace, and dimensions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • metric

      default MetricStat.Builder metric(Consumer<Metric.Builder> metric)

      The metric to use as the service level indicator, including the metric name, namespace, and dimensions.

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

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

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

    • period

      MetricStat.Builder period(Integer period)

      The granularity, in seconds, to be used for the metric. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.

      Parameters:
      period - The granularity, in seconds, to be used for the metric. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • stat

      MetricStat.Builder stat(String stat)

      The statistic to use for comparison to the threshold. It can be any CloudWatch statistic or extended statistic. For more information about statistics, see CloudWatch statistics definitions.

      Parameters:
      stat - The statistic to use for comparison to the threshold. It can be any CloudWatch statistic or extended statistic. For more information about statistics, see CloudWatch statistics definitions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • unit

      MetricStat.Builder unit(String unit)

      If you omit Unit then all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

      Parameters:
      unit - If you omit Unit then all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • unit

      MetricStat.Builder unit(StandardUnit unit)

      If you omit Unit then all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

      Parameters:
      unit - If you omit Unit then all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: