commonMain.aws.sdk.kotlin.services.bedrockagent.model.ToolSpecification.kt Maven / Gradle / Ivy

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

package aws.sdk.kotlin.services.bedrockagent.model

import aws.smithy.kotlin.runtime.SdkDsl

/**
 * Contains a specification for a tool. For more information, see [Use a tool to complete an Amazon Bedrock model response](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html).
 */
public class ToolSpecification private constructor(builder: Builder) {
    /**
     * The description of the tool.
     */
    public val description: kotlin.String? = builder.description
    /**
     * The input schema for the tool.
     */
    public val inputSchema: aws.sdk.kotlin.services.bedrockagent.model.ToolInputSchema? = builder.inputSchema
    /**
     * The name of the tool.
     */
    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.bedrockagent.model.ToolSpecification = Builder().apply(block).build()
    }

    override fun toString(): kotlin.String = buildString {
        append("ToolSpecification(")
        append("description=$description,")
        append("inputSchema=$inputSchema,")
        append("name=$name")
        append(")")
    }

    override fun hashCode(): kotlin.Int {
        var result = description?.hashCode() ?: 0
        result = 31 * result + (inputSchema?.hashCode() ?: 0)
        result = 31 * 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 ToolSpecification

        if (description != other.description) return false
        if (inputSchema != other.inputSchema) return false
        if (name != other.name) return false

        return true
    }

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

    @SdkDsl
    public class Builder {
        /**
         * The description of the tool.
         */
        public var description: kotlin.String? = null
        /**
         * The input schema for the tool.
         */
        public var inputSchema: aws.sdk.kotlin.services.bedrockagent.model.ToolInputSchema? = null
        /**
         * The name of the tool.
         */
        public var name: kotlin.String? = null

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.bedrockagent.model.ToolSpecification) : this() {
            this.description = x.description
            this.inputSchema = x.inputSchema
            this.name = x.name
        }

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

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