commonMain.aws.sdk.kotlin.services.rekognition.model.DetectLabelsResponse.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 DetectLabelsResponse private constructor(builder: Builder) {
    /**
     * Information about the properties of the input image, such as brightness, sharpness, contrast, and dominant colors.
     */
    public val imageProperties: aws.sdk.kotlin.services.rekognition.model.DetectLabelsImageProperties? = builder.imageProperties
    /**
     * Version number of the label detection model that was used to detect labels.
     */
    public val labelModelVersion: kotlin.String? = builder.labelModelVersion
    /**
     * An array of labels for the real-world objects detected.
     */
    public val labels: List? = builder.labels
    /**
     * The value of `OrientationCorrection` is always null.
     *
     * If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.
     *
     * Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.
     */
    public val orientationCorrection: aws.sdk.kotlin.services.rekognition.model.OrientationCorrection? = builder.orientationCorrection

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

    override fun toString(): kotlin.String = buildString {
        append("DetectLabelsResponse(")
        append("imageProperties=$imageProperties,")
        append("labelModelVersion=$labelModelVersion,")
        append("labels=$labels,")
        append("orientationCorrection=$orientationCorrection")
        append(")")
    }

    override fun hashCode(): kotlin.Int {
        var result = imageProperties?.hashCode() ?: 0
        result = 31 * result + (labelModelVersion?.hashCode() ?: 0)
        result = 31 * result + (labels?.hashCode() ?: 0)
        result = 31 * result + (orientationCorrection?.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 DetectLabelsResponse

        if (imageProperties != other.imageProperties) return false
        if (labelModelVersion != other.labelModelVersion) return false
        if (labels != other.labels) return false
        if (orientationCorrection != other.orientationCorrection) return false

        return true
    }

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

    public class Builder {
        /**
         * Information about the properties of the input image, such as brightness, sharpness, contrast, and dominant colors.
         */
        public var imageProperties: aws.sdk.kotlin.services.rekognition.model.DetectLabelsImageProperties? = null
        /**
         * Version number of the label detection model that was used to detect labels.
         */
        public var labelModelVersion: kotlin.String? = null
        /**
         * An array of labels for the real-world objects detected.
         */
        public var labels: List? = null
        /**
         * The value of `OrientationCorrection` is always null.
         *
         * If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.
         *
         * Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.
         */
        public var orientationCorrection: aws.sdk.kotlin.services.rekognition.model.OrientationCorrection? = null

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.rekognition.model.DetectLabelsResponse) : this() {
            this.imageProperties = x.imageProperties
            this.labelModelVersion = x.labelModelVersion
            this.labels = x.labels
            this.orientationCorrection = x.orientationCorrection
        }

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

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

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