commonMain.aws.sdk.kotlin.services.computeoptimizer.model.EcsServiceUtilizationMetric.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of computeoptimizer-jvm Show documentation
The AWS SDK for Kotlin client for Compute Optimizer
There is a newer version: 1.3.76
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!

package aws.sdk.kotlin.services.computeoptimizer.model

import aws.smithy.kotlin.runtime.SdkDsl

/**
 * Describes the utilization metric of an Amazon ECS service.
 *
 * To determine the performance difference between your current Amazon ECS service and the recommended option, compare the utilization metric data of your service against its projected utilization metric data.
 */
public class EcsServiceUtilizationMetric private constructor(builder: Builder) {
    /**
     * The name of the utilization metric.
     *
     * The following utilization metrics are available:
     * + `Cpu` — The amount of CPU capacity that's used in the service.
     * + `Memory` — The amount of memory that's used in the service.
     */
    public val name: aws.sdk.kotlin.services.computeoptimizer.model.EcsServiceMetricName? = builder.name
    /**
     * The statistic of the utilization metric.
     *
     * The Compute Optimizer API, Command Line Interface (CLI), and SDKs return utilization metrics using only the `Maximum` statistic, which is the highest value observed during the specified period.
     *
     * The Compute Optimizer console displays graphs for some utilization metrics using the `Average` statistic, which is the value of `Sum` / `SampleCount` during the specified period. For more information, see [Viewing resource recommendations](https://docs.aws.amazon.com/compute-optimizer/latest/ug/viewing-recommendations.html) in the *Compute Optimizer User Guide*. You can also get averaged utilization metric data for your resources using Amazon CloudWatch. For more information, see the [Amazon CloudWatch User Guide](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html).
     */
    public val statistic: aws.sdk.kotlin.services.computeoptimizer.model.EcsServiceMetricStatistic? = builder.statistic
    /**
     * The value of the utilization metric.
     */
    public val value: kotlin.Double = builder.value

    public companion object {
        public operator fun invoke(block: Builder.() -> kotlin.Unit): aws.sdk.kotlin.services.computeoptimizer.model.EcsServiceUtilizationMetric = Builder().apply(block).build()
    }

    override fun toString(): kotlin.String = buildString {
        append("EcsServiceUtilizationMetric(")
        append("name=$name,")
        append("statistic=$statistic,")
        append("value=$value")
        append(")")
    }

    override fun hashCode(): kotlin.Int {
        var result = name?.hashCode() ?: 0
        result = 31 * result + (statistic?.hashCode() ?: 0)
        result = 31 * result + (value.hashCode())
        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 EcsServiceUtilizationMetric

        if (name != other.name) return false
        if (statistic != other.statistic) return false
        if (!(value?.equals(other.value) ?: (other.value == null))) return false

        return true
    }

    public inline fun copy(block: Builder.() -> kotlin.Unit = {}): aws.sdk.kotlin.services.computeoptimizer.model.EcsServiceUtilizationMetric = Builder(this).apply(block).build()

    @SdkDsl
    public class Builder {
        /**
         * The name of the utilization metric.
         *
         * The following utilization metrics are available:
         * + `Cpu` — The amount of CPU capacity that's used in the service.
         * + `Memory` — The amount of memory that's used in the service.
         */
        public var name: aws.sdk.kotlin.services.computeoptimizer.model.EcsServiceMetricName? = null
        /**
         * The statistic of the utilization metric.
         *
         * The Compute Optimizer API, Command Line Interface (CLI), and SDKs return utilization metrics using only the `Maximum` statistic, which is the highest value observed during the specified period.
         *
         * The Compute Optimizer console displays graphs for some utilization metrics using the `Average` statistic, which is the value of `Sum` / `SampleCount` during the specified period. For more information, see [Viewing resource recommendations](https://docs.aws.amazon.com/compute-optimizer/latest/ug/viewing-recommendations.html) in the *Compute Optimizer User Guide*. You can also get averaged utilization metric data for your resources using Amazon CloudWatch. For more information, see the [Amazon CloudWatch User Guide](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html).
         */
        public var statistic: aws.sdk.kotlin.services.computeoptimizer.model.EcsServiceMetricStatistic? = null
        /**
         * The value of the utilization metric.
         */
        public var value: kotlin.Double = 0.0

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.computeoptimizer.model.EcsServiceUtilizationMetric) : this() {
            this.name = x.name
            this.statistic = x.statistic
            this.value = x.value
        }

        @PublishedApi
        internal fun build(): aws.sdk.kotlin.services.computeoptimizer.model.EcsServiceUtilizationMetric = EcsServiceUtilizationMetric(this)

        internal fun correctErrors(): Builder {
            return this
        }
    }
}