software.amazon.awssdk.services.gamelift.model

Class PriorityConfiguration

java.lang.Object

software.amazon.awssdk.services.gamelift.model.PriorityConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<PriorityConfiguration.Builder,PriorityConfiguration>

@Generated(value="software.amazon.awssdk:codegen")
public final class PriorityConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<PriorityConfiguration.Builder,PriorityConfiguration>

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.

Priority configurations are part of a GameSessionQueue.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PriorityConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
static PriorityConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasLocationOrder() For responses, this returns true if the service returned a value for the LocationOrder property.
boolean	hasPriorityOrder() For responses, this returns true if the service returned a value for the PriorityOrder property.
List<String>	locationOrder() The prioritization order to use for fleet locations, when the PriorityOrder property includes LOCATION.
List<PriorityType>	priorityOrder() The recommended sequence to use when prioritizing where to place new game sessions.
List<String>	priorityOrderAsStrings() The recommended sequence to use when prioritizing where to place new game sessions.
List<SdkField<?>>	sdkFields()
static Class<? extends PriorityConfiguration.Builder>	serializableBuilderClass()
PriorityConfiguration.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

priorityOrder

public final List<PriorityType> priorityOrder()

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.

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:

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.

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()

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.

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:

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.

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 are identified by AWS Region codes such as us-west-2. Each location can only be listed once.

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 are identified by AWS Region codes such as us-west-2. Each location can only be listed once.

toBuilder

public PriorityConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PriorityConfiguration.Builder,PriorityConfiguration>

builder

public static PriorityConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends PriorityConfiguration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo