commonMain.aws.sdk.kotlin.services.cleanroomsml.model.StartAudienceGenerationJobRequest.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of cleanroomsml-jvm Show documentation
Show all versions of cleanroomsml-jvm Show documentation
The AWS SDK for Kotlin client for CleanRoomsML
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!
package aws.sdk.kotlin.services.cleanroomsml.model
import aws.smithy.kotlin.runtime.SdkDsl
public class StartAudienceGenerationJobRequest private constructor(builder: Builder) {
/**
* The identifier of the collaboration that contains the audience generation job.
*/
public val collaborationId: kotlin.String? = builder.collaborationId
/**
* The Amazon Resource Name (ARN) of the configured audience model that is used for this audience generation job.
*/
public val configuredAudienceModelArn: kotlin.String? = builder.configuredAudienceModelArn
/**
* The description of the audience generation job.
*/
public val description: kotlin.String? = builder.description
/**
* Whether the seed audience is included in the audience generation output.
*/
public val includeSeedInOutput: kotlin.Boolean? = builder.includeSeedInOutput
/**
* The name of the audience generation job.
*/
public val name: kotlin.String? = builder.name
/**
* The seed audience that is used to generate the audience.
*/
public val seedAudience: aws.sdk.kotlin.services.cleanroomsml.model.AudienceGenerationJobDataSource? = builder.seedAudience
/**
* The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
*
* The following basic restrictions apply to tags:
* + Maximum number of tags per resource - 50.
* + For each resource, each tag key must be unique, and each tag key can have only one value.
* + Maximum key length - 128 Unicode characters in UTF-8.
* + Maximum value length - 256 Unicode characters in UTF-8.
* + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
* + Tag keys and values are case sensitive.
* + Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
*/
public val tags: Map? = builder.tags
public companion object {
public operator fun invoke(block: Builder.() -> kotlin.Unit): aws.sdk.kotlin.services.cleanroomsml.model.StartAudienceGenerationJobRequest = Builder().apply(block).build()
}
override fun toString(): kotlin.String = buildString {
append("StartAudienceGenerationJobRequest(")
append("collaborationId=$collaborationId,")
append("configuredAudienceModelArn=$configuredAudienceModelArn,")
append("description=$description,")
append("includeSeedInOutput=$includeSeedInOutput,")
append("name=$name,")
append("seedAudience=$seedAudience,")
append("tags=$tags")
append(")")
}
override fun hashCode(): kotlin.Int {
var result = collaborationId?.hashCode() ?: 0
result = 31 * result + (configuredAudienceModelArn?.hashCode() ?: 0)
result = 31 * result + (description?.hashCode() ?: 0)
result = 31 * result + (includeSeedInOutput?.hashCode() ?: 0)
result = 31 * result + (name?.hashCode() ?: 0)
result = 31 * result + (seedAudience?.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 StartAudienceGenerationJobRequest
if (collaborationId != other.collaborationId) return false
if (configuredAudienceModelArn != other.configuredAudienceModelArn) return false
if (description != other.description) return false
if (includeSeedInOutput != other.includeSeedInOutput) return false
if (name != other.name) return false
if (seedAudience != other.seedAudience) return false
if (tags != other.tags) return false
return true
}
public inline fun copy(block: Builder.() -> kotlin.Unit = {}): aws.sdk.kotlin.services.cleanroomsml.model.StartAudienceGenerationJobRequest = Builder(this).apply(block).build()
@SdkDsl
public class Builder {
/**
* The identifier of the collaboration that contains the audience generation job.
*/
public var collaborationId: kotlin.String? = null
/**
* The Amazon Resource Name (ARN) of the configured audience model that is used for this audience generation job.
*/
public var configuredAudienceModelArn: kotlin.String? = null
/**
* The description of the audience generation job.
*/
public var description: kotlin.String? = null
/**
* Whether the seed audience is included in the audience generation output.
*/
public var includeSeedInOutput: kotlin.Boolean? = null
/**
* The name of the audience generation job.
*/
public var name: kotlin.String? = null
/**
* The seed audience that is used to generate the audience.
*/
public var seedAudience: aws.sdk.kotlin.services.cleanroomsml.model.AudienceGenerationJobDataSource? = null
/**
* The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
*
* The following basic restrictions apply to tags:
* + Maximum number of tags per resource - 50.
* + For each resource, each tag key must be unique, and each tag key can have only one value.
* + Maximum key length - 128 Unicode characters in UTF-8.
* + Maximum value length - 256 Unicode characters in UTF-8.
* + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
* + Tag keys and values are case sensitive.
* + Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
*/
public var tags: Map? = null
@PublishedApi
internal constructor()
@PublishedApi
internal constructor(x: aws.sdk.kotlin.services.cleanroomsml.model.StartAudienceGenerationJobRequest) : this() {
this.collaborationId = x.collaborationId
this.configuredAudienceModelArn = x.configuredAudienceModelArn
this.description = x.description
this.includeSeedInOutput = x.includeSeedInOutput
this.name = x.name
this.seedAudience = x.seedAudience
this.tags = x.tags
}
@PublishedApi
internal fun build(): aws.sdk.kotlin.services.cleanroomsml.model.StartAudienceGenerationJobRequest = StartAudienceGenerationJobRequest(this)
/**
* construct an [aws.sdk.kotlin.services.cleanroomsml.model.AudienceGenerationJobDataSource] inside the given [block]
*/
public fun seedAudience(block: aws.sdk.kotlin.services.cleanroomsml.model.AudienceGenerationJobDataSource.Builder.() -> kotlin.Unit) {
this.seedAudience = aws.sdk.kotlin.services.cleanroomsml.model.AudienceGenerationJobDataSource.invoke(block)
}
internal fun correctErrors(): Builder {
return this
}
}
}