commonMain.aws.sdk.kotlin.services.applicationsignals.model.MetricDataQuery.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of applicationsignals-jvm Show documentation
Show all versions of applicationsignals-jvm Show documentation
The AWS SDK for Kotlin client for Application Signals
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!
package aws.sdk.kotlin.services.applicationsignals.model
import aws.smithy.kotlin.runtime.SdkDsl
/**
* Use this structure to define a metric or metric math expression that you want to use as for a service level objective.
*
* Each `MetricDataQuery` in the `MetricDataQueries` array specifies either a metric to retrieve, or a metric math expression to be performed on retrieved metrics. A single `MetricDataQueries` array can include as many as 20 `MetricDataQuery` structures in the array. The 20 structures can include as many as 10 structures that contain a `MetricStat` parameter to retrieve a metric, and as many as 10 structures that contain the `Expression` parameter to perform a math expression. Of those `Expression` structures, exactly one must have true as the value for `ReturnData`. The result of this expression used for the SLO.
*
* For more information about metric math expressions, see [CloudWatchUse metric math](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html).
*
* Within each `MetricDataQuery` object, you must specify either `Expression` or `MetricStat` but not both.
*/
public class MetricDataQuery private constructor(builder: Builder) {
/**
* 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.
*/
public val accountId: kotlin.String? = builder.accountId
/**
* 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](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) in the *Amazon CloudWatch User Guide*.
*
* Within each `MetricDataQuery` object, you must specify either `Expression` or `MetricStat` but not both.
*/
public val expression: kotlin.String? = builder.expression
/**
* 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.
*/
public val id: kotlin.String = requireNotNull(builder.id) { "A non-null value must be provided for id" }
/**
* 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](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html).
*/
public val label: kotlin.String? = builder.label
/**
* 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.
*/
public val metricStat: aws.sdk.kotlin.services.applicationsignals.model.MetricStat? = builder.metricStat
/**
* 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).
*/
public val period: kotlin.Int? = builder.period
/**
* 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`.
*/
public val returnData: kotlin.Boolean? = builder.returnData
public companion object {
public operator fun invoke(block: Builder.() -> kotlin.Unit): aws.sdk.kotlin.services.applicationsignals.model.MetricDataQuery = Builder().apply(block).build()
}
override fun toString(): kotlin.String = buildString {
append("MetricDataQuery(")
append("accountId=$accountId,")
append("expression=$expression,")
append("id=$id,")
append("label=$label,")
append("metricStat=$metricStat,")
append("period=$period,")
append("returnData=$returnData")
append(")")
}
override fun hashCode(): kotlin.Int {
var result = accountId?.hashCode() ?: 0
result = 31 * result + (expression?.hashCode() ?: 0)
result = 31 * result + (id.hashCode())
result = 31 * result + (label?.hashCode() ?: 0)
result = 31 * result + (metricStat?.hashCode() ?: 0)
result = 31 * result + (period ?: 0)
result = 31 * result + (returnData?.hashCode() ?: 0)
return result
}
override fun equals(other: kotlin.Any?): kotlin.Boolean {
if (this === other) return true
if (other == null || this::class != other::class) return false
other as MetricDataQuery
if (accountId != other.accountId) return false
if (expression != other.expression) return false
if (id != other.id) return false
if (label != other.label) return false
if (metricStat != other.metricStat) return false
if (period != other.period) return false
if (returnData != other.returnData) return false
return true
}
public inline fun copy(block: Builder.() -> kotlin.Unit = {}): aws.sdk.kotlin.services.applicationsignals.model.MetricDataQuery = Builder(this).apply(block).build()
@SdkDsl
public class Builder {
/**
* 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.
*/
public var accountId: kotlin.String? = null
/**
* 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](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) in the *Amazon CloudWatch User Guide*.
*
* Within each `MetricDataQuery` object, you must specify either `Expression` or `MetricStat` but not both.
*/
public var expression: kotlin.String? = null
/**
* 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.
*/
public var id: kotlin.String? = null
/**
* 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](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html).
*/
public var label: kotlin.String? = null
/**
* 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.
*/
public var metricStat: aws.sdk.kotlin.services.applicationsignals.model.MetricStat? = null
/**
* 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).
*/
public var period: kotlin.Int? = null
/**
* 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`.
*/
public var returnData: kotlin.Boolean? = null
@PublishedApi
internal constructor()
@PublishedApi
internal constructor(x: aws.sdk.kotlin.services.applicationsignals.model.MetricDataQuery) : this() {
this.accountId = x.accountId
this.expression = x.expression
this.id = x.id
this.label = x.label
this.metricStat = x.metricStat
this.period = x.period
this.returnData = x.returnData
}
@PublishedApi
internal fun build(): aws.sdk.kotlin.services.applicationsignals.model.MetricDataQuery = MetricDataQuery(this)
/**
* construct an [aws.sdk.kotlin.services.applicationsignals.model.MetricStat] inside the given [block]
*/
public fun metricStat(block: aws.sdk.kotlin.services.applicationsignals.model.MetricStat.Builder.() -> kotlin.Unit) {
this.metricStat = aws.sdk.kotlin.services.applicationsignals.model.MetricStat.invoke(block)
}
internal fun correctErrors(): Builder {
if (id == null) id = ""
return this
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy