commonMain.aws.sdk.kotlin.services.personalize.model.CreateBatchSegmentJobRequest.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of personalize-jvm Show documentation
The AWS SDK for Kotlin client for Personalize
The newest version!
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!

package aws.sdk.kotlin.services.personalize.model

import aws.smithy.kotlin.runtime.SdkDsl

public class CreateBatchSegmentJobRequest private constructor(builder: Builder) {
    /**
     * The ARN of the filter to apply to the batch segment job. For more information on using filters, see [Filtering batch recommendations](https://docs.aws.amazon.com/personalize/latest/dg/filter-batch.html).
     */
    public val filterArn: kotlin.String? = builder.filterArn
    /**
     * The Amazon S3 path for the input data used to generate the batch segment job.
     */
    public val jobInput: aws.sdk.kotlin.services.personalize.model.BatchSegmentJobInput? = builder.jobInput
    /**
     * The name of the batch segment job to create.
     */
    public val jobName: kotlin.String? = builder.jobName
    /**
     * The Amazon S3 path for the bucket where the job's output will be stored.
     */
    public val jobOutput: aws.sdk.kotlin.services.personalize.model.BatchSegmentJobOutput? = builder.jobOutput
    /**
     * The number of predicted users generated by the batch segment job for each line of input data. The maximum number of users per segment is 5 million.
     */
    public val numResults: kotlin.Int? = builder.numResults
    /**
     * The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and output Amazon S3 buckets respectively.
     */
    public val roleArn: kotlin.String? = builder.roleArn
    /**
     * The Amazon Resource Name (ARN) of the solution version you want the batch segment job to use to generate batch segments.
     */
    public val solutionVersionArn: kotlin.String? = builder.solutionVersionArn
    /**
     * A list of [tags](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html) to apply to the batch segment job.
     */
    public val tags: List? = builder.tags

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

    override fun toString(): kotlin.String = buildString {
        append("CreateBatchSegmentJobRequest(")
        append("filterArn=$filterArn,")
        append("jobInput=$jobInput,")
        append("jobName=$jobName,")
        append("jobOutput=$jobOutput,")
        append("numResults=$numResults,")
        append("roleArn=$roleArn,")
        append("solutionVersionArn=$solutionVersionArn,")
        append("tags=$tags")
        append(")")
    }

    override fun hashCode(): kotlin.Int {
        var result = filterArn?.hashCode() ?: 0
        result = 31 * result + (jobInput?.hashCode() ?: 0)
        result = 31 * result + (jobName?.hashCode() ?: 0)
        result = 31 * result + (jobOutput?.hashCode() ?: 0)
        result = 31 * result + (numResults ?: 0)
        result = 31 * result + (roleArn?.hashCode() ?: 0)
        result = 31 * result + (solutionVersionArn?.hashCode() ?: 0)
        result = 31 * result + (tags?.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 CreateBatchSegmentJobRequest

        if (filterArn != other.filterArn) return false
        if (jobInput != other.jobInput) return false
        if (jobName != other.jobName) return false
        if (jobOutput != other.jobOutput) return false
        if (numResults != other.numResults) return false
        if (roleArn != other.roleArn) return false
        if (solutionVersionArn != other.solutionVersionArn) return false
        if (tags != other.tags) return false

        return true
    }

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

    @SdkDsl
    public class Builder {
        /**
         * The ARN of the filter to apply to the batch segment job. For more information on using filters, see [Filtering batch recommendations](https://docs.aws.amazon.com/personalize/latest/dg/filter-batch.html).
         */
        public var filterArn: kotlin.String? = null
        /**
         * The Amazon S3 path for the input data used to generate the batch segment job.
         */
        public var jobInput: aws.sdk.kotlin.services.personalize.model.BatchSegmentJobInput? = null
        /**
         * The name of the batch segment job to create.
         */
        public var jobName: kotlin.String? = null
        /**
         * The Amazon S3 path for the bucket where the job's output will be stored.
         */
        public var jobOutput: aws.sdk.kotlin.services.personalize.model.BatchSegmentJobOutput? = null
        /**
         * The number of predicted users generated by the batch segment job for each line of input data. The maximum number of users per segment is 5 million.
         */
        public var numResults: kotlin.Int? = null
        /**
         * The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and output Amazon S3 buckets respectively.
         */
        public var roleArn: kotlin.String? = null
        /**
         * The Amazon Resource Name (ARN) of the solution version you want the batch segment job to use to generate batch segments.
         */
        public var solutionVersionArn: kotlin.String? = null
        /**
         * A list of [tags](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html) to apply to the batch segment job.
         */
        public var tags: List? = null

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.personalize.model.CreateBatchSegmentJobRequest) : this() {
            this.filterArn = x.filterArn
            this.jobInput = x.jobInput
            this.jobName = x.jobName
            this.jobOutput = x.jobOutput
            this.numResults = x.numResults
            this.roleArn = x.roleArn
            this.solutionVersionArn = x.solutionVersionArn
            this.tags = x.tags
        }

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

        /**
         * construct an [aws.sdk.kotlin.services.personalize.model.BatchSegmentJobInput] inside the given [block]
         */
        public fun jobInput(block: aws.sdk.kotlin.services.personalize.model.BatchSegmentJobInput.Builder.() -> kotlin.Unit) {
            this.jobInput = aws.sdk.kotlin.services.personalize.model.BatchSegmentJobInput.invoke(block)
        }

        /**
         * construct an [aws.sdk.kotlin.services.personalize.model.BatchSegmentJobOutput] inside the given [block]
         */
        public fun jobOutput(block: aws.sdk.kotlin.services.personalize.model.BatchSegmentJobOutput.Builder.() -> kotlin.Unit) {
            this.jobOutput = aws.sdk.kotlin.services.personalize.model.BatchSegmentJobOutput.invoke(block)
        }

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