Interface MetricDataQuery.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<MetricDataQuery.Builder,
,MetricDataQuery> SdkBuilder<MetricDataQuery.Builder,
,MetricDataQuery> SdkPojo
- Enclosing class:
MetricDataQuery
-
Method Summary
Modifier and TypeMethodDescriptionexpression
(String expression) The math expression to perform on the returned data, if this object is performing a math expression.A short name that identifies the object's results in the response.A human-readable label for this metric or expression.default MetricDataQuery.Builder
metricStat
(Consumer<MetricStat.Builder> metricStat) Information about the metric data to return.metricStat
(MetricStat metricStat) Information about the metric data to return.returnData
(Boolean returnData) Indicates whether to return the timestamps and raw data values of this metric.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
id
A short name that identifies the object's results in the response. This name must be unique among all
MetricDataQuery
objects specified for a single scaling policy. 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 underscores. The first character must be a lowercase letter.- Parameters:
id
- A short name that identifies the object's results in the response. This name must be unique among allMetricDataQuery
objects specified for a single scaling policy. 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 underscores. The first character must be a lowercase letter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
expression
The math expression to perform on the returned data, if this object is performing a math expression. This expression can use the
Id
of the other metrics to refer to those metrics, and can also use theId
of other expressions to use the result of those expressions.Conditional: Within each
MetricDataQuery
object, you must specify eitherExpression
orMetricStat
, but not both.- Parameters:
expression
- The math expression to perform on the returned data, if this object is performing a math expression. This expression can use theId
of the other metrics to refer to those metrics, and can also use theId
of other expressions to use the result of those expressions.Conditional: Within each
MetricDataQuery
object, you must specify eitherExpression
orMetricStat
, but not both.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
metricStat
Information about the metric data to return.
Conditional: Within each
MetricDataQuery
object, you must specify eitherExpression
orMetricStat
, but not both.- Parameters:
metricStat
- Information about the metric data to return.Conditional: Within each
MetricDataQuery
object, you must specify eitherExpression
orMetricStat
, but not both.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
metricStat
Information about the metric data to return.
Conditional: Within each
This is a convenience method that creates an instance of theMetricDataQuery
object, you must specify eitherExpression
orMetricStat
, but not both.MetricStat.Builder
avoiding the need to create one manually viaMetricStat.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tometricStat(MetricStat)
.- Parameters:
metricStat
- a consumer that will call methods onMetricStat.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
label
A human-readable label for this metric or expression. This is especially useful if this is a math expression, so that you know what the value represents.
- Parameters:
label
- A human-readable label for this metric or expression. This is especially useful if this is a math expression, so that you know what the value represents.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
returnData
Indicates whether to return the timestamps and raw data values of this metric.
If you use any math expressions, specify
true
for this value for only the final math expression that the metric specification is based on. You must specifyfalse
forReturnData
for all the other metrics and expressions used in the metric specification.If you are only retrieving metrics and not performing any math expressions, do not specify anything for
ReturnData
. This sets it to its default (true
).- Parameters:
returnData
- Indicates whether to return the timestamps and raw data values of this metric.If you use any math expressions, specify
true
for this value for only the final math expression that the metric specification is based on. You must specifyfalse
forReturnData
for all the other metrics and expressions used in the metric specification.If you are only retrieving metrics and not performing any math expressions, do not specify anything for
ReturnData
. This sets it to its default (true
).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-