commonMain.aws.sdk.kotlin.services.rekognition.model.GetContentModerationRequest.kt Maven / Gradle / Ivy

Go to download
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!

package aws.sdk.kotlin.services.rekognition.model

import aws.smithy.kotlin.runtime.SdkDsl

public class GetContentModerationRequest private constructor(builder: Builder) {
    /**
     * Defines how to aggregate results of the StartContentModeration request. Default aggregation option is TIMESTAMPS. SEGMENTS mode aggregates moderation labels over time.
     */
    public val aggregateBy: aws.sdk.kotlin.services.rekognition.model.ContentModerationAggregateBy? = builder.aggregateBy
    /**
     * The identifier for the inappropriate, unwanted, or offensive content moderation job. Use `JobId` to identify the job in a subsequent call to `GetContentModeration`.
     */
    public val jobId: kotlin.String? = builder.jobId
    /**
     * Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.
     */
    public val maxResults: kotlin.Int? = builder.maxResults
    /**
     * If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of content moderation labels.
     */
    public val nextToken: kotlin.String? = builder.nextToken
    /**
     * Sort to use for elements in the `ModerationLabelDetections` array. Use `TIMESTAMP` to sort array elements by the time labels are detected. Use `NAME` to alphabetically group elements for a label together. Within each label group, the array element are sorted by detection confidence. The default sort is by `TIMESTAMP`.
     */
    public val sortBy: aws.sdk.kotlin.services.rekognition.model.ContentModerationSortBy? = builder.sortBy

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

    override fun toString(): kotlin.String = buildString {
        append("GetContentModerationRequest(")
        append("aggregateBy=$aggregateBy,")
        append("jobId=$jobId,")
        append("maxResults=$maxResults,")
        append("nextToken=$nextToken,")
        append("sortBy=$sortBy")
        append(")")
    }

    override fun hashCode(): kotlin.Int {
        var result = aggregateBy?.hashCode() ?: 0
        result = 31 * result + (jobId?.hashCode() ?: 0)
        result = 31 * result + (maxResults ?: 0)
        result = 31 * result + (nextToken?.hashCode() ?: 0)
        result = 31 * result + (sortBy?.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 GetContentModerationRequest

        if (aggregateBy != other.aggregateBy) return false
        if (jobId != other.jobId) return false
        if (maxResults != other.maxResults) return false
        if (nextToken != other.nextToken) return false
        if (sortBy != other.sortBy) return false

        return true
    }

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

    @SdkDsl
    public class Builder {
        /**
         * Defines how to aggregate results of the StartContentModeration request. Default aggregation option is TIMESTAMPS. SEGMENTS mode aggregates moderation labels over time.
         */
        public var aggregateBy: aws.sdk.kotlin.services.rekognition.model.ContentModerationAggregateBy? = null
        /**
         * The identifier for the inappropriate, unwanted, or offensive content moderation job. Use `JobId` to identify the job in a subsequent call to `GetContentModeration`.
         */
        public var jobId: kotlin.String? = null
        /**
         * Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.
         */
        public var maxResults: kotlin.Int? = null
        /**
         * If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of content moderation labels.
         */
        public var nextToken: kotlin.String? = null
        /**
         * Sort to use for elements in the `ModerationLabelDetections` array. Use `TIMESTAMP` to sort array elements by the time labels are detected. Use `NAME` to alphabetically group elements for a label together. Within each label group, the array element are sorted by detection confidence. The default sort is by `TIMESTAMP`.
         */
        public var sortBy: aws.sdk.kotlin.services.rekognition.model.ContentModerationSortBy? = null

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.rekognition.model.GetContentModerationRequest) : this() {
            this.aggregateBy = x.aggregateBy
            this.jobId = x.jobId
            this.maxResults = x.maxResults
            this.nextToken = x.nextToken
            this.sortBy = x.sortBy
        }

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

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