commonMain.aws.sdk.kotlin.services.iotfleetwise.model.GetCampaignResponse.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of iotfleetwise-jvm Show documentation
The AWS SDK for Kotlin client for IoTFleetWise
The newest version!
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!

package aws.sdk.kotlin.services.iotfleetwise.model

import aws.smithy.kotlin.runtime.SdkDsl
import aws.smithy.kotlin.runtime.time.Instant

public class GetCampaignResponse private constructor(builder: Builder) {
    /**
     * The Amazon Resource Name (ARN) of the campaign.
     */
    public val arn: kotlin.String? = builder.arn
    /**
     * Information about the data collection scheme associated with the campaign.
     */
    public val collectionScheme: aws.sdk.kotlin.services.iotfleetwise.model.CollectionScheme? = builder.collectionScheme
    /**
     * Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise. If `OFF` is specified, the signals aren't compressed. If it's not specified, `SNAPPY` is used.
     */
    public val compression: aws.sdk.kotlin.services.iotfleetwise.model.Compression? = builder.compression
    /**
     * The time the campaign was created in seconds since epoch (January 1, 1970 at midnight UTC time).
     */
    public val creationTime: aws.smithy.kotlin.runtime.time.Instant? = builder.creationTime
    /**
     * The destination where the campaign sends data. You can choose to send data to be stored in Amazon S3 or Amazon Timestream.
     *
     * Amazon S3 optimizes the cost of data storage and provides additional mechanisms to use vehicle data, such as data lakes, centralized data storage, data processing pipelines, and analytics.
     *
     * You can use Amazon Timestream to access and analyze time series data, and Timestream to query vehicle data so that you can identify trends and patterns.
     */
    public val dataDestinationConfigs: List? = builder.dataDestinationConfigs
    /**
     * A list of vehicle attributes associated with the campaign.
     */
    public val dataExtraDimensions: List? = builder.dataExtraDimensions
    /**
     * The description of the campaign.
     */
    public val description: kotlin.String? = builder.description
    /**
     * Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise.
     */
    public val diagnosticsMode: aws.sdk.kotlin.services.iotfleetwise.model.DiagnosticsMode? = builder.diagnosticsMode
    /**
     * The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time). Vehicle data won't be collected after the campaign expires.
     */
    public val expiryTime: aws.smithy.kotlin.runtime.time.Instant? = builder.expiryTime
    /**
     * The last time the campaign was modified.
     */
    public val lastModificationTime: aws.smithy.kotlin.runtime.time.Instant? = builder.lastModificationTime
    /**
     * The name of the campaign.
     */
    public val name: kotlin.String? = builder.name
    /**
     * How long (in seconds) to collect raw data after a triggering event initiates the collection.
     */
    public val postTriggerCollectionDuration: kotlin.Long? = builder.postTriggerCollectionDuration
    /**
     * A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet. A campaign with the lowest value is deployed to vehicles before any other campaigns.
     */
    public val priority: kotlin.Int? = builder.priority
    /**
     * The ARN of a signal catalog.
     */
    public val signalCatalogArn: kotlin.String? = builder.signalCatalogArn
    /**
     * Information about a list of signals to collect data on.
     */
    public val signalsToCollect: List? = builder.signalsToCollect
    /**
     * Whether to store collected data after a vehicle lost a connection with the cloud. After a connection is re-established, the data is automatically forwarded to Amazon Web Services IoT FleetWise.
     */
    public val spoolingMode: aws.sdk.kotlin.services.iotfleetwise.model.SpoolingMode? = builder.spoolingMode
    /**
     * The time, in milliseconds, to deliver a campaign after it was approved.
     */
    public val startTime: aws.smithy.kotlin.runtime.time.Instant? = builder.startTime
    /**
     * The state of the campaign. The status can be one of: `CREATING`, `WAITING_FOR_APPROVAL`, `RUNNING`, and `SUSPENDED`.
     */
    public val status: aws.sdk.kotlin.services.iotfleetwise.model.CampaignStatus? = builder.status
    /**
     * The ARN of the vehicle or the fleet targeted by the campaign.
     */
    public val targetArn: kotlin.String? = builder.targetArn

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

    override fun toString(): kotlin.String = buildString {
        append("GetCampaignResponse(")
        append("arn=$arn,")
        append("collectionScheme=$collectionScheme,")
        append("compression=$compression,")
        append("creationTime=$creationTime,")
        append("dataDestinationConfigs=$dataDestinationConfigs,")
        append("dataExtraDimensions=*** Sensitive Data Redacted ***,")
        append("description=$description,")
        append("diagnosticsMode=$diagnosticsMode,")
        append("expiryTime=$expiryTime,")
        append("lastModificationTime=$lastModificationTime,")
        append("name=$name,")
        append("postTriggerCollectionDuration=$postTriggerCollectionDuration,")
        append("priority=$priority,")
        append("signalCatalogArn=$signalCatalogArn,")
        append("signalsToCollect=*** Sensitive Data Redacted ***,")
        append("spoolingMode=$spoolingMode,")
        append("startTime=$startTime,")
        append("status=$status,")
        append("targetArn=$targetArn")
        append(")")
    }

    override fun hashCode(): kotlin.Int {
        var result = arn?.hashCode() ?: 0
        result = 31 * result + (collectionScheme?.hashCode() ?: 0)
        result = 31 * result + (compression?.hashCode() ?: 0)
        result = 31 * result + (creationTime?.hashCode() ?: 0)
        result = 31 * result + (dataDestinationConfigs?.hashCode() ?: 0)
        result = 31 * result + (dataExtraDimensions?.hashCode() ?: 0)
        result = 31 * result + (description?.hashCode() ?: 0)
        result = 31 * result + (diagnosticsMode?.hashCode() ?: 0)
        result = 31 * result + (expiryTime?.hashCode() ?: 0)
        result = 31 * result + (lastModificationTime?.hashCode() ?: 0)
        result = 31 * result + (name?.hashCode() ?: 0)
        result = 31 * result + (postTriggerCollectionDuration?.hashCode() ?: 0)
        result = 31 * result + (priority ?: 0)
        result = 31 * result + (signalCatalogArn?.hashCode() ?: 0)
        result = 31 * result + (signalsToCollect?.hashCode() ?: 0)
        result = 31 * result + (spoolingMode?.hashCode() ?: 0)
        result = 31 * result + (startTime?.hashCode() ?: 0)
        result = 31 * result + (status?.hashCode() ?: 0)
        result = 31 * result + (targetArn?.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 GetCampaignResponse

        if (arn != other.arn) return false
        if (collectionScheme != other.collectionScheme) return false
        if (compression != other.compression) return false
        if (creationTime != other.creationTime) return false
        if (dataDestinationConfigs != other.dataDestinationConfigs) return false
        if (dataExtraDimensions != other.dataExtraDimensions) return false
        if (description != other.description) return false
        if (diagnosticsMode != other.diagnosticsMode) return false
        if (expiryTime != other.expiryTime) return false
        if (lastModificationTime != other.lastModificationTime) return false
        if (name != other.name) return false
        if (postTriggerCollectionDuration != other.postTriggerCollectionDuration) return false
        if (priority != other.priority) return false
        if (signalCatalogArn != other.signalCatalogArn) return false
        if (signalsToCollect != other.signalsToCollect) return false
        if (spoolingMode != other.spoolingMode) return false
        if (startTime != other.startTime) return false
        if (status != other.status) return false
        if (targetArn != other.targetArn) return false

        return true
    }

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

    @SdkDsl
    public class Builder {
        /**
         * The Amazon Resource Name (ARN) of the campaign.
         */
        public var arn: kotlin.String? = null
        /**
         * Information about the data collection scheme associated with the campaign.
         */
        public var collectionScheme: aws.sdk.kotlin.services.iotfleetwise.model.CollectionScheme? = null
        /**
         * Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise. If `OFF` is specified, the signals aren't compressed. If it's not specified, `SNAPPY` is used.
         */
        public var compression: aws.sdk.kotlin.services.iotfleetwise.model.Compression? = null
        /**
         * The time the campaign was created in seconds since epoch (January 1, 1970 at midnight UTC time).
         */
        public var creationTime: aws.smithy.kotlin.runtime.time.Instant? = null
        /**
         * The destination where the campaign sends data. You can choose to send data to be stored in Amazon S3 or Amazon Timestream.
         *
         * Amazon S3 optimizes the cost of data storage and provides additional mechanisms to use vehicle data, such as data lakes, centralized data storage, data processing pipelines, and analytics.
         *
         * You can use Amazon Timestream to access and analyze time series data, and Timestream to query vehicle data so that you can identify trends and patterns.
         */
        public var dataDestinationConfigs: List? = null
        /**
         * A list of vehicle attributes associated with the campaign.
         */
        public var dataExtraDimensions: List? = null
        /**
         * The description of the campaign.
         */
        public var description: kotlin.String? = null
        /**
         * Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise.
         */
        public var diagnosticsMode: aws.sdk.kotlin.services.iotfleetwise.model.DiagnosticsMode? = null
        /**
         * The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time). Vehicle data won't be collected after the campaign expires.
         */
        public var expiryTime: aws.smithy.kotlin.runtime.time.Instant? = null
        /**
         * The last time the campaign was modified.
         */
        public var lastModificationTime: aws.smithy.kotlin.runtime.time.Instant? = null
        /**
         * The name of the campaign.
         */
        public var name: kotlin.String? = null
        /**
         * How long (in seconds) to collect raw data after a triggering event initiates the collection.
         */
        public var postTriggerCollectionDuration: kotlin.Long? = null
        /**
         * A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet. A campaign with the lowest value is deployed to vehicles before any other campaigns.
         */
        public var priority: kotlin.Int? = null
        /**
         * The ARN of a signal catalog.
         */
        public var signalCatalogArn: kotlin.String? = null
        /**
         * Information about a list of signals to collect data on.
         */
        public var signalsToCollect: List? = null
        /**
         * Whether to store collected data after a vehicle lost a connection with the cloud. After a connection is re-established, the data is automatically forwarded to Amazon Web Services IoT FleetWise.
         */
        public var spoolingMode: aws.sdk.kotlin.services.iotfleetwise.model.SpoolingMode? = null
        /**
         * The time, in milliseconds, to deliver a campaign after it was approved.
         */
        public var startTime: aws.smithy.kotlin.runtime.time.Instant? = null
        /**
         * The state of the campaign. The status can be one of: `CREATING`, `WAITING_FOR_APPROVAL`, `RUNNING`, and `SUSPENDED`.
         */
        public var status: aws.sdk.kotlin.services.iotfleetwise.model.CampaignStatus? = null
        /**
         * The ARN of the vehicle or the fleet targeted by the campaign.
         */
        public var targetArn: kotlin.String? = null

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.iotfleetwise.model.GetCampaignResponse) : this() {
            this.arn = x.arn
            this.collectionScheme = x.collectionScheme
            this.compression = x.compression
            this.creationTime = x.creationTime
            this.dataDestinationConfigs = x.dataDestinationConfigs
            this.dataExtraDimensions = x.dataExtraDimensions
            this.description = x.description
            this.diagnosticsMode = x.diagnosticsMode
            this.expiryTime = x.expiryTime
            this.lastModificationTime = x.lastModificationTime
            this.name = x.name
            this.postTriggerCollectionDuration = x.postTriggerCollectionDuration
            this.priority = x.priority
            this.signalCatalogArn = x.signalCatalogArn
            this.signalsToCollect = x.signalsToCollect
            this.spoolingMode = x.spoolingMode
            this.startTime = x.startTime
            this.status = x.status
            this.targetArn = x.targetArn
        }

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

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