commonMain.aws.sdk.kotlin.services.comprehendmedical.model.Entity.kt Maven / Gradle / Ivy

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

package aws.sdk.kotlin.services.comprehendmedical.model



/**
 * Provides information about an extracted medical entity.
 */
public class Entity private constructor(builder: Builder) {
    /**
     * The extracted attributes that relate to this entity.
     */
    public val attributes: List? = builder.attributes
    /**
     * The 0-based character offset in the input text that shows where the entity begins. The offset returns the UTF-8 code point in the string.
     */
    public val beginOffset: kotlin.Int? = builder.beginOffset
    /**
     * The category of the entity.
     */
    public val category: aws.sdk.kotlin.services.comprehendmedical.model.EntityType? = builder.category
    /**
     * The 0-based character offset in the input text that shows where the entity ends. The offset returns the UTF-8 code point in the string.
     */
    public val endOffset: kotlin.Int? = builder.endOffset
    /**
     * The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.
     */
    public val id: kotlin.Int? = builder.id
    /**
     * The level of confidence that Amazon Comprehend Medical has in the accuracy of the detection.
     */
    public val score: kotlin.Float? = builder.score
    /**
     * The segment of input text extracted as this entity.
     */
    public val text: kotlin.String? = builder.text
    /**
     * Contextual information for the entity.
     */
    public val traits: List? = builder.traits
    /**
     * Describes the specific type of entity with category of entities.
     */
    public val type: aws.sdk.kotlin.services.comprehendmedical.model.EntitySubType? = builder.type

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

    override fun toString(): kotlin.String = buildString {
        append("Entity(")
        append("attributes=$attributes,")
        append("beginOffset=$beginOffset,")
        append("category=$category,")
        append("endOffset=$endOffset,")
        append("id=$id,")
        append("score=$score,")
        append("text=$text,")
        append("traits=$traits,")
        append("type=$type")
        append(")")
    }

    override fun hashCode(): kotlin.Int {
        var result = attributes?.hashCode() ?: 0
        result = 31 * result + (beginOffset ?: 0)
        result = 31 * result + (category?.hashCode() ?: 0)
        result = 31 * result + (endOffset ?: 0)
        result = 31 * result + (id ?: 0)
        result = 31 * result + (score?.hashCode() ?: 0)
        result = 31 * result + (text?.hashCode() ?: 0)
        result = 31 * result + (traits?.hashCode() ?: 0)
        result = 31 * result + (type?.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 Entity

        if (attributes != other.attributes) return false
        if (beginOffset != other.beginOffset) return false
        if (category != other.category) return false
        if (endOffset != other.endOffset) return false
        if (id != other.id) return false
        if (score != other.score) return false
        if (text != other.text) return false
        if (traits != other.traits) return false
        if (type != other.type) return false

        return true
    }

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

    public class Builder {
        /**
         * The extracted attributes that relate to this entity.
         */
        public var attributes: List? = null
        /**
         * The 0-based character offset in the input text that shows where the entity begins. The offset returns the UTF-8 code point in the string.
         */
        public var beginOffset: kotlin.Int? = null
        /**
         * The category of the entity.
         */
        public var category: aws.sdk.kotlin.services.comprehendmedical.model.EntityType? = null
        /**
         * The 0-based character offset in the input text that shows where the entity ends. The offset returns the UTF-8 code point in the string.
         */
        public var endOffset: kotlin.Int? = null
        /**
         * The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.
         */
        public var id: kotlin.Int? = null
        /**
         * The level of confidence that Amazon Comprehend Medical has in the accuracy of the detection.
         */
        public var score: kotlin.Float? = null
        /**
         * The segment of input text extracted as this entity.
         */
        public var text: kotlin.String? = null
        /**
         * Contextual information for the entity.
         */
        public var traits: List? = null
        /**
         * Describes the specific type of entity with category of entities.
         */
        public var type: aws.sdk.kotlin.services.comprehendmedical.model.EntitySubType? = null

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.comprehendmedical.model.Entity) : this() {
            this.attributes = x.attributes
            this.beginOffset = x.beginOffset
            this.category = x.category
            this.endOffset = x.endOffset
            this.id = x.id
            this.score = x.score
            this.text = x.text
            this.traits = x.traits
            this.type = x.type
        }

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

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