commonMain.aws.sdk.kotlin.services.rekognition.model.GetFaceSearchResponse.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 GetFaceSearchResponse private constructor(builder: Builder) {
    /**
     * Job identifier for the face search operation for which you want to obtain results. The job identifer is returned by an initial call to StartFaceSearch.
     */
    public val jobId: kotlin.String? = builder.jobId
    /**
     * The current status of the face search job.
     */
    public val jobStatus: aws.sdk.kotlin.services.rekognition.model.VideoJobStatus? = builder.jobStatus
    /**
     * A job identifier specified in the call to StartFaceSearch 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 Video returns this token that you can use in the subsequent request to retrieve the next set of search results.
     */
    public val nextToken: kotlin.String? = builder.nextToken
    /**
     * An array of persons, PersonMatch, in the video whose face(s) match the face(s) in an Amazon Rekognition collection. It also includes time information for when persons are matched in the video. You specify the input collection in an initial call to `StartFaceSearch`. Each `Persons` element includes a time the person was matched, face match details (`FaceMatches`) for matching faces in the collection, and person information (`Person`) for the matched person.
     */
    public val persons: List? = builder.persons
    /**
     * 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 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.GetFaceSearchResponse = Builder().apply(block).build()
    }

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

    override fun hashCode(): kotlin.Int {
        var 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 + (persons?.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 GetFaceSearchResponse

        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 (persons != other.persons) 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.GetFaceSearchResponse = Builder(this).apply(block).build()

    @SdkDsl
    public class Builder {
        /**
         * Job identifier for the face search operation for which you want to obtain results. The job identifer is returned by an initial call to StartFaceSearch.
         */
        public var jobId: kotlin.String? = null
        /**
         * The current status of the face search job.
         */
        public var jobStatus: aws.sdk.kotlin.services.rekognition.model.VideoJobStatus? = null
        /**
         * A job identifier specified in the call to StartFaceSearch 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 Video returns this token that you can use in the subsequent request to retrieve the next set of search results.
         */
        public var nextToken: kotlin.String? = null
        /**
         * An array of persons, PersonMatch, in the video whose face(s) match the face(s) in an Amazon Rekognition collection. It also includes time information for when persons are matched in the video. You specify the input collection in an initial call to `StartFaceSearch`. Each `Persons` element includes a time the person was matched, face match details (`FaceMatches`) for matching faces in the collection, and person information (`Person`) for the matched person.
         */
        public var persons: List? = 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 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.GetFaceSearchResponse) : this() {
            this.jobId = x.jobId
            this.jobStatus = x.jobStatus
            this.jobTag = x.jobTag
            this.nextToken = x.nextToken
            this.persons = x.persons
            this.statusMessage = x.statusMessage
            this.video = x.video
            this.videoMetadata = x.videoMetadata
        }

        @PublishedApi
        internal fun build(): aws.sdk.kotlin.services.rekognition.model.GetFaceSearchResponse = GetFaceSearchResponse(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
        }
    }
}