commonMain.aws.sdk.kotlin.services.s3.model.IndexDocument.kt Maven / Gradle / Ivy

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

package aws.sdk.kotlin.services.s3.model



/**
 * Container for the `Suffix` element.
 */
public class IndexDocument private constructor(builder: Builder) {
    /**
     * A suffix that is appended to a request that is for a directory on the website endpoint (for example,if the suffix is index.html and you make a request to samplebucket/images/ the data that is returned will be for the object with the key name images/index.html) The suffix must not be empty and must not include a slash character.
     *
     * Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [ XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).
     */
    public val suffix: kotlin.String = requireNotNull(builder.suffix) { "A non-null value must be provided for suffix" }

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

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

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

        if (suffix != other.suffix) return false

        return true
    }

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

    public class Builder {
        /**
         * A suffix that is appended to a request that is for a directory on the website endpoint (for example,if the suffix is index.html and you make a request to samplebucket/images/ the data that is returned will be for the object with the key name images/index.html) The suffix must not be empty and must not include a slash character.
         *
         * Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [ XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).
         */
        public var suffix: kotlin.String? = null

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.s3.model.IndexDocument) : this() {
            this.suffix = x.suffix
        }

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

        internal fun correctErrors(): Builder {
            if (suffix == null) suffix = ""
            return this
        }
    }
}