commonMain.aws.sdk.kotlin.services.s3control.model.S3SetObjectLegalHoldOperation.kt Maven / Gradle / Ivy

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

package aws.sdk.kotlin.services.s3control.model



/**
 * Contains the configuration for an S3 Object Lock legal hold operation that an S3 Batch Operations job passes to every object to the underlying `PutObjectLegalHold` API operation. For more information, see [Using S3 Object Lock legal hold with S3 Batch Operations](https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-legal-hold.html) in the *Amazon S3 User Guide*.
 *
 * This functionality is not supported by directory buckets.
 */
public class S3SetObjectLegalHoldOperation private constructor(builder: Builder) {
    /**
     * Contains the Object Lock legal hold status to be applied to all objects in the Batch Operations job.
     */
    public val legalHold: aws.sdk.kotlin.services.s3control.model.S3ObjectLockLegalHold? = builder.legalHold

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

    override fun toString(): kotlin.String = buildString {
        append("S3SetObjectLegalHoldOperation(")
        append("legalHold=$legalHold")
        append(")")
    }

    override fun hashCode(): kotlin.Int {
        var result = legalHold?.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 S3SetObjectLegalHoldOperation

        if (legalHold != other.legalHold) return false

        return true
    }

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

    public class Builder {
        /**
         * Contains the Object Lock legal hold status to be applied to all objects in the Batch Operations job.
         */
        public var legalHold: aws.sdk.kotlin.services.s3control.model.S3ObjectLockLegalHold? = null

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.s3control.model.S3SetObjectLegalHoldOperation) : this() {
            this.legalHold = x.legalHold
        }

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

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

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