AWS SDK for C++  1.9.103
AWS SDK for C++
Public Member Functions | List of all members
Aws::GameLift::Model::PriorityConfiguration Class Reference

#include <PriorityConfiguration.h>

Public Member Functions

 PriorityConfiguration ()
 
 PriorityConfiguration (Aws::Utils::Json::JsonView jsonValue)
 
PriorityConfigurationoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::Vector< PriorityType > & GetPriorityOrder () const
 
bool PriorityOrderHasBeenSet () const
 
void SetPriorityOrder (const Aws::Vector< PriorityType > &value)
 
void SetPriorityOrder (Aws::Vector< PriorityType > &&value)
 
PriorityConfigurationWithPriorityOrder (const Aws::Vector< PriorityType > &value)
 
PriorityConfigurationWithPriorityOrder (Aws::Vector< PriorityType > &&value)
 
PriorityConfigurationAddPriorityOrder (const PriorityType &value)
 
PriorityConfigurationAddPriorityOrder (PriorityType &&value)
 
const Aws::Vector< Aws::String > & GetLocationOrder () const
 
bool LocationOrderHasBeenSet () const
 
void SetLocationOrder (const Aws::Vector< Aws::String > &value)
 
void SetLocationOrder (Aws::Vector< Aws::String > &&value)
 
PriorityConfigurationWithLocationOrder (const Aws::Vector< Aws::String > &value)
 
PriorityConfigurationWithLocationOrder (Aws::Vector< Aws::String > &&value)
 
PriorityConfigurationAddLocationOrder (const Aws::String &value)
 
PriorityConfigurationAddLocationOrder (Aws::String &&value)
 
PriorityConfigurationAddLocationOrder (const char *value)
 

Detailed Description

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:

Changing the priority order will affect how game sessions are placed.

Priority configurations are part of a GameSessionQueue.

See Also:

AWS API Reference

Definition at line 49 of file PriorityConfiguration.h.

Constructor & Destructor Documentation

◆ PriorityConfiguration() [1/2]

Aws::GameLift::Model::PriorityConfiguration::PriorityConfiguration ( )

◆ PriorityConfiguration() [2/2]

Aws::GameLift::Model::PriorityConfiguration::PriorityConfiguration ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddLocationOrder() [1/3]

PriorityConfiguration& Aws::GameLift::Model::PriorityConfiguration::AddLocationOrder ( Aws::String &&  value)
inline

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.

Definition at line 241 of file PriorityConfiguration.h.

◆ AddLocationOrder() [2/3]

PriorityConfiguration& Aws::GameLift::Model::PriorityConfiguration::AddLocationOrder ( const Aws::String value)
inline

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.

Definition at line 233 of file PriorityConfiguration.h.

◆ AddLocationOrder() [3/3]

PriorityConfiguration& Aws::GameLift::Model::PriorityConfiguration::AddLocationOrder ( const char *  value)
inline

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.

Definition at line 249 of file PriorityConfiguration.h.

◆ AddPriorityOrder() [1/2]

PriorityConfiguration& Aws::GameLift::Model::PriorityConfiguration::AddPriorityOrder ( const PriorityType value)
inline

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.

Definition at line 161 of file PriorityConfiguration.h.

◆ AddPriorityOrder() [2/2]

PriorityConfiguration& Aws::GameLift::Model::PriorityConfiguration::AddPriorityOrder ( PriorityType &&  value)
inline

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.

Definition at line 176 of file PriorityConfiguration.h.

◆ GetLocationOrder()

const Aws::Vector<Aws::String>& Aws::GameLift::Model::PriorityConfiguration::GetLocationOrder ( ) const
inline

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.

Definition at line 185 of file PriorityConfiguration.h.

◆ GetPriorityOrder()

const Aws::Vector<PriorityType>& Aws::GameLift::Model::PriorityConfiguration::GetPriorityOrder ( ) const
inline

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.

Definition at line 71 of file PriorityConfiguration.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::GameLift::Model::PriorityConfiguration::Jsonize ( ) const

◆ LocationOrderHasBeenSet()

bool Aws::GameLift::Model::PriorityConfiguration::LocationOrderHasBeenSet ( ) const
inline

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.

Definition at line 193 of file PriorityConfiguration.h.

◆ operator=()

PriorityConfiguration& Aws::GameLift::Model::PriorityConfiguration::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ PriorityOrderHasBeenSet()

bool Aws::GameLift::Model::PriorityConfiguration::PriorityOrderHasBeenSet ( ) const
inline

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.

Definition at line 86 of file PriorityConfiguration.h.

◆ SetLocationOrder() [1/2]

void Aws::GameLift::Model::PriorityConfiguration::SetLocationOrder ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 209 of file PriorityConfiguration.h.

◆ SetLocationOrder() [2/2]

void Aws::GameLift::Model::PriorityConfiguration::SetLocationOrder ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 201 of file PriorityConfiguration.h.

◆ SetPriorityOrder() [1/2]

void Aws::GameLift::Model::PriorityConfiguration::SetPriorityOrder ( Aws::Vector< PriorityType > &&  value)
inline

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.

Definition at line 116 of file PriorityConfiguration.h.

◆ SetPriorityOrder() [2/2]

void Aws::GameLift::Model::PriorityConfiguration::SetPriorityOrder ( const Aws::Vector< PriorityType > &  value)
inline

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.

Definition at line 101 of file PriorityConfiguration.h.

◆ WithLocationOrder() [1/2]

PriorityConfiguration& Aws::GameLift::Model::PriorityConfiguration::WithLocationOrder ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 225 of file PriorityConfiguration.h.

◆ WithLocationOrder() [2/2]

PriorityConfiguration& Aws::GameLift::Model::PriorityConfiguration::WithLocationOrder ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 217 of file PriorityConfiguration.h.

◆ WithPriorityOrder() [1/2]

PriorityConfiguration& Aws::GameLift::Model::PriorityConfiguration::WithPriorityOrder ( Aws::Vector< PriorityType > &&  value)
inline

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.

Definition at line 146 of file PriorityConfiguration.h.

◆ WithPriorityOrder() [2/2]

PriorityConfiguration& Aws::GameLift::Model::PriorityConfiguration::WithPriorityOrder ( const Aws::Vector< PriorityType > &  value)
inline

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.

Definition at line 131 of file PriorityConfiguration.h.


The documentation for this class was generated from the following file: