commonMain.aws.sdk.kotlin.services.rekognition.model.SearchFacesRequest.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 SearchFacesRequest private constructor(builder: Builder) {
    /**
     * ID of the collection the face belongs to.
     */
    public val collectionId: kotlin.String? = builder.collectionId
    /**
     * ID of a face to find matches for in the collection.
     */
    public val faceId: kotlin.String? = builder.faceId
    /**
     * Optional value specifying the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%.
     */
    public val faceMatchThreshold: kotlin.Float? = builder.faceMatchThreshold
    /**
     * Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.
     */
    public val maxFaces: kotlin.Int? = builder.maxFaces

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

    override fun toString(): kotlin.String = buildString {
        append("SearchFacesRequest(")
        append("collectionId=$collectionId,")
        append("faceId=$faceId,")
        append("faceMatchThreshold=$faceMatchThreshold,")
        append("maxFaces=$maxFaces")
        append(")")
    }

    override fun hashCode(): kotlin.Int {
        var result = collectionId?.hashCode() ?: 0
        result = 31 * result + (faceId?.hashCode() ?: 0)
        result = 31 * result + (faceMatchThreshold?.hashCode() ?: 0)
        result = 31 * result + (maxFaces ?: 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 SearchFacesRequest

        if (collectionId != other.collectionId) return false
        if (faceId != other.faceId) return false
        if (faceMatchThreshold != other.faceMatchThreshold) return false
        if (maxFaces != other.maxFaces) return false

        return true
    }

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

    public class Builder {
        /**
         * ID of the collection the face belongs to.
         */
        public var collectionId: kotlin.String? = null
        /**
         * ID of a face to find matches for in the collection.
         */
        public var faceId: kotlin.String? = null
        /**
         * Optional value specifying the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%.
         */
        public var faceMatchThreshold: kotlin.Float? = null
        /**
         * Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.
         */
        public var maxFaces: kotlin.Int? = null

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.rekognition.model.SearchFacesRequest) : this() {
            this.collectionId = x.collectionId
            this.faceId = x.faceId
            this.faceMatchThreshold = x.faceMatchThreshold
            this.maxFaces = x.maxFaces
        }

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

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