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

Interface GetMetricStatisticsRequest.Builder

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

  • Method Details

    • namespace

      GetMetricStatisticsRequest.Builder namespace(String namespace)

      The namespace of the metric, with or without spaces.

      Parameters:
      namespace - The namespace of the metric, with or without spaces.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • metricName

      GetMetricStatisticsRequest.Builder metricName(String metricName)

      The name of the metric, with or without spaces.

      Parameters:
      metricName - The name of the metric, with or without spaces.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dimensions

      GetMetricStatisticsRequest.Builder dimensions(Collection<Dimension> dimensions)

      The dimensions. If the metric contains multiple dimensions, you must include a value for each dimension. CloudWatch treats each unique combination of dimensions as a separate metric. If a specific combination of dimensions was not published, you can't retrieve statistics for it. You must specify the same dimensions that were used when the metrics were created. For an example, see Dimension Combinations in the Amazon CloudWatch User Guide. For more information about specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User Guide.

      Parameters:
      dimensions - The dimensions. If the metric contains multiple dimensions, you must include a value for each dimension. CloudWatch treats each unique combination of dimensions as a separate metric. If a specific combination of dimensions was not published, you can't retrieve statistics for it. You must specify the same dimensions that were used when the metrics were created. For an example, see Dimension Combinations in the Amazon CloudWatch User Guide. For more information about specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dimensions

      GetMetricStatisticsRequest.Builder dimensions(Dimension... dimensions)

      The dimensions. If the metric contains multiple dimensions, you must include a value for each dimension. CloudWatch treats each unique combination of dimensions as a separate metric. If a specific combination of dimensions was not published, you can't retrieve statistics for it. You must specify the same dimensions that were used when the metrics were created. For an example, see Dimension Combinations in the Amazon CloudWatch User Guide. For more information about specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User Guide.

      Parameters:
      dimensions - The dimensions. If the metric contains multiple dimensions, you must include a value for each dimension. CloudWatch treats each unique combination of dimensions as a separate metric. If a specific combination of dimensions was not published, you can't retrieve statistics for it. You must specify the same dimensions that were used when the metrics were created. For an example, see Dimension Combinations in the Amazon CloudWatch User Guide. For more information about specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dimensions

      GetMetricStatisticsRequest.Builder dimensions(Consumer<Dimension.Builder>... dimensions)

      The dimensions. If the metric contains multiple dimensions, you must include a value for each dimension. CloudWatch treats each unique combination of dimensions as a separate metric. If a specific combination of dimensions was not published, you can't retrieve statistics for it. You must specify the same dimensions that were used when the metrics were created. For an example, see Dimension Combinations in the Amazon CloudWatch User Guide. For more information about specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User Guide.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dimensions(List<Dimension>).

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

    • startTime

      GetMetricStatisticsRequest.Builder startTime(Instant startTime)

      The time stamp that determines the first data point to return. Start times are evaluated relative to the time that CloudWatch receives the request.

      The value specified is inclusive; results include data points with the specified time stamp. In a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for example, 2016-10-03T23:00:00Z).

      CloudWatch rounds the specified time stamp as follows:

      • Start time less than 15 days ago - Round down to the nearest whole minute. For example, 12:32:34 is rounded down to 12:32:00.

      • Start time between 15 and 63 days ago - Round down to the nearest 5-minute clock interval. For example, 12:32:34 is rounded down to 12:30:00.

      • Start time greater than 63 days ago - Round down to the nearest 1-hour clock interval. For example, 12:32:34 is rounded down to 12:00:00.

      If you set Period to 5, 10, or 30, the start time of your request is rounded down to the nearest time that corresponds to even 5-, 10-, or 30-second divisions of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the previous 10-second period, the start time of your request is rounded down and you receive data from 01:05:10 to 01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of data, using a period of 5 seconds, you receive data timestamped between 15:02:15 and 15:07:15.

      Parameters:
      startTime - The time stamp that determines the first data point to return. Start times are evaluated relative to the time that CloudWatch receives the request.

      The value specified is inclusive; results include data points with the specified time stamp. In a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for example, 2016-10-03T23:00:00Z).

      CloudWatch rounds the specified time stamp as follows:

      • Start time less than 15 days ago - Round down to the nearest whole minute. For example, 12:32:34 is rounded down to 12:32:00.

      • Start time between 15 and 63 days ago - Round down to the nearest 5-minute clock interval. For example, 12:32:34 is rounded down to 12:30:00.

      • Start time greater than 63 days ago - Round down to the nearest 1-hour clock interval. For example, 12:32:34 is rounded down to 12:00:00.

      If you set Period to 5, 10, or 30, the start time of your request is rounded down to the nearest time that corresponds to even 5-, 10-, or 30-second divisions of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the previous 10-second period, the start time of your request is rounded down and you receive data from 01:05:10 to 01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of data, using a period of 5 seconds, you receive data timestamped between 15:02:15 and 15:07:15.

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

    • endTime

      GetMetricStatisticsRequest.Builder endTime(Instant endTime)

      The time stamp that determines the last data point to return.

      The value specified is exclusive; results include data points up to the specified time stamp. In a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for example, 2016-10-10T23:00:00Z).

      Parameters:
      endTime - The time stamp that determines the last data point to return.

      The value specified is exclusive; results include data points up to the specified time stamp. In a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for example, 2016-10-10T23:00:00Z).

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

    • period

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

    • statisticsWithStrings

      GetMetricStatisticsRequest.Builder statisticsWithStrings(Collection<String> statistics)

      The metric statistics, other than percentile. For percentile statistics, use ExtendedStatistics. When calling GetMetricStatistics, you must specify either Statistics or ExtendedStatistics, but not both.

      Parameters:
      statistics - The metric statistics, other than percentile. For percentile statistics, use ExtendedStatistics. When calling GetMetricStatistics, you must specify either Statistics or ExtendedStatistics, but not both.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • statisticsWithStrings

      GetMetricStatisticsRequest.Builder statisticsWithStrings(String... statistics)

      The metric statistics, other than percentile. For percentile statistics, use ExtendedStatistics. When calling GetMetricStatistics, you must specify either Statistics or ExtendedStatistics, but not both.

      Parameters:
      statistics - The metric statistics, other than percentile. For percentile statistics, use ExtendedStatistics. When calling GetMetricStatistics, you must specify either Statistics or ExtendedStatistics, but not both.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • statistics

      GetMetricStatisticsRequest.Builder statistics(Collection<Statistic> statistics)

      The metric statistics, other than percentile. For percentile statistics, use ExtendedStatistics. When calling GetMetricStatistics, you must specify either Statistics or ExtendedStatistics, but not both.

      Parameters:
      statistics - The metric statistics, other than percentile. For percentile statistics, use ExtendedStatistics. When calling GetMetricStatistics, you must specify either Statistics or ExtendedStatistics, but not both.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • statistics

      GetMetricStatisticsRequest.Builder statistics(Statistic... statistics)

      The metric statistics, other than percentile. For percentile statistics, use ExtendedStatistics. When calling GetMetricStatistics, you must specify either Statistics or ExtendedStatistics, but not both.

      Parameters:
      statistics - The metric statistics, other than percentile. For percentile statistics, use ExtendedStatistics. When calling GetMetricStatistics, you must specify either Statistics or ExtendedStatistics, but not both.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • extendedStatistics

      GetMetricStatisticsRequest.Builder extendedStatistics(Collection<String> extendedStatistics)

      The percentile statistics. Specify values between p0.0 and p100. When calling GetMetricStatistics, you must specify either Statistics or ExtendedStatistics, but not both. Percentile statistics are not available for metrics when any of the metric values are negative numbers.

      Parameters:
      extendedStatistics - The percentile statistics. Specify values between p0.0 and p100. When calling GetMetricStatistics, you must specify either Statistics or ExtendedStatistics, but not both. Percentile statistics are not available for metrics when any of the metric values are negative numbers.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • extendedStatistics

      GetMetricStatisticsRequest.Builder extendedStatistics(String... extendedStatistics)

      The percentile statistics. Specify values between p0.0 and p100. When calling GetMetricStatistics, you must specify either Statistics or ExtendedStatistics, but not both. Percentile statistics are not available for metrics when any of the metric values are negative numbers.

      Parameters:
      extendedStatistics - The percentile statistics. Specify values between p0.0 and p100. When calling GetMetricStatistics, you must specify either Statistics or ExtendedStatistics, but not both. Percentile statistics are not available for metrics when any of the metric values are negative numbers.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • unit

      GetMetricStatisticsRequest.Builder unit(String unit)

      The unit for a given metric. If you omit Unit, 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 - The unit for a given metric. If you omit Unit, 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

      GetMetricStatisticsRequest.Builder unit(StandardUnit unit)

      The unit for a given metric. If you omit Unit, 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 - The unit for a given metric. If you omit Unit, 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:

    • overrideConfiguration

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

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