commonMain.aws.sdk.kotlin.services.bedrock.model.GuardrailTopic.kt Maven / Gradle / Ivy

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

package aws.sdk.kotlin.services.bedrock.model

import aws.smithy.kotlin.runtime.SdkDsl

/**
 * Details about topics for the guardrail to identify and deny.
 *
 * This data type is used in the following API operations:
 * + [GetGuardrail response body](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetGuardrail.html#API_GetGuardrail_ResponseSyntax)
 */
public class GuardrailTopic private constructor(builder: Builder) {
    /**
     * A definition of the topic to deny.
     */
    public val definition: kotlin.String = requireNotNull(builder.definition) { "A non-null value must be provided for definition" }
    /**
     * A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.
     */
    public val examples: List? = builder.examples
    /**
     * The name of the topic to deny.
     */
    public val name: kotlin.String = requireNotNull(builder.name) { "A non-null value must be provided for name" }
    /**
     * Specifies to deny the topic.
     */
    public val type: aws.sdk.kotlin.services.bedrock.model.GuardrailTopicType? = builder.type

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

    override fun toString(): kotlin.String = buildString {
        append("GuardrailTopic(")
        append("definition=*** Sensitive Data Redacted ***,")
        append("examples=*** Sensitive Data Redacted ***,")
        append("name=*** Sensitive Data Redacted ***,")
        append("type=$type")
        append(")")
    }

    override fun hashCode(): kotlin.Int {
        var result = definition.hashCode()
        result = 31 * result + (examples?.hashCode() ?: 0)
        result = 31 * result + (name.hashCode())
        result = 31 * result + (type?.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 GuardrailTopic

        if (definition != other.definition) return false
        if (examples != other.examples) return false
        if (name != other.name) return false
        if (type != other.type) return false

        return true
    }

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

    @SdkDsl
    public class Builder {
        /**
         * A definition of the topic to deny.
         */
        public var definition: kotlin.String? = null
        /**
         * A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.
         */
        public var examples: List? = null
        /**
         * The name of the topic to deny.
         */
        public var name: kotlin.String? = null
        /**
         * Specifies to deny the topic.
         */
        public var type: aws.sdk.kotlin.services.bedrock.model.GuardrailTopicType? = null

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.bedrock.model.GuardrailTopic) : this() {
            this.definition = x.definition
            this.examples = x.examples
            this.name = x.name
            this.type = x.type
        }

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

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