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

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

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

import aws.smithy.kotlin.runtime.SdkDsl

/**
 * Contains a summary of a gateway capability configuration.
 */
public class GatewayCapabilitySummary private constructor(builder: Builder) {
    /**
     * The namespace of the capability configuration. For example, if you configure OPC-UA sources from the IoT SiteWise console, your OPC-UA capability configuration has the namespace `iotsitewise:opcuacollector:version`, where `version` is a number such as `1`.
     */
    public val capabilityNamespace: kotlin.String = requireNotNull(builder.capabilityNamespace) { "A non-null value must be provided for capabilityNamespace" }
    /**
     * The synchronization status of the capability configuration. The sync status can be one of the following:
     * + `IN_SYNC` – The gateway is running the capability configuration.
     * + `OUT_OF_SYNC` – The gateway hasn't received the capability configuration.
     * + `SYNC_FAILED` – The gateway rejected the capability configuration.
     */
    public val capabilitySyncStatus: aws.sdk.kotlin.services.iotsitewise.model.CapabilitySyncStatus = requireNotNull(builder.capabilitySyncStatus) { "A non-null value must be provided for capabilitySyncStatus" }

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

    override fun toString(): kotlin.String = buildString {
        append("GatewayCapabilitySummary(")
        append("capabilityNamespace=$capabilityNamespace,")
        append("capabilitySyncStatus=$capabilitySyncStatus")
        append(")")
    }

    override fun hashCode(): kotlin.Int {
        var result = capabilityNamespace.hashCode()
        result = 31 * result + (capabilitySyncStatus.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 GatewayCapabilitySummary

        if (capabilityNamespace != other.capabilityNamespace) return false
        if (capabilitySyncStatus != other.capabilitySyncStatus) return false

        return true
    }

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

    @SdkDsl
    public class Builder {
        /**
         * The namespace of the capability configuration. For example, if you configure OPC-UA sources from the IoT SiteWise console, your OPC-UA capability configuration has the namespace `iotsitewise:opcuacollector:version`, where `version` is a number such as `1`.
         */
        public var capabilityNamespace: kotlin.String? = null
        /**
         * The synchronization status of the capability configuration. The sync status can be one of the following:
         * + `IN_SYNC` – The gateway is running the capability configuration.
         * + `OUT_OF_SYNC` – The gateway hasn't received the capability configuration.
         * + `SYNC_FAILED` – The gateway rejected the capability configuration.
         */
        public var capabilitySyncStatus: aws.sdk.kotlin.services.iotsitewise.model.CapabilitySyncStatus? = null

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.iotsitewise.model.GatewayCapabilitySummary) : this() {
            this.capabilityNamespace = x.capabilityNamespace
            this.capabilitySyncStatus = x.capabilitySyncStatus
        }

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

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