com.amazonaws.services.gamelift.model

Class PriorityConfiguration

java.lang.Object

com.amazonaws.services.gamelift.model.PriorityConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PriorityConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo

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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
PriorityConfiguration()

Method Summary

Modifier and Type	Method and Description
PriorityConfiguration	clone()
boolean	equals(Object obj)
List<String>	getLocationOrder() The prioritization order to use for fleet locations, when the PriorityOrder property includes LOCATION.
List<String>	getPriorityOrder() The recommended sequence to use when prioritizing where to place new game sessions.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setLocationOrder(Collection<String> locationOrder) The prioritization order to use for fleet locations, when the PriorityOrder property includes LOCATION.
void	setPriorityOrder(Collection<String> priorityOrder) The recommended sequence to use when prioritizing where to place new game sessions.
String	toString() Returns a string representation of this object.
PriorityConfiguration	withLocationOrder(Collection<String> locationOrder) The prioritization order to use for fleet locations, when the PriorityOrder property includes LOCATION.
PriorityConfiguration	withLocationOrder(String... locationOrder) The prioritization order to use for fleet locations, when the PriorityOrder property includes LOCATION.
PriorityConfiguration	withPriorityOrder(Collection<String> priorityOrder) The recommended sequence to use when prioritizing where to place new game sessions.
PriorityConfiguration	withPriorityOrder(PriorityType... priorityOrder) The recommended sequence to use when prioritizing where to place new game sessions.
PriorityConfiguration	withPriorityOrder(String... priorityOrder) The recommended sequence to use when prioritizing where to place new game sessions.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PriorityConfiguration

public PriorityConfiguration()

Method Detail

getPriorityOrder

public List<String> getPriorityOrder()

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.

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.

See Also:

PriorityType

setPriorityOrder

public void setPriorityOrder(Collection<String> 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.

Parameters:

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.

See Also:

PriorityType

withPriorityOrder

public PriorityConfiguration withPriorityOrder(String... 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.

NOTE: This method appends the values to the existing list (if any). Use setPriorityOrder(java.util.Collection) or withPriorityOrder(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PriorityType

withPriorityOrder

public PriorityConfiguration withPriorityOrder(Collection<String> 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PriorityType

withPriorityOrder

public PriorityConfiguration withPriorityOrder(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PriorityType

getLocationOrder

public List<String> getLocationOrder()

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.

Returns:

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.

setLocationOrder

public void setLocationOrder(Collection<String> locationOrder)

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.

Parameters:

locationOrder - 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.

withLocationOrder

public PriorityConfiguration withLocationOrder(String... locationOrder)

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.

NOTE: This method appends the values to the existing list (if any). Use setLocationOrder(java.util.Collection) or withLocationOrder(java.util.Collection) if you want to override the existing values.

Parameters:

locationOrder - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

withLocationOrder

public PriorityConfiguration withLocationOrder(Collection<String> locationOrder)

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.

Parameters:

locationOrder - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public PriorityConfiguration clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.