commonMain.aws.sdk.kotlin.services.wafv2.model.SingleHeader.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of wafv2-jvm Show documentation

The AWS Kotlin client for WAFV2

The newest version!

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

package aws.sdk.kotlin.services.wafv2.model

import aws.smithy.kotlin.runtime.SdkDsl

/**
 * Inspect one of the headers in the web request, identified by name, for example, `User-Agent` or `Referer`. The name isn't case sensitive.
 *
 * You can filter and inspect all headers with the `FieldToMatch` setting `Headers`.
 *
 * This is used to indicate the web request component to inspect, in the FieldToMatch specification.
 *
 * Example JSON: `"SingleHeader": { "Name": "haystack" }`
 */
public class SingleHeader private constructor(builder: Builder) {
    /**
     * The name of the query header to inspect.
     */
    public val name: kotlin.String = requireNotNull(builder.name) { "A non-null value must be provided for name" }

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

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

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

        if (name != other.name) return false

        return true
    }

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

    @SdkDsl
    public class Builder {
        /**
         * The name of the query header to inspect.
         */
        public var name: kotlin.String? = null

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.wafv2.model.SingleHeader) : this() {
            this.name = x.name
        }

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

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