• Home
• aws.sdk.kotlin
• iotsitewise-jvm
• 1.3.72
• source code
• TumblingWindow.kt

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

commonMain.aws.sdk.kotlin.services.iotsitewise.model.TumblingWindow.kt Maven / Gradle / Ivy

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

package aws.sdk.kotlin.services.iotsitewise.model

import aws.smithy.kotlin.runtime.SdkDsl

/**
 * Contains a tumbling window, which is a repeating fixed-sized, non-overlapping, and contiguous time window. You can use this window in metrics to aggregate data from properties and other assets.
 *
 * You can use `m`, `h`, `d`, and `w` when you specify an interval or offset. Note that `m` represents minutes, `h` represents hours, `d` represents days, and `w` represents weeks. You can also use `s` to represent seconds in `offset`.
 *
 * The `interval` and `offset` parameters support the [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601). For example, `PT5S` represents 5 seconds, `PT5M` represents 5 minutes, and `PT5H` represents 5 hours.
 */
public class TumblingWindow private constructor(builder: Builder) {
    /**
     * The time interval for the tumbling window. The interval time must be between 1 minute and 1 week.
     *
     * IoT SiteWise computes the `1w` interval the end of Sunday at midnight each week (UTC), the `1d` interval at the end of each day at midnight (UTC), the `1h` interval at the end of each hour, and so on.
     *
     * When IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. IoT SiteWise places the computed data point at the end of the interval.
     */
    public val interval: kotlin.String = requireNotNull(builder.interval) { "A non-null value must be provided for interval" }
    /**
     * The offset for the tumbling window. The `offset` parameter accepts the following:
     * + The offset time.For example, if you specify `18h` for `offset` and `1d` for `interval`, IoT SiteWise aggregates data in one of the following ways:
     *    + If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
     *    + If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
     * + The ISO 8601 format.For example, if you specify `PT18H` for `offset` and `1d` for `interval`, IoT SiteWise aggregates data in one of the following ways:
     *    + If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
     *    + If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
     * + The 24-hour clock.For example, if you specify `00:03:00` for `offset`, `5m` for `interval`, and you create the metric at 2 PM (UTC), you get the first aggregation result at 2:03 PM (UTC). You get the second aggregation result at 2:08 PM (UTC).
     * + The offset time zone.For example, if you specify `2021-07-23T18:00-08` for `offset` and `1d` for `interval`, IoT SiteWise aggregates data in one of the following ways:
     *    + If you create the metric before or at 6 PM (PST), you get the first aggregation result at 6 PM (PST) on the day when you create the metric.
     *    + If you create the metric after 6 PM (PST), you get the first aggregation result at 6 PM (PST) the next day.
     */
    public val offset: kotlin.String? = builder.offset

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

    override fun toString(): kotlin.String = buildString {
        append("TumblingWindow(")
        append("interval=$interval,")
        append("offset=$offset")
        append(")")
    }

    override fun hashCode(): kotlin.Int {
        var result = interval.hashCode()
        result = 31 * result + (offset?.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 TumblingWindow

        if (interval != other.interval) return false
        if (offset != other.offset) return false

        return true
    }

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

    @SdkDsl
    public class Builder {
        /**
         * The time interval for the tumbling window. The interval time must be between 1 minute and 1 week.
         *
         * IoT SiteWise computes the `1w` interval the end of Sunday at midnight each week (UTC), the `1d` interval at the end of each day at midnight (UTC), the `1h` interval at the end of each hour, and so on.
         *
         * When IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. IoT SiteWise places the computed data point at the end of the interval.
         */
        public var interval: kotlin.String? = null
        /**
         * The offset for the tumbling window. The `offset` parameter accepts the following:
         * + The offset time.For example, if you specify `18h` for `offset` and `1d` for `interval`, IoT SiteWise aggregates data in one of the following ways:
         *    + If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
         *    + If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
         * + The ISO 8601 format.For example, if you specify `PT18H` for `offset` and `1d` for `interval`, IoT SiteWise aggregates data in one of the following ways:
         *    + If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
         *    + If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
         * + The 24-hour clock.For example, if you specify `00:03:00` for `offset`, `5m` for `interval`, and you create the metric at 2 PM (UTC), you get the first aggregation result at 2:03 PM (UTC). You get the second aggregation result at 2:08 PM (UTC).
         * + The offset time zone.For example, if you specify `2021-07-23T18:00-08` for `offset` and `1d` for `interval`, IoT SiteWise aggregates data in one of the following ways:
         *    + If you create the metric before or at 6 PM (PST), you get the first aggregation result at 6 PM (PST) on the day when you create the metric.
         *    + If you create the metric after 6 PM (PST), you get the first aggregation result at 6 PM (PST) the next day.
         */
        public var offset: kotlin.String? = null

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.iotsitewise.model.TumblingWindow) : this() {
            this.interval = x.interval
            this.offset = x.offset
        }

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

        internal fun correctErrors(): Builder {
            if (interval == null) interval = ""
            return this
        }
    }
}