Package software.amazon.awssdk.services.gamelift.model

Class PriorityConfiguration

  • All Implemented Interfaces:
    Serializable, SdkPojo, ToCopyableBuilder<PriorityConfiguration.Builder,​PriorityConfiguration>
    @Generated("software.amazon.awssdk:codegen")
public final class PriorityConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<PriorityConfiguration.Builder,​PriorityConfiguration>

    Custom prioritization settings for a game session queue to use when searching for available game servers to place new game sessions. This configuration replaces the default FleetIQ prioritization process.

    By default, a queue makes placements based on the following default prioritizations:

    • If player latency data is included in a game session request, Amazon GameLift prioritizes placing game sessions where the average player latency is lowest. Amazon GameLift re-orders the queue's destinations and locations (for multi-location fleets) based on the following priorities: (1) the lowest average latency across all players, (2) the lowest hosting cost, (3) the queue's default destination order, and then (4), an alphabetic list of locations.

    • If player latency data is not included, Amazon GameLift prioritizes placing game sessions in the queue's first destination. If that fleet has multiple locations, the game session is placed on the first location (when listed alphabetically). Amazon GameLift re-orders the queue's destinations and locations (for multi-location fleets) based on the following priorities: (1) the queue's default destination order, and then (2) an alphabetic list of locations.

    See Also:
    Serialized Form

    • Method Detail

      • priorityOrder

        public final List<PriorityType> priorityOrder()

        A custom sequence to use when prioritizing where to place new game sessions. Each priority type is listed once.

        • LATENCY -- Amazon GameLift prioritizes locations where the average player latency is lowest. Player latency data is provided in each game session placement request.

        • COST -- Amazon GameLift prioritizes destinations with the lowest current hosting costs. Cost is evaluated based on the location, instance type, and fleet type (Spot or On-Demand) of each destination in the queue.

        • DESTINATION -- Amazon GameLift prioritizes based on the list order of destinations in the queue configuration.

        • LOCATION -- Amazon GameLift prioritizes based on the provided order of locations, as defined in LocationOrder.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPriorityOrder() method.

        Returns:
        A custom sequence to use when prioritizing where to place new game sessions. Each priority type is listed once.

        • LATENCY -- Amazon GameLift prioritizes locations where the average player latency is lowest. Player latency data is provided in each game session placement request.

        • COST -- Amazon GameLift prioritizes destinations with the lowest current hosting costs. Cost is evaluated based on the location, instance type, and fleet type (Spot or On-Demand) of each destination in the queue.

        • DESTINATION -- Amazon GameLift prioritizes based on the list order of destinations in the queue configuration.

        • LOCATION -- Amazon GameLift prioritizes based on the provided order of locations, as defined in LocationOrder.

      • hasPriorityOrder

        public final boolean hasPriorityOrder()
        For responses, this returns true if the service returned a value for the PriorityOrder property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • priorityOrderAsStrings

        public final List<String> priorityOrderAsStrings()

        A custom sequence to use when prioritizing where to place new game sessions. Each priority type is listed once.

        • LATENCY -- Amazon GameLift prioritizes locations where the average player latency is lowest. Player latency data is provided in each game session placement request.

        • COST -- Amazon GameLift prioritizes destinations with the lowest current hosting costs. Cost is evaluated based on the location, instance type, and fleet type (Spot or On-Demand) of each destination in the queue.

        • DESTINATION -- Amazon GameLift prioritizes based on the list order of destinations in the queue configuration.

        • LOCATION -- Amazon GameLift prioritizes based on the provided order of locations, as defined in LocationOrder.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPriorityOrder() method.

        Returns:
        A custom sequence to use when prioritizing where to place new game sessions. Each priority type is listed once.

        • LATENCY -- Amazon GameLift prioritizes locations where the average player latency is lowest. Player latency data is provided in each game session placement request.

        • COST -- Amazon GameLift prioritizes destinations with the lowest current hosting costs. Cost is evaluated based on the location, instance type, and fleet type (Spot or On-Demand) of each destination in the queue.

        • DESTINATION -- Amazon GameLift prioritizes based on the list order of destinations in the queue configuration.

        • LOCATION -- Amazon GameLift prioritizes based on the provided order of locations, as defined in LocationOrder.

      • hasLocationOrder

        public final boolean hasLocationOrder()
        For responses, this returns true if the service returned a value for the LocationOrder property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • locationOrder

        public final List<String> locationOrder()

        The prioritization order to use for fleet locations, when the PriorityOrder property includes LOCATION. Locations can include Amazon Web Services Region codes (such as us-west-2), local zones, and custom locations (for Anywhere fleets). Each location must be listed only once. For details, see Amazon GameLift service locations.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLocationOrder() method.

        Returns:
        The prioritization order to use for fleet locations, when the PriorityOrder property includes LOCATION. Locations can include Amazon Web Services Region codes (such as us-west-2), local zones, and custom locations (for Anywhere fleets). Each location must be listed only once. For details, see Amazon GameLift service locations.

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object

      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                              Class<T> clazz)