commonMain.aws.sdk.kotlin.services.iot.model.StatisticalThreshold.kt Maven / Gradle / Ivy

Go to download
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!

package aws.sdk.kotlin.services.iot.model



/**
 * A statistical ranking (percentile) that indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.
 */
public class StatisticalThreshold private constructor(builder: Builder) {
    /**
     * The percentile that resolves to a threshold value by which compliance with a behavior is determined. Metrics are collected over the specified period (`durationSeconds`) from all reporting devices in your account and statistical ranks are calculated. Then, the measurements from a device are collected over the same period. If the accumulated measurements from the device fall above or below (`comparisonOperator`) the value associated with the percentile specified, then the device is considered to be in compliance with the behavior, otherwise a violation occurs.
     */
    public val statistic: kotlin.String? = builder.statistic

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

    override fun toString(): kotlin.String = buildString {
        append("StatisticalThreshold(")
        append("statistic=$statistic")
        append(")")
    }

    override fun hashCode(): kotlin.Int {
        var result = statistic?.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 StatisticalThreshold

        if (statistic != other.statistic) return false

        return true
    }

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

    public class Builder {
        /**
         * The percentile that resolves to a threshold value by which compliance with a behavior is determined. Metrics are collected over the specified period (`durationSeconds`) from all reporting devices in your account and statistical ranks are calculated. Then, the measurements from a device are collected over the same period. If the accumulated measurements from the device fall above or below (`comparisonOperator`) the value associated with the percentile specified, then the device is considered to be in compliance with the behavior, otherwise a violation occurs.
         */
        public var statistic: kotlin.String? = null

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.iot.model.StatisticalThreshold) : this() {
            this.statistic = x.statistic
        }

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

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