aws.sdk.kotlin.services.transcribe.model.JobExecutionSettings.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.3.99
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!

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



/**
 * Provides information about when a transcription job should be executed.
 */
class JobExecutionSettings private constructor(builder: Builder) {
    /**
     * Indicates whether a job should be queued by Amazon Transcribe when the concurrent execution limit
     * is exceeded. When the AllowDeferredExecution field is true, jobs are queued
     * and executed when the number of executing jobs falls below the concurrent execution limit. If
     * the field is false, Amazon Transcribe returns a LimitExceededException exception.
     * Note that job queuing is enabled by default for call analytics jobs.
     * If you specify the AllowDeferredExecution field, you must specify the
     * DataAccessRoleArn field.
     */
    val allowDeferredExecution: kotlin.Boolean? = builder.allowDeferredExecution
    /**
     * The Amazon Resource Name (ARN), in the form
     * arn:partition:service:region:account-id:resource-type/resource-id, of a role
     * that has access to the S3 bucket that contains the input files. Amazon Transcribe assumes this role to
     * read queued media files. If you have specified an output S3 bucket for the transcription
     * results, this role should have access to the output bucket as well.
     * If you specify the AllowDeferredExecution field, you must specify the
     * DataAccessRoleArn field.
     */
    val dataAccessRoleArn: kotlin.String? = builder.dataAccessRoleArn

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

    override fun toString(): kotlin.String = buildString {
        append("JobExecutionSettings(")
        append("allowDeferredExecution=$allowDeferredExecution,")
        append("dataAccessRoleArn=$dataAccessRoleArn)")
    }

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

        if (allowDeferredExecution != other.allowDeferredExecution) return false
        if (dataAccessRoleArn != other.dataAccessRoleArn) return false

        return true
    }

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

    class Builder {
        /**
         * Indicates whether a job should be queued by Amazon Transcribe when the concurrent execution limit
         * is exceeded. When the AllowDeferredExecution field is true, jobs are queued
         * and executed when the number of executing jobs falls below the concurrent execution limit. If
         * the field is false, Amazon Transcribe returns a LimitExceededException exception.
         * Note that job queuing is enabled by default for call analytics jobs.
         * If you specify the AllowDeferredExecution field, you must specify the
         * DataAccessRoleArn field.
         */
        var allowDeferredExecution: kotlin.Boolean? = null
        /**
         * The Amazon Resource Name (ARN), in the form
         * arn:partition:service:region:account-id:resource-type/resource-id, of a role
         * that has access to the S3 bucket that contains the input files. Amazon Transcribe assumes this role to
         * read queued media files. If you have specified an output S3 bucket for the transcription
         * results, this role should have access to the output bucket as well.
         * If you specify the AllowDeferredExecution field, you must specify the
         * DataAccessRoleArn field.
         */
        var dataAccessRoleArn: kotlin.String? = null

        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.transcribe.model.JobExecutionSettings) : this() {
            this.allowDeferredExecution = x.allowDeferredExecution
            this.dataAccessRoleArn = x.dataAccessRoleArn
        }

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