Package software.amazon.awssdk.services.cloudwatch.model

Interface MetricStat.Builder

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

  • Method Details

    • metric

      MetricStat.Builder metric(Metric metric)

      The metric to return, including the metric name, namespace, and dimensions.

      Parameters:
      metric - The metric to return, 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 return, 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, of the returned data points. 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.

      If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:

      • Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).

      • Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).

      • Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).

      Parameters:
      period - The granularity, in seconds, of the returned data points. 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.

      If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:

      • Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).

      • Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).

      • Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).

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

    • stat

      MetricStat.Builder stat(String stat)

      The statistic to return. It can include any CloudWatch statistic or extended statistic.

      Parameters:
      stat - The statistic to return. It can include any CloudWatch statistic or extended statistic.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • unit

      MetricStat.Builder unit(String unit)

      When you are using a Put operation, this defines what unit you want to use when storing the metric.

      In a Get operation, 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 - When you are using a Put operation, this defines what unit you want to use when storing the metric.

      In a Get operation, 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)

      When you are using a Put operation, this defines what unit you want to use when storing the metric.

      In a Get operation, 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 - When you are using a Put operation, this defines what unit you want to use when storing the metric.

      In a Get operation, 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: