Package software.amazon.awssdk.services.applicationsignals.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 Id must be unique within a MetricDataQueries array. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the metric math 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 Id must be unique within a MetricDataQueries array. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the metric math 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)

      A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO.

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

      Parameters:
      metricStat - A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO.

      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)

      A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO.

      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 a metric math expression to be performed on the other metrics that you are retrieving within this MetricDataQueries structure.

      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 a metric math expression to be performed on the other metrics that you are retrieving within this MetricDataQueries structure.

      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)

      Use this only if you are using a metric math expression for the SLO. Specify true for ReturnData for only the one expression result to use as the alarm. For all other metrics and expressions in the same CreateServiceLevelObjective operation, specify ReturnData as false.

      Parameters:
      returnData - Use this only if you are using a metric math expression for the SLO. Specify true for ReturnData for only the one expression result to use as the alarm. For all other metrics and expressions in the same CreateServiceLevelObjective 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 this 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.

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

      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.

    • accountId

      MetricDataQuery.Builder accountId(String accountId)

      The ID of the account where this metric is located. If you are performing this operatiion in a monitoring account, use this to specify which source account to retrieve this metric from.

      Parameters:
      accountId - The ID of the account where this metric is located. If you are performing this operatiion in a monitoring account, use this to specify which source account to retrieve this metric from.
      Returns:
      Returns a reference to this object so that method calls can be chained together.