commonMain.aws.sdk.kotlin.services.polly.model.DescribeVoicesRequest.kt Maven / Gradle / Ivy

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

package aws.sdk.kotlin.services.polly.model

import aws.smithy.kotlin.runtime.SdkDsl

public class DescribeVoicesRequest private constructor(builder: Builder) {
    /**
     * Specifies the engine (`standard`, `neural`, `long-form` or `generative`) used by Amazon Polly when processing input text for speech synthesis.
     */
    public val engine: aws.sdk.kotlin.services.polly.model.Engine? = builder.engine
    /**
     * Boolean value indicating whether to return any bilingual voices that use the specified language as an additional language. For instance, if you request all languages that use US English (es-US), and there is an Italian voice that speaks both Italian (it-IT) and US English, that voice will be included if you specify `yes` but not if you specify `no`.
     */
    public val includeAdditionalLanguageCodes: kotlin.Boolean? = builder.includeAdditionalLanguageCodes
    /**
     * The language identification tag (ISO 639 code for the language name-ISO 3166 country code) for filtering the list of voices returned. If you don't specify this optional parameter, all available voices are returned.
     */
    public val languageCode: aws.sdk.kotlin.services.polly.model.LanguageCode? = builder.languageCode
    /**
     * An opaque pagination token returned from the previous `DescribeVoices` operation. If present, this indicates where to continue the listing.
     */
    public val nextToken: kotlin.String? = builder.nextToken

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

    override fun toString(): kotlin.String = buildString {
        append("DescribeVoicesRequest(")
        append("engine=$engine,")
        append("includeAdditionalLanguageCodes=$includeAdditionalLanguageCodes,")
        append("languageCode=$languageCode,")
        append("nextToken=$nextToken")
        append(")")
    }

    override fun hashCode(): kotlin.Int {
        var result = engine?.hashCode() ?: 0
        result = 31 * result + (includeAdditionalLanguageCodes?.hashCode() ?: 0)
        result = 31 * result + (languageCode?.hashCode() ?: 0)
        result = 31 * result + (nextToken?.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 DescribeVoicesRequest

        if (engine != other.engine) return false
        if (includeAdditionalLanguageCodes != other.includeAdditionalLanguageCodes) return false
        if (languageCode != other.languageCode) return false
        if (nextToken != other.nextToken) return false

        return true
    }

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

    @SdkDsl
    public class Builder {
        /**
         * Specifies the engine (`standard`, `neural`, `long-form` or `generative`) used by Amazon Polly when processing input text for speech synthesis.
         */
        public var engine: aws.sdk.kotlin.services.polly.model.Engine? = null
        /**
         * Boolean value indicating whether to return any bilingual voices that use the specified language as an additional language. For instance, if you request all languages that use US English (es-US), and there is an Italian voice that speaks both Italian (it-IT) and US English, that voice will be included if you specify `yes` but not if you specify `no`.
         */
        public var includeAdditionalLanguageCodes: kotlin.Boolean? = null
        /**
         * The language identification tag (ISO 639 code for the language name-ISO 3166 country code) for filtering the list of voices returned. If you don't specify this optional parameter, all available voices are returned.
         */
        public var languageCode: aws.sdk.kotlin.services.polly.model.LanguageCode? = null
        /**
         * An opaque pagination token returned from the previous `DescribeVoices` operation. If present, this indicates where to continue the listing.
         */
        public var nextToken: kotlin.String? = null

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.polly.model.DescribeVoicesRequest) : this() {
            this.engine = x.engine
            this.includeAdditionalLanguageCodes = x.includeAdditionalLanguageCodes
            this.languageCode = x.languageCode
            this.nextToken = x.nextToken
        }

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

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