commonMain.aws.sdk.kotlin.services.codepipeline.model.StopPipelineExecutionRequest.kt Maven / Gradle / Ivy

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

package aws.sdk.kotlin.services.codepipeline.model



public class StopPipelineExecutionRequest private constructor(builder: Builder) {
    /**
     * Use this option to stop the pipeline execution by abandoning, rather than finishing, in-progress actions.
     *
     * This option can lead to failed or out-of-sequence tasks.
     */
    public val abandon: kotlin.Boolean = builder.abandon
    /**
     * The ID of the pipeline execution to be stopped in the current stage. Use the `GetPipelineState` action to retrieve the current pipelineExecutionId.
     */
    public val pipelineExecutionId: kotlin.String? = builder.pipelineExecutionId
    /**
     * The name of the pipeline to stop.
     */
    public val pipelineName: kotlin.String? = builder.pipelineName
    /**
     * Use this option to enter comments, such as the reason the pipeline was stopped.
     */
    public val reason: kotlin.String? = builder.reason

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

    override fun toString(): kotlin.String = buildString {
        append("StopPipelineExecutionRequest(")
        append("abandon=$abandon,")
        append("pipelineExecutionId=$pipelineExecutionId,")
        append("pipelineName=$pipelineName,")
        append("reason=$reason")
        append(")")
    }

    override fun hashCode(): kotlin.Int {
        var result = abandon.hashCode()
        result = 31 * result + (pipelineExecutionId?.hashCode() ?: 0)
        result = 31 * result + (pipelineName?.hashCode() ?: 0)
        result = 31 * result + (reason?.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 StopPipelineExecutionRequest

        if (abandon != other.abandon) return false
        if (pipelineExecutionId != other.pipelineExecutionId) return false
        if (pipelineName != other.pipelineName) return false
        if (reason != other.reason) return false

        return true
    }

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

    public class Builder {
        /**
         * Use this option to stop the pipeline execution by abandoning, rather than finishing, in-progress actions.
         *
         * This option can lead to failed or out-of-sequence tasks.
         */
        public var abandon: kotlin.Boolean = false
        /**
         * The ID of the pipeline execution to be stopped in the current stage. Use the `GetPipelineState` action to retrieve the current pipelineExecutionId.
         */
        public var pipelineExecutionId: kotlin.String? = null
        /**
         * The name of the pipeline to stop.
         */
        public var pipelineName: kotlin.String? = null
        /**
         * Use this option to enter comments, such as the reason the pipeline was stopped.
         */
        public var reason: kotlin.String? = null

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.codepipeline.model.StopPipelineExecutionRequest) : this() {
            this.abandon = x.abandon
            this.pipelineExecutionId = x.pipelineExecutionId
            this.pipelineName = x.pipelineName
            this.reason = x.reason
        }

        @PublishedApi
        internal fun build(): aws.sdk.kotlin.services.codepipeline.model.StopPipelineExecutionRequest = StopPipelineExecutionRequest(this)
    }
}