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

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

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



public class GetContentModerationResponse private constructor(builder: Builder) {
    /**
     * Information about the paramters used when getting a response. Includes information on aggregation and sorting methods.
     */
    public val getRequestMetadata: aws.sdk.kotlin.services.rekognition.model.GetContentModerationRequestMetadata? = builder.getRequestMetadata
    /**
     * Job identifier for the content moderation operation for which you want to obtain results. The job identifer is returned by an initial call to StartContentModeration.
     */
    public val jobId: kotlin.String? = builder.jobId
    /**
     * The current status of the content moderation analysis job.
     */
    public val jobStatus: aws.sdk.kotlin.services.rekognition.model.VideoJobStatus? = builder.jobStatus
    /**
     * A job identifier specified in the call to StartContentModeration and returned in the job completion notification sent to your Amazon Simple Notification Service topic.
     */
    public val jobTag: kotlin.String? = builder.jobTag
    /**
     * The detected inappropriate, unwanted, or offensive content moderation labels and the time(s) they were detected.
     */
    public val moderationLabels: List? = builder.moderationLabels
    /**
     * Version number of the moderation detection model that was used to detect inappropriate, unwanted, or offensive content.
     */
    public val moderationModelVersion: kotlin.String? = builder.moderationModelVersion
    /**
     * If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of content moderation labels.
     */
    public val nextToken: kotlin.String? = builder.nextToken
    /**
     * If the job fails, `StatusMessage` provides a descriptive error message.
     */
    public val statusMessage: kotlin.String? = builder.statusMessage
    /**
     * Video file stored in an Amazon S3 bucket. Amazon Rekognition video start operations such as StartLabelDetection use `Video` to specify a video for analysis. The supported file formats are .mp4, .mov and .avi.
     */
    public val video: aws.sdk.kotlin.services.rekognition.model.Video? = builder.video
    /**
     * Information about a video that Amazon Rekognition analyzed. `Videometadata` is returned in every page of paginated responses from `GetContentModeration`.
     */
    public val videoMetadata: aws.sdk.kotlin.services.rekognition.model.VideoMetadata? = builder.videoMetadata

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

    override fun toString(): kotlin.String = buildString {
        append("GetContentModerationResponse(")
        append("getRequestMetadata=$getRequestMetadata,")
        append("jobId=$jobId,")
        append("jobStatus=$jobStatus,")
        append("jobTag=$jobTag,")
        append("moderationLabels=$moderationLabels,")
        append("moderationModelVersion=$moderationModelVersion,")
        append("nextToken=$nextToken,")
        append("statusMessage=$statusMessage,")
        append("video=$video,")
        append("videoMetadata=$videoMetadata")
        append(")")
    }

    override fun hashCode(): kotlin.Int {
        var result = getRequestMetadata?.hashCode() ?: 0
        result = 31 * result + (jobId?.hashCode() ?: 0)
        result = 31 * result + (jobStatus?.hashCode() ?: 0)
        result = 31 * result + (jobTag?.hashCode() ?: 0)
        result = 31 * result + (moderationLabels?.hashCode() ?: 0)
        result = 31 * result + (moderationModelVersion?.hashCode() ?: 0)
        result = 31 * result + (nextToken?.hashCode() ?: 0)
        result = 31 * result + (statusMessage?.hashCode() ?: 0)
        result = 31 * result + (video?.hashCode() ?: 0)
        result = 31 * result + (videoMetadata?.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 GetContentModerationResponse

        if (getRequestMetadata != other.getRequestMetadata) return false
        if (jobId != other.jobId) return false
        if (jobStatus != other.jobStatus) return false
        if (jobTag != other.jobTag) return false
        if (moderationLabels != other.moderationLabels) return false
        if (moderationModelVersion != other.moderationModelVersion) return false
        if (nextToken != other.nextToken) return false
        if (statusMessage != other.statusMessage) return false
        if (video != other.video) return false
        if (videoMetadata != other.videoMetadata) return false

        return true
    }

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

    public class Builder {
        /**
         * Information about the paramters used when getting a response. Includes information on aggregation and sorting methods.
         */
        public var getRequestMetadata: aws.sdk.kotlin.services.rekognition.model.GetContentModerationRequestMetadata? = null
        /**
         * Job identifier for the content moderation operation for which you want to obtain results. The job identifer is returned by an initial call to StartContentModeration.
         */
        public var jobId: kotlin.String? = null
        /**
         * The current status of the content moderation analysis job.
         */
        public var jobStatus: aws.sdk.kotlin.services.rekognition.model.VideoJobStatus? = null
        /**
         * A job identifier specified in the call to StartContentModeration and returned in the job completion notification sent to your Amazon Simple Notification Service topic.
         */
        public var jobTag: kotlin.String? = null
        /**
         * The detected inappropriate, unwanted, or offensive content moderation labels and the time(s) they were detected.
         */
        public var moderationLabels: List? = null
        /**
         * Version number of the moderation detection model that was used to detect inappropriate, unwanted, or offensive content.
         */
        public var moderationModelVersion: kotlin.String? = null
        /**
         * If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of content moderation labels.
         */
        public var nextToken: kotlin.String? = null
        /**
         * If the job fails, `StatusMessage` provides a descriptive error message.
         */
        public var statusMessage: kotlin.String? = null
        /**
         * Video file stored in an Amazon S3 bucket. Amazon Rekognition video start operations such as StartLabelDetection use `Video` to specify a video for analysis. The supported file formats are .mp4, .mov and .avi.
         */
        public var video: aws.sdk.kotlin.services.rekognition.model.Video? = null
        /**
         * Information about a video that Amazon Rekognition analyzed. `Videometadata` is returned in every page of paginated responses from `GetContentModeration`.
         */
        public var videoMetadata: aws.sdk.kotlin.services.rekognition.model.VideoMetadata? = null

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.rekognition.model.GetContentModerationResponse) : this() {
            this.getRequestMetadata = x.getRequestMetadata
            this.jobId = x.jobId
            this.jobStatus = x.jobStatus
            this.jobTag = x.jobTag
            this.moderationLabels = x.moderationLabels
            this.moderationModelVersion = x.moderationModelVersion
            this.nextToken = x.nextToken
            this.statusMessage = x.statusMessage
            this.video = x.video
            this.videoMetadata = x.videoMetadata
        }

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

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

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

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

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