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

Interface MetricDataQuery.Builder

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

  • Method Details

    • id

      MetricDataQuery.Builder id(String id)

      A short name used to tie this object to the results in the response. This name must be unique within a single call to GetMetricData. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.

      Parameters:
      id - A short name used to tie this object to the results in the response. This name must be unique within a single call to GetMetricData. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • metricStat

      MetricDataQuery.Builder metricStat(MetricStat metricStat)

      The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data.

      Within one MetricDataQuery object, you must specify either Expression or MetricStat but not both.

      Parameters:
      metricStat - The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data.

      Within one MetricDataQuery object, you must specify either Expression or MetricStat but not both.

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

    • metricStat

      default MetricDataQuery.Builder metricStat(Consumer<MetricStat.Builder> metricStat)

      The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data.

      Within one MetricDataQuery object, you must specify either Expression or MetricStat but not both.

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

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

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

    • expression

      MetricDataQuery.Builder expression(String expression)

      This field can contain either a Metrics Insights query, or a metric math expression to be performed on the returned data. For more information about Metrics Insights queries, see Metrics Insights query components and syntax in the Amazon CloudWatch User Guide.

      A math expression can use the Id of the other metrics or queries to refer to those metrics, and can also use the Id of other expressions to use the result of those expressions. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.

      Within each MetricDataQuery object, you must specify either Expression or MetricStat but not both.

      Parameters:
      expression - This field can contain either a Metrics Insights query, or a metric math expression to be performed on the returned data. For more information about Metrics Insights queries, see Metrics Insights query components and syntax in the Amazon CloudWatch User Guide.

      A math expression can use the Id of the other metrics or queries to refer to those metrics, and can also use the Id of other expressions to use the result of those expressions. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.

      Within each MetricDataQuery object, you must specify either Expression or MetricStat but not both.

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

    • label

      MetricDataQuery.Builder label(String label)

      A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know what the value represents. If the metric or expression is shown in a CloudWatch dashboard widget, the label is shown. If Label is omitted, CloudWatch generates a default.

      You can put dynamic expressions into a label, so that it is more descriptive. For more information, see Using Dynamic Labels.

      Parameters:
      label - A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know what the value represents. If the metric or expression is shown in a CloudWatch dashboard widget, the label is shown. If Label is omitted, CloudWatch generates a default.

      You can put dynamic expressions into a label, so that it is more descriptive. For more information, see Using Dynamic Labels.

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

    • returnData

      MetricDataQuery.Builder returnData(Boolean returnData)

      When used in GetMetricData, this option indicates whether to return the timestamps and raw data values of this metric. If you are performing this call just to do math expressions and do not also need the raw data returned, you can specify false. If you omit this, the default of true is used.

      When used in PutMetricAlarm, specify true for the one expression result to use as the alarm. For all other metrics and expressions in the same PutMetricAlarm operation, specify ReturnData as False.

      Parameters:
      returnData - When used in GetMetricData, this option indicates whether to return the timestamps and raw data values of this metric. If you are performing this call just to do math expressions and do not also need the raw data returned, you can specify false. If you omit this, the default of true is used.

      When used in PutMetricAlarm, specify true for the one expression result to use as the alarm. For all other metrics and expressions in the same PutMetricAlarm operation, specify ReturnData as False.

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

    • period

      MetricDataQuery.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 operation that includes a StorageResolution of 1 second.

      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 operation that includes a StorageResolution of 1 second.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • accountId

      MetricDataQuery.Builder accountId(String accountId)

      The ID of the account where the metrics are located.

      If you are performing a GetMetricData operation in a monitoring account, use this to specify which account to retrieve this metric from.

      If you are performing a PutMetricAlarm operation, use this to specify which account contains the metric that the alarm is watching.

      Parameters:
      accountId - The ID of the account where the metrics are located.

      If you are performing a GetMetricData operation in a monitoring account, use this to specify which account to retrieve this metric from.

      If you are performing a PutMetricAlarm operation, use this to specify which account contains the metric that the alarm is watching.

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