Class PriorityConfiguration
- All Implemented Interfaces:
Serializable
,SdkPojo
,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.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the LocationOrder property.final boolean
For responses, this returns true if the service returned a value for the PriorityOrder property.The prioritization order to use for fleet locations, when thePriorityOrder
property includesLOCATION
.final List
<PriorityType> The recommended sequence to use when prioritizing where to place new game sessions.The recommended sequence to use when prioritizing where to place new game sessions.static Class
<? extends PriorityConfiguration.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 inLocationOrder
.
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 inLocationOrder
.
-
-
-
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 theisEmpty()
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
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 inLocationOrder
.
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 inLocationOrder
.
-
-
-
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 theisEmpty()
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
The prioritization order to use for fleet locations, when the
PriorityOrder
property includesLOCATION
. Locations are identified by Amazon Web Services Region codes such asus-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 includesLOCATION
. Locations are identified by Amazon Web Services Region codes such asus-west-2
. Each location can only be listed once.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<PriorityConfiguration.Builder,
PriorityConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-