commonMain.aws.sdk.kotlin.services.swf.model.WorkflowExecutionInfo.kt Maven / Gradle / Ivy

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

package aws.sdk.kotlin.services.swf.model

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

/**
 * Contains information about a workflow execution.
 */
public class WorkflowExecutionInfo private constructor(builder: Builder) {
    /**
     * Set to true if a cancellation is requested for this workflow execution.
     */
    public val cancelRequested: kotlin.Boolean = builder.cancelRequested
    /**
     * If the execution status is closed then this specifies how the execution was closed:
     * + `COMPLETED` – the execution was successfully completed.
     * + `CANCELED` – the execution was canceled.Cancellation allows the implementation to gracefully clean up before the execution is closed.
     * + `TERMINATED` – the execution was force terminated.
     * + `FAILED` – the execution failed to complete.
     * + `TIMED_OUT` – the execution did not complete in the alloted time and was automatically timed out.
     * + `CONTINUED_AS_NEW` – the execution is logically continued. This means the current execution was completed and a new execution was started to carry on the workflow.
     */
    public val closeStatus: aws.sdk.kotlin.services.swf.model.CloseStatus? = builder.closeStatus
    /**
     * The time when the workflow execution was closed. Set only if the execution status is CLOSED.
     */
    public val closeTimestamp: aws.smithy.kotlin.runtime.time.Instant? = builder.closeTimestamp
    /**
     * The workflow execution this information is about.
     */
    public val execution: aws.sdk.kotlin.services.swf.model.WorkflowExecution? = builder.execution
    /**
     * The current status of the execution.
     */
    public val executionStatus: aws.sdk.kotlin.services.swf.model.ExecutionStatus = requireNotNull(builder.executionStatus) { "A non-null value must be provided for executionStatus" }
    /**
     * If this workflow execution is a child of another execution then contains the workflow execution that started this execution.
     */
    public val parent: aws.sdk.kotlin.services.swf.model.WorkflowExecution? = builder.parent
    /**
     * The time when the execution was started.
     */
    public val startTimestamp: aws.smithy.kotlin.runtime.time.Instant = requireNotNull(builder.startTimestamp) { "A non-null value must be provided for startTimestamp" }
    /**
     * The list of tags associated with the workflow execution. Tags can be used to identify and list workflow executions of interest through the visibility APIs. A workflow execution can have a maximum of 5 tags.
     */
    public val tagList: List? = builder.tagList
    /**
     * The type of the workflow execution.
     */
    public val workflowType: aws.sdk.kotlin.services.swf.model.WorkflowType? = builder.workflowType

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

    override fun toString(): kotlin.String = buildString {
        append("WorkflowExecutionInfo(")
        append("cancelRequested=$cancelRequested,")
        append("closeStatus=$closeStatus,")
        append("closeTimestamp=$closeTimestamp,")
        append("execution=$execution,")
        append("executionStatus=$executionStatus,")
        append("parent=$parent,")
        append("startTimestamp=$startTimestamp,")
        append("tagList=$tagList,")
        append("workflowType=$workflowType")
        append(")")
    }

    override fun hashCode(): kotlin.Int {
        var result = cancelRequested.hashCode()
        result = 31 * result + (closeStatus?.hashCode() ?: 0)
        result = 31 * result + (closeTimestamp?.hashCode() ?: 0)
        result = 31 * result + (execution?.hashCode() ?: 0)
        result = 31 * result + (executionStatus.hashCode())
        result = 31 * result + (parent?.hashCode() ?: 0)
        result = 31 * result + (startTimestamp.hashCode())
        result = 31 * result + (tagList?.hashCode() ?: 0)
        result = 31 * result + (workflowType?.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 WorkflowExecutionInfo

        if (cancelRequested != other.cancelRequested) return false
        if (closeStatus != other.closeStatus) return false
        if (closeTimestamp != other.closeTimestamp) return false
        if (execution != other.execution) return false
        if (executionStatus != other.executionStatus) return false
        if (parent != other.parent) return false
        if (startTimestamp != other.startTimestamp) return false
        if (tagList != other.tagList) return false
        if (workflowType != other.workflowType) return false

        return true
    }

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

    @SdkDsl
    public class Builder {
        /**
         * Set to true if a cancellation is requested for this workflow execution.
         */
        public var cancelRequested: kotlin.Boolean = false
        /**
         * If the execution status is closed then this specifies how the execution was closed:
         * + `COMPLETED` – the execution was successfully completed.
         * + `CANCELED` – the execution was canceled.Cancellation allows the implementation to gracefully clean up before the execution is closed.
         * + `TERMINATED` – the execution was force terminated.
         * + `FAILED` – the execution failed to complete.
         * + `TIMED_OUT` – the execution did not complete in the alloted time and was automatically timed out.
         * + `CONTINUED_AS_NEW` – the execution is logically continued. This means the current execution was completed and a new execution was started to carry on the workflow.
         */
        public var closeStatus: aws.sdk.kotlin.services.swf.model.CloseStatus? = null
        /**
         * The time when the workflow execution was closed. Set only if the execution status is CLOSED.
         */
        public var closeTimestamp: aws.smithy.kotlin.runtime.time.Instant? = null
        /**
         * The workflow execution this information is about.
         */
        public var execution: aws.sdk.kotlin.services.swf.model.WorkflowExecution? = null
        /**
         * The current status of the execution.
         */
        public var executionStatus: aws.sdk.kotlin.services.swf.model.ExecutionStatus? = null
        /**
         * If this workflow execution is a child of another execution then contains the workflow execution that started this execution.
         */
        public var parent: aws.sdk.kotlin.services.swf.model.WorkflowExecution? = null
        /**
         * The time when the execution was started.
         */
        public var startTimestamp: aws.smithy.kotlin.runtime.time.Instant? = null
        /**
         * The list of tags associated with the workflow execution. Tags can be used to identify and list workflow executions of interest through the visibility APIs. A workflow execution can have a maximum of 5 tags.
         */
        public var tagList: List? = null
        /**
         * The type of the workflow execution.
         */
        public var workflowType: aws.sdk.kotlin.services.swf.model.WorkflowType? = null

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.swf.model.WorkflowExecutionInfo) : this() {
            this.cancelRequested = x.cancelRequested
            this.closeStatus = x.closeStatus
            this.closeTimestamp = x.closeTimestamp
            this.execution = x.execution
            this.executionStatus = x.executionStatus
            this.parent = x.parent
            this.startTimestamp = x.startTimestamp
            this.tagList = x.tagList
            this.workflowType = x.workflowType
        }

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

        /**
         * construct an [aws.sdk.kotlin.services.swf.model.WorkflowExecution] inside the given [block]
         */
        public fun execution(block: aws.sdk.kotlin.services.swf.model.WorkflowExecution.Builder.() -> kotlin.Unit) {
            this.execution = aws.sdk.kotlin.services.swf.model.WorkflowExecution.invoke(block)
        }

        /**
         * construct an [aws.sdk.kotlin.services.swf.model.WorkflowExecution] inside the given [block]
         */
        public fun parent(block: aws.sdk.kotlin.services.swf.model.WorkflowExecution.Builder.() -> kotlin.Unit) {
            this.parent = aws.sdk.kotlin.services.swf.model.WorkflowExecution.invoke(block)
        }

        /**
         * construct an [aws.sdk.kotlin.services.swf.model.WorkflowType] inside the given [block]
         */
        public fun workflowType(block: aws.sdk.kotlin.services.swf.model.WorkflowType.Builder.() -> kotlin.Unit) {
            this.workflowType = aws.sdk.kotlin.services.swf.model.WorkflowType.invoke(block)
        }

        internal fun correctErrors(): Builder {
            if (executionStatus == null) executionStatus = ExecutionStatus.SdkUnknown("no value provided")
            if (startTimestamp == null) startTimestamp = Instant.fromEpochSeconds(0)
            return this
        }
    }
}