commonMain.aws.sdk.kotlin.services.gamelift.model.PriorityConfiguration.kt Maven / Gradle / Ivy

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

package aws.sdk.kotlin.services.gamelift.model



/**
 * Custom prioritization settings for use by a game session queue when placing new game sessions with available game servers. When defined, this configuration replaces the default FleetIQ prioritization process, which is as follows:
 * + If player latency data is included in a game session request, destinations and locations are prioritized first based on lowest average latency (1), then on lowest hosting cost (2), then on destination list order (3), and finally on location (alphabetical) (4). This approach ensures that the queue's top priority is to place game sessions where average player latency is lowest, and--if latency is the same--where the hosting cost is less, etc.
 * + If player latency data is not included, destinations and locations are prioritized first on destination list order (1), and then on location (alphabetical) (2). This approach ensures that the queue's top priority is to place game sessions on the first destination fleet listed. If that fleet has multiple locations, the game session is placed on the first location (when listed alphabetically).
 *
 * Changing the priority order will affect how game sessions are placed.
 */
public class PriorityConfiguration private constructor(builder: Builder) {
    /**
     * The prioritization order to use for fleet locations, when the `PriorityOrder` property includes `LOCATION`. Locations are identified by Amazon Web Services Region codes such as `us-west-2`. Each location can only be listed once.
     */
    public val locationOrder: List? = builder.locationOrder
    /**
     * The recommended sequence to use when prioritizing where to place new game sessions. Each type can only be listed once.
     * + `LATENCY` -- FleetIQ prioritizes locations where the average player latency (provided in each game session request) is lowest.
     * + `COST` -- FleetIQ prioritizes destinations with the lowest current hosting costs. Cost is evaluated based on the location, instance type, and fleet type (Spot or On-Demand) for each destination in the queue.
     * + `DESTINATION` -- FleetIQ prioritizes based on the order that destinations are listed in the queue configuration.
     * + `LOCATION` -- FleetIQ prioritizes based on the provided order of locations, as defined in `LocationOrder`.
     */
    public val priorityOrder: List? = builder.priorityOrder

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

    override fun toString(): kotlin.String = buildString {
        append("PriorityConfiguration(")
        append("locationOrder=$locationOrder,")
        append("priorityOrder=$priorityOrder")
        append(")")
    }

    override fun hashCode(): kotlin.Int {
        var result = locationOrder?.hashCode() ?: 0
        result = 31 * result + (priorityOrder?.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 PriorityConfiguration

        if (locationOrder != other.locationOrder) return false
        if (priorityOrder != other.priorityOrder) return false

        return true
    }

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

    public class Builder {
        /**
         * The prioritization order to use for fleet locations, when the `PriorityOrder` property includes `LOCATION`. Locations are identified by Amazon Web Services Region codes such as `us-west-2`. Each location can only be listed once.
         */
        public var locationOrder: List? = null
        /**
         * The recommended sequence to use when prioritizing where to place new game sessions. Each type can only be listed once.
         * + `LATENCY` -- FleetIQ prioritizes locations where the average player latency (provided in each game session request) is lowest.
         * + `COST` -- FleetIQ prioritizes destinations with the lowest current hosting costs. Cost is evaluated based on the location, instance type, and fleet type (Spot or On-Demand) for each destination in the queue.
         * + `DESTINATION` -- FleetIQ prioritizes based on the order that destinations are listed in the queue configuration.
         * + `LOCATION` -- FleetIQ prioritizes based on the provided order of locations, as defined in `LocationOrder`.
         */
        public var priorityOrder: List? = null

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.gamelift.model.PriorityConfiguration) : this() {
            this.locationOrder = x.locationOrder
            this.priorityOrder = x.priorityOrder
        }

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

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