commonMain.aws.sdk.kotlin.services.deadline.model.GetSessionsStatisticsAggregationResponse.kt Maven / Gradle / Ivy

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

package aws.sdk.kotlin.services.deadline.model

import aws.smithy.kotlin.runtime.SdkDsl

public class GetSessionsStatisticsAggregationResponse private constructor(builder: Builder) {
    /**
     * If Deadline Cloud returns `nextToken`, then there are more results available. The value of `nextToken` is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then `nextToken` is set to `null`. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 `ValidationException` error.
     */
    public val nextToken: kotlin.String? = builder.nextToken
    /**
     * The statistics for the specified fleets or queues.
     */
    public val statistics: List? = builder.statistics
    /**
     * The status of the aggregated results. An aggregation may fail or time out if the results are too large. If this happens, you can call the `StartSessionsStatisticsAggregation` operation after you reduce the aggregation time frame, reduce the number of queues or fleets in the aggregation, or increase the period length.
     *
     * If you call the `StartSessionsStatisticsAggregation ` operation when the status is `IN_PROGRESS`, you will receive a `ThrottlingException`.
     */
    public val status: aws.sdk.kotlin.services.deadline.model.SessionsStatisticsAggregationStatus = requireNotNull(builder.status) { "A non-null value must be provided for status" }
    /**
     * A message that describes the status.
     */
    public val statusMessage: kotlin.String? = builder.statusMessage

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

    override fun toString(): kotlin.String = buildString {
        append("GetSessionsStatisticsAggregationResponse(")
        append("nextToken=$nextToken,")
        append("statistics=$statistics,")
        append("status=$status,")
        append("statusMessage=$statusMessage")
        append(")")
    }

    override fun hashCode(): kotlin.Int {
        var result = nextToken?.hashCode() ?: 0
        result = 31 * result + (statistics?.hashCode() ?: 0)
        result = 31 * result + (status.hashCode())
        result = 31 * result + (statusMessage?.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 GetSessionsStatisticsAggregationResponse

        if (nextToken != other.nextToken) return false
        if (statistics != other.statistics) return false
        if (status != other.status) return false
        if (statusMessage != other.statusMessage) return false

        return true
    }

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

    @SdkDsl
    public class Builder {
        /**
         * If Deadline Cloud returns `nextToken`, then there are more results available. The value of `nextToken` is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then `nextToken` is set to `null`. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 `ValidationException` error.
         */
        public var nextToken: kotlin.String? = null
        /**
         * The statistics for the specified fleets or queues.
         */
        public var statistics: List? = null
        /**
         * The status of the aggregated results. An aggregation may fail or time out if the results are too large. If this happens, you can call the `StartSessionsStatisticsAggregation` operation after you reduce the aggregation time frame, reduce the number of queues or fleets in the aggregation, or increase the period length.
         *
         * If you call the `StartSessionsStatisticsAggregation ` operation when the status is `IN_PROGRESS`, you will receive a `ThrottlingException`.
         */
        public var status: aws.sdk.kotlin.services.deadline.model.SessionsStatisticsAggregationStatus? = null
        /**
         * A message that describes the status.
         */
        public var statusMessage: kotlin.String? = null

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.deadline.model.GetSessionsStatisticsAggregationResponse) : this() {
            this.nextToken = x.nextToken
            this.statistics = x.statistics
            this.status = x.status
            this.statusMessage = x.statusMessage
        }

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

        internal fun correctErrors(): Builder {
            if (status == null) status = SessionsStatisticsAggregationStatus.SdkUnknown("no value provided")
            return this
        }
    }
}