commonMain.aws.sdk.kotlin.services.transcribe.model.GetVocabularyResponse.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of transcribe Show documentation
Amazon Transcribe Service
There is a newer version: 1.4.1
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!

package aws.sdk.kotlin.services.transcribe.model

import aws.smithy.kotlin.runtime.time.Instant

public class GetVocabularyResponse private constructor(builder: Builder) {
    /**
     * The S3 location where the vocabulary is stored; use this URI to view or download the vocabulary.
     */
    public val downloadUri: kotlin.String? = builder.downloadUri
    /**
     * If `VocabularyState` is `FAILED`, `FailureReason` contains information about why the vocabulary request failed. See also: [Common Errors](https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html).
     */
    public val failureReason: kotlin.String? = builder.failureReason
    /**
     * The language code you selected for your custom vocabulary.
     */
    public val languageCode: aws.sdk.kotlin.services.transcribe.model.LanguageCode? = builder.languageCode
    /**
     * The date and time the specified vocabulary was last modified.
     *
     * Timestamps are in the format `YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC`. For example, `2022-05-04T12:32:58.761000-07:00` represents 12:32 PM UTC-7 on May 4, 2022.
     */
    public val lastModifiedTime: aws.smithy.kotlin.runtime.time.Instant? = builder.lastModifiedTime
    /**
     * The name of the custom vocabulary you requested information about.
     */
    public val vocabularyName: kotlin.String? = builder.vocabularyName
    /**
     * The processing state of your custom vocabulary. If the state is `READY`, you can use the vocabulary in a `StartTranscriptionJob` request.
     */
    public val vocabularyState: aws.sdk.kotlin.services.transcribe.model.VocabularyState? = builder.vocabularyState

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

    override fun toString(): kotlin.String = buildString {
        append("GetVocabularyResponse(")
        append("downloadUri=$downloadUri,")
        append("failureReason=$failureReason,")
        append("languageCode=$languageCode,")
        append("lastModifiedTime=$lastModifiedTime,")
        append("vocabularyName=$vocabularyName,")
        append("vocabularyState=$vocabularyState)")
    }

    override fun hashCode(): kotlin.Int {
        var result = downloadUri?.hashCode() ?: 0
        result = 31 * result + (failureReason?.hashCode() ?: 0)
        result = 31 * result + (languageCode?.hashCode() ?: 0)
        result = 31 * result + (lastModifiedTime?.hashCode() ?: 0)
        result = 31 * result + (vocabularyName?.hashCode() ?: 0)
        result = 31 * result + (vocabularyState?.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 GetVocabularyResponse

        if (downloadUri != other.downloadUri) return false
        if (failureReason != other.failureReason) return false
        if (languageCode != other.languageCode) return false
        if (lastModifiedTime != other.lastModifiedTime) return false
        if (vocabularyName != other.vocabularyName) return false
        if (vocabularyState != other.vocabularyState) return false

        return true
    }

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

    public class Builder {
        /**
         * The S3 location where the vocabulary is stored; use this URI to view or download the vocabulary.
         */
        public var downloadUri: kotlin.String? = null
        /**
         * If `VocabularyState` is `FAILED`, `FailureReason` contains information about why the vocabulary request failed. See also: [Common Errors](https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html).
         */
        public var failureReason: kotlin.String? = null
        /**
         * The language code you selected for your custom vocabulary.
         */
        public var languageCode: aws.sdk.kotlin.services.transcribe.model.LanguageCode? = null
        /**
         * The date and time the specified vocabulary was last modified.
         *
         * Timestamps are in the format `YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC`. For example, `2022-05-04T12:32:58.761000-07:00` represents 12:32 PM UTC-7 on May 4, 2022.
         */
        public var lastModifiedTime: aws.smithy.kotlin.runtime.time.Instant? = null
        /**
         * The name of the custom vocabulary you requested information about.
         */
        public var vocabularyName: kotlin.String? = null
        /**
         * The processing state of your custom vocabulary. If the state is `READY`, you can use the vocabulary in a `StartTranscriptionJob` request.
         */
        public var vocabularyState: aws.sdk.kotlin.services.transcribe.model.VocabularyState? = null

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.transcribe.model.GetVocabularyResponse) : this() {
            this.downloadUri = x.downloadUri
            this.failureReason = x.failureReason
            this.languageCode = x.languageCode
            this.lastModifiedTime = x.lastModifiedTime
            this.vocabularyName = x.vocabularyName
            this.vocabularyState = x.vocabularyState
        }

        @PublishedApi
        internal fun build(): aws.sdk.kotlin.services.transcribe.model.GetVocabularyResponse = GetVocabularyResponse(this)
    }
}