commonMain.aws.sdk.kotlin.services.rekognition.model.RecognizeCelebritiesResponse.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 RecognizeCelebritiesResponse private constructor(builder: Builder) {
    /**
     * Details about each celebrity found in the image. Amazon Rekognition can detect a maximum of 64 celebrities in an image. Each celebrity object includes the following attributes: `Face`, `Confidence`, `Emotions`, `Landmarks`, `Pose`, `Quality`, `Smile`, `Id`, `KnownGender`, `MatchConfidence`, `Name`, `Urls`.
     */
    public val celebrityFaces: List? = builder.celebrityFaces
    /**
     * Support for estimating image orientation using the the OrientationCorrection field has ceased as of August 2021. Any returned values for this field included in an API response will always be NULL.
     *
     * The orientation of the input image (counterclockwise direction). If your application displays the image, you can use this value to correct the orientation. The bounding box coordinates returned in `CelebrityFaces` and `UnrecognizedFaces` represent face locations before the image orientation is corrected.
     *
     * If the input image is in .jpeg format, it might contain exchangeable image (Exif) metadata that includes the image's orientation. If so, and the Exif metadata for the input image populates the orientation field, the value of `OrientationCorrection` is null. The `CelebrityFaces` and `UnrecognizedFaces` bounding box coordinates represent face locations after Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.
     */
    public val orientationCorrection: aws.sdk.kotlin.services.rekognition.model.OrientationCorrection? = builder.orientationCorrection
    /**
     * Details about each unrecognized face in the image.
     */
    public val unrecognizedFaces: List? = builder.unrecognizedFaces

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

    override fun toString(): kotlin.String = buildString {
        append("RecognizeCelebritiesResponse(")
        append("celebrityFaces=$celebrityFaces,")
        append("orientationCorrection=$orientationCorrection,")
        append("unrecognizedFaces=$unrecognizedFaces")
        append(")")
    }

    override fun hashCode(): kotlin.Int {
        var result = celebrityFaces?.hashCode() ?: 0
        result = 31 * result + (orientationCorrection?.hashCode() ?: 0)
        result = 31 * result + (unrecognizedFaces?.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 RecognizeCelebritiesResponse

        if (celebrityFaces != other.celebrityFaces) return false
        if (orientationCorrection != other.orientationCorrection) return false
        if (unrecognizedFaces != other.unrecognizedFaces) return false

        return true
    }

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

    @SdkDsl
    public class Builder {
        /**
         * Details about each celebrity found in the image. Amazon Rekognition can detect a maximum of 64 celebrities in an image. Each celebrity object includes the following attributes: `Face`, `Confidence`, `Emotions`, `Landmarks`, `Pose`, `Quality`, `Smile`, `Id`, `KnownGender`, `MatchConfidence`, `Name`, `Urls`.
         */
        public var celebrityFaces: List? = null
        /**
         * Support for estimating image orientation using the the OrientationCorrection field has ceased as of August 2021. Any returned values for this field included in an API response will always be NULL.
         *
         * The orientation of the input image (counterclockwise direction). If your application displays the image, you can use this value to correct the orientation. The bounding box coordinates returned in `CelebrityFaces` and `UnrecognizedFaces` represent face locations before the image orientation is corrected.
         *
         * If the input image is in .jpeg format, it might contain exchangeable image (Exif) metadata that includes the image's orientation. If so, and the Exif metadata for the input image populates the orientation field, the value of `OrientationCorrection` is null. The `CelebrityFaces` and `UnrecognizedFaces` bounding box coordinates represent face locations after Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.
         */
        public var orientationCorrection: aws.sdk.kotlin.services.rekognition.model.OrientationCorrection? = null
        /**
         * Details about each unrecognized face in the image.
         */
        public var unrecognizedFaces: List? = null

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.rekognition.model.RecognizeCelebritiesResponse) : this() {
            this.celebrityFaces = x.celebrityFaces
            this.orientationCorrection = x.orientationCorrection
            this.unrecognizedFaces = x.unrecognizedFaces
        }

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

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