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

Show more of this group Show more artifacts with this name
Show all versions of rekognition-jvm Show documentation
The AWS SDK for Kotlin client for Rekognition
There is a newer version: 1.3.35
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!

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

import aws.smithy.kotlin.runtime.SdkDsl

public class GetPersonTrackingRequest private constructor(builder: Builder) {
    /**
     * The identifier for a job that tracks persons in a video. You get the `JobId` from a call to `StartPersonTracking`.
     */
    public val jobId: kotlin.String? = builder.jobId
    /**
     * Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.
     */
    public val maxResults: kotlin.Int? = builder.maxResults
    /**
     * If the previous response was incomplete (because there are more persons to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of persons.
     */
    public val nextToken: kotlin.String? = builder.nextToken
    /**
     * Sort to use for elements in the `Persons` array. Use `TIMESTAMP` to sort array elements by the time persons are detected. Use `INDEX` to sort by the tracked persons. If you sort by `INDEX`, the array elements for each person are sorted by detection confidence. The default sort is by `TIMESTAMP`.
     */
    public val sortBy: aws.sdk.kotlin.services.rekognition.model.PersonTrackingSortBy? = builder.sortBy

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

    override fun toString(): kotlin.String = buildString {
        append("GetPersonTrackingRequest(")
        append("jobId=$jobId,")
        append("maxResults=$maxResults,")
        append("nextToken=$nextToken,")
        append("sortBy=$sortBy")
        append(")")
    }

    override fun hashCode(): kotlin.Int {
        var result = jobId?.hashCode() ?: 0
        result = 31 * result + (maxResults ?: 0)
        result = 31 * result + (nextToken?.hashCode() ?: 0)
        result = 31 * result + (sortBy?.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 GetPersonTrackingRequest

        if (jobId != other.jobId) return false
        if (maxResults != other.maxResults) return false
        if (nextToken != other.nextToken) return false
        if (sortBy != other.sortBy) return false

        return true
    }

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

    @SdkDsl
    public class Builder {
        /**
         * The identifier for a job that tracks persons in a video. You get the `JobId` from a call to `StartPersonTracking`.
         */
        public var jobId: kotlin.String? = null
        /**
         * Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.
         */
        public var maxResults: kotlin.Int? = null
        /**
         * If the previous response was incomplete (because there are more persons to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of persons.
         */
        public var nextToken: kotlin.String? = null
        /**
         * Sort to use for elements in the `Persons` array. Use `TIMESTAMP` to sort array elements by the time persons are detected. Use `INDEX` to sort by the tracked persons. If you sort by `INDEX`, the array elements for each person are sorted by detection confidence. The default sort is by `TIMESTAMP`.
         */
        public var sortBy: aws.sdk.kotlin.services.rekognition.model.PersonTrackingSortBy? = null

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.rekognition.model.GetPersonTrackingRequest) : this() {
            this.jobId = x.jobId
            this.maxResults = x.maxResults
            this.nextToken = x.nextToken
            this.sortBy = x.sortBy
        }

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

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