commonMain.aws.sdk.kotlin.services.rekognition.model.GetFaceDetectionResponse.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 GetFaceDetectionResponse private constructor(builder: Builder) {
    /**
     * An array of faces detected in the video. Each element contains a detected face's details and the time, in milliseconds from the start of the video, the face was detected.
     */
    public val faces: List? = builder.faces
    /**
     * Job identifier for the face detection operation for which you want to obtain results. The job identifer is returned by an initial call to StartFaceDetection.
     */
    public val jobId: kotlin.String? = builder.jobId
    /**
     * The current status of the face detection job.
     */
    public val jobStatus: aws.sdk.kotlin.services.rekognition.model.VideoJobStatus? = builder.jobStatus
    /**
     * A job identifier specified in the call to StartFaceDetection and returned in the job completion notification sent to your Amazon Simple Notification Service topic.
     */
    public val jobTag: kotlin.String? = builder.jobTag
    /**
     * If the response is truncated, Amazon Rekognition returns this token that you can use in the subsequent request to retrieve the next set of faces.
     */
    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 Video analyzed. `Videometadata` is returned in every page of paginated responses from a Amazon Rekognition video operation.
     */
    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.GetFaceDetectionResponse = Builder().apply(block).build()
    }

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

    override fun hashCode(): kotlin.Int {
        var result = faces?.hashCode() ?: 0
        result = 31 * result + (jobId?.hashCode() ?: 0)
        result = 31 * result + (jobStatus?.hashCode() ?: 0)
        result = 31 * result + (jobTag?.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 GetFaceDetectionResponse

        if (faces != other.faces) return false
        if (jobId != other.jobId) return false
        if (jobStatus != other.jobStatus) return false
        if (jobTag != other.jobTag) 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.GetFaceDetectionResponse = Builder(this).apply(block).build()

    @SdkDsl
    public class Builder {
        /**
         * An array of faces detected in the video. Each element contains a detected face's details and the time, in milliseconds from the start of the video, the face was detected.
         */
        public var faces: List? = null
        /**
         * Job identifier for the face detection operation for which you want to obtain results. The job identifer is returned by an initial call to StartFaceDetection.
         */
        public var jobId: kotlin.String? = null
        /**
         * The current status of the face detection job.
         */
        public var jobStatus: aws.sdk.kotlin.services.rekognition.model.VideoJobStatus? = null
        /**
         * A job identifier specified in the call to StartFaceDetection and returned in the job completion notification sent to your Amazon Simple Notification Service topic.
         */
        public var jobTag: kotlin.String? = null
        /**
         * If the response is truncated, Amazon Rekognition returns this token that you can use in the subsequent request to retrieve the next set of faces.
         */
        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 Video analyzed. `Videometadata` is returned in every page of paginated responses from a Amazon Rekognition video operation.
         */
        public var videoMetadata: aws.sdk.kotlin.services.rekognition.model.VideoMetadata? = null

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.rekognition.model.GetFaceDetectionResponse) : this() {
            this.faces = x.faces
            this.jobId = x.jobId
            this.jobStatus = x.jobStatus
            this.jobTag = x.jobTag
            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.GetFaceDetectionResponse = GetFaceDetectionResponse(this)

        /**
         * 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
        }
    }
}