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

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

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



/**
 * Face details inferred from the image but not used for search. The response attribute contains reasons for why a face wasn't used for Search.
 */
public class UnsearchedFace private constructor(builder: Builder) {
    /**
     * Structure containing attributes of the face that the algorithm detected.
     *
     * A `FaceDetail` object contains either the default facial attributes or all facial attributes. The default attributes are `BoundingBox`, `Confidence`, `Landmarks`, `Pose`, and `Quality`.
     *
     * GetFaceDetection is the only Amazon Rekognition Video stored video operation that can return a `FaceDetail` object with all attributes. To specify which attributes to return, use the `FaceAttributes` input parameter for StartFaceDetection. The following Amazon Rekognition Video operations return only the default attributes. The corresponding Start operations don't have a `FaceAttributes` input parameter:
     * + GetCelebrityRecognition
     * + GetPersonTracking
     * + GetFaceSearch
     *
     * The Amazon Rekognition Image DetectFaces and IndexFaces operations can return all facial attributes. To specify which attributes to return, use the `Attributes` input parameter for `DetectFaces`. For `IndexFaces`, use the `DetectAttributes` input parameter.
     */
    public val faceDetails: aws.sdk.kotlin.services.rekognition.model.FaceDetail? = builder.faceDetails
    /**
     * Reasons why a face wasn't used for Search.
     */
    public val reasons: List? = builder.reasons

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

    override fun toString(): kotlin.String = buildString {
        append("UnsearchedFace(")
        append("faceDetails=$faceDetails,")
        append("reasons=$reasons")
        append(")")
    }

    override fun hashCode(): kotlin.Int {
        var result = faceDetails?.hashCode() ?: 0
        result = 31 * result + (reasons?.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 UnsearchedFace

        if (faceDetails != other.faceDetails) return false
        if (reasons != other.reasons) return false

        return true
    }

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

    public class Builder {
        /**
         * Structure containing attributes of the face that the algorithm detected.
         *
         * A `FaceDetail` object contains either the default facial attributes or all facial attributes. The default attributes are `BoundingBox`, `Confidence`, `Landmarks`, `Pose`, and `Quality`.
         *
         * GetFaceDetection is the only Amazon Rekognition Video stored video operation that can return a `FaceDetail` object with all attributes. To specify which attributes to return, use the `FaceAttributes` input parameter for StartFaceDetection. The following Amazon Rekognition Video operations return only the default attributes. The corresponding Start operations don't have a `FaceAttributes` input parameter:
         * + GetCelebrityRecognition
         * + GetPersonTracking
         * + GetFaceSearch
         *
         * The Amazon Rekognition Image DetectFaces and IndexFaces operations can return all facial attributes. To specify which attributes to return, use the `Attributes` input parameter for `DetectFaces`. For `IndexFaces`, use the `DetectAttributes` input parameter.
         */
        public var faceDetails: aws.sdk.kotlin.services.rekognition.model.FaceDetail? = null
        /**
         * Reasons why a face wasn't used for Search.
         */
        public var reasons: List? = null

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.rekognition.model.UnsearchedFace) : this() {
            this.faceDetails = x.faceDetails
            this.reasons = x.reasons
        }

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

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

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