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

#include <UpdateGameSessionQueueRequest.h>

+ Inheritance diagram for Aws::GameLift::Model::UpdateGameSessionQueueRequest:

Public Member Functions

 UpdateGameSessionQueueRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
UpdateGameSessionQueueRequestWithName (const Aws::String &value)
 
UpdateGameSessionQueueRequestWithName (Aws::String &&value)
 
UpdateGameSessionQueueRequestWithName (const char *value)
 
int GetTimeoutInSeconds () const
 
bool TimeoutInSecondsHasBeenSet () const
 
void SetTimeoutInSeconds (int value)
 
UpdateGameSessionQueueRequestWithTimeoutInSeconds (int value)
 
const Aws::Vector< PlayerLatencyPolicy > & GetPlayerLatencyPolicies () const
 
bool PlayerLatencyPoliciesHasBeenSet () const
 
void SetPlayerLatencyPolicies (const Aws::Vector< PlayerLatencyPolicy > &value)
 
void SetPlayerLatencyPolicies (Aws::Vector< PlayerLatencyPolicy > &&value)
 
UpdateGameSessionQueueRequestWithPlayerLatencyPolicies (const Aws::Vector< PlayerLatencyPolicy > &value)
 
UpdateGameSessionQueueRequestWithPlayerLatencyPolicies (Aws::Vector< PlayerLatencyPolicy > &&value)
 
UpdateGameSessionQueueRequestAddPlayerLatencyPolicies (const PlayerLatencyPolicy &value)
 
UpdateGameSessionQueueRequestAddPlayerLatencyPolicies (PlayerLatencyPolicy &&value)
 
const Aws::Vector< GameSessionQueueDestination > & GetDestinations () const
 
bool DestinationsHasBeenSet () const
 
void SetDestinations (const Aws::Vector< GameSessionQueueDestination > &value)
 
void SetDestinations (Aws::Vector< GameSessionQueueDestination > &&value)
 
UpdateGameSessionQueueRequestWithDestinations (const Aws::Vector< GameSessionQueueDestination > &value)
 
UpdateGameSessionQueueRequestWithDestinations (Aws::Vector< GameSessionQueueDestination > &&value)
 
UpdateGameSessionQueueRequestAddDestinations (const GameSessionQueueDestination &value)
 
UpdateGameSessionQueueRequestAddDestinations (GameSessionQueueDestination &&value)
 
const FilterConfigurationGetFilterConfiguration () const
 
bool FilterConfigurationHasBeenSet () const
 
void SetFilterConfiguration (const FilterConfiguration &value)
 
void SetFilterConfiguration (FilterConfiguration &&value)
 
UpdateGameSessionQueueRequestWithFilterConfiguration (const FilterConfiguration &value)
 
UpdateGameSessionQueueRequestWithFilterConfiguration (FilterConfiguration &&value)
 
const PriorityConfigurationGetPriorityConfiguration () const
 
bool PriorityConfigurationHasBeenSet () const
 
void SetPriorityConfiguration (const PriorityConfiguration &value)
 
void SetPriorityConfiguration (PriorityConfiguration &&value)
 
UpdateGameSessionQueueRequestWithPriorityConfiguration (const PriorityConfiguration &value)
 
UpdateGameSessionQueueRequestWithPriorityConfiguration (PriorityConfiguration &&value)
 
const Aws::StringGetCustomEventData () const
 
bool CustomEventDataHasBeenSet () const
 
void SetCustomEventData (const Aws::String &value)
 
void SetCustomEventData (Aws::String &&value)
 
void SetCustomEventData (const char *value)
 
UpdateGameSessionQueueRequestWithCustomEventData (const Aws::String &value)
 
UpdateGameSessionQueueRequestWithCustomEventData (Aws::String &&value)
 
UpdateGameSessionQueueRequestWithCustomEventData (const char *value)
 
const Aws::StringGetNotificationTarget () const
 
bool NotificationTargetHasBeenSet () const
 
void SetNotificationTarget (const Aws::String &value)
 
void SetNotificationTarget (Aws::String &&value)
 
void SetNotificationTarget (const char *value)
 
UpdateGameSessionQueueRequestWithNotificationTarget (const Aws::String &value)
 
UpdateGameSessionQueueRequestWithNotificationTarget (Aws::String &&value)
 
UpdateGameSessionQueueRequestWithNotificationTarget (const char *value)
 
- Public Member Functions inherited from Aws::GameLift::GameLiftRequest
virtual ~GameLiftRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Represents the input for a request operation.

See Also:

AWS API Reference

Definition at line 29 of file UpdateGameSessionQueueRequest.h.

Constructor & Destructor Documentation

◆ UpdateGameSessionQueueRequest()

Aws::GameLift::Model::UpdateGameSessionQueueRequest::UpdateGameSessionQueueRequest ( )

Member Function Documentation

◆ AddDestinations() [1/2]

UpdateGameSessionQueueRequest& Aws::GameLift::Model::UpdateGameSessionQueueRequest::AddDestinations ( const GameSessionQueueDestination value)
inline

A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue. Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference. When updating this list, provide a complete list of destinations.

Definition at line 274 of file UpdateGameSessionQueueRequest.h.

◆ AddDestinations() [2/2]

UpdateGameSessionQueueRequest& Aws::GameLift::Model::UpdateGameSessionQueueRequest::AddDestinations ( GameSessionQueueDestination &&  value)
inline

A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue. Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference. When updating this list, provide a complete list of destinations.

Definition at line 282 of file UpdateGameSessionQueueRequest.h.

◆ AddPlayerLatencyPolicies() [1/2]

UpdateGameSessionQueueRequest& Aws::GameLift::Model::UpdateGameSessionQueueRequest::AddPlayerLatencyPolicies ( const PlayerLatencyPolicy value)
inline

A set of policies that act as a sliding cap on player latency. FleetIQ works to deliver low latency for most players in a game session. These policies ensure that no individual player can be placed into a game with unreasonably high latency. Use multiple policies to gradually relax latency requirements a step at a time. Multiple policies are applied based on their maximum allowed latency, starting with the lowest value. When updating policies, provide a complete collection of policies.

Definition at line 206 of file UpdateGameSessionQueueRequest.h.

◆ AddPlayerLatencyPolicies() [2/2]

UpdateGameSessionQueueRequest& Aws::GameLift::Model::UpdateGameSessionQueueRequest::AddPlayerLatencyPolicies ( PlayerLatencyPolicy &&  value)
inline

A set of policies that act as a sliding cap on player latency. FleetIQ works to deliver low latency for most players in a game session. These policies ensure that no individual player can be placed into a game with unreasonably high latency. Use multiple policies to gradually relax latency requirements a step at a time. Multiple policies are applied based on their maximum allowed latency, starting with the lowest value. When updating policies, provide a complete collection of policies.

Definition at line 217 of file UpdateGameSessionQueueRequest.h.

◆ CustomEventDataHasBeenSet()

bool Aws::GameLift::Model::UpdateGameSessionQueueRequest::CustomEventDataHasBeenSet ( ) const
inline

Information to be added to all events that are related to this game session queue.

Definition at line 405 of file UpdateGameSessionQueueRequest.h.

◆ DestinationsHasBeenSet()

bool Aws::GameLift::Model::UpdateGameSessionQueueRequest::DestinationsHasBeenSet ( ) const
inline

A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue. Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference. When updating this list, provide a complete list of destinations.

Definition at line 234 of file UpdateGameSessionQueueRequest.h.

◆ FilterConfigurationHasBeenSet()

bool Aws::GameLift::Model::UpdateGameSessionQueueRequest::FilterConfigurationHasBeenSet ( ) const
inline

A list of locations where a queue is allowed to place new game sessions. Locations are specified in the form of AWS Region codes, such as us-west-2. If this parameter is not set, game sessions can be placed in any queue location. To remove an existing filter configuration, pass in an empty set.

Definition at line 301 of file UpdateGameSessionQueueRequest.h.

◆ GetCustomEventData()

const Aws::String& Aws::GameLift::Model::UpdateGameSessionQueueRequest::GetCustomEventData ( ) const
inline

Information to be added to all events that are related to this game session queue.

Definition at line 399 of file UpdateGameSessionQueueRequest.h.

◆ GetDestinations()

const Aws::Vector<GameSessionQueueDestination>& Aws::GameLift::Model::UpdateGameSessionQueueRequest::GetDestinations ( ) const
inline

A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue. Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference. When updating this list, provide a complete list of destinations.

Definition at line 226 of file UpdateGameSessionQueueRequest.h.

◆ GetFilterConfiguration()

const FilterConfiguration& Aws::GameLift::Model::UpdateGameSessionQueueRequest::GetFilterConfiguration ( ) const
inline

A list of locations where a queue is allowed to place new game sessions. Locations are specified in the form of AWS Region codes, such as us-west-2. If this parameter is not set, game sessions can be placed in any queue location. To remove an existing filter configuration, pass in an empty set.

Definition at line 292 of file UpdateGameSessionQueueRequest.h.

◆ GetName()

const Aws::String& Aws::GameLift::Model::UpdateGameSessionQueueRequest::GetName ( ) const
inline

A descriptive label that is associated with game session queue. Queue names must be unique within each Region. You can use either the queue ID or ARN value.

Definition at line 50 of file UpdateGameSessionQueueRequest.h.

◆ GetNotificationTarget()

const Aws::String& Aws::GameLift::Model::UpdateGameSessionQueueRequest::GetNotificationTarget ( ) const
inline

An SNS topic ARN that is set up to receive game session placement notifications. See Setting up notifications for game session placement.

Definition at line 450 of file UpdateGameSessionQueueRequest.h.

◆ GetPlayerLatencyPolicies()

const Aws::Vector<PlayerLatencyPolicy>& Aws::GameLift::Model::UpdateGameSessionQueueRequest::GetPlayerLatencyPolicies ( ) const
inline

A set of policies that act as a sliding cap on player latency. FleetIQ works to deliver low latency for most players in a game session. These policies ensure that no individual player can be placed into a game with unreasonably high latency. Use multiple policies to gradually relax latency requirements a step at a time. Multiple policies are applied based on their maximum allowed latency, starting with the lowest value. When updating policies, provide a complete collection of policies.

Definition at line 140 of file UpdateGameSessionQueueRequest.h.

◆ GetPriorityConfiguration()

const PriorityConfiguration& Aws::GameLift::Model::UpdateGameSessionQueueRequest::GetPriorityConfiguration ( ) const
inline

Custom settings to use when prioritizing destinations and locations for game session placements. This configuration replaces the FleetIQ default prioritization process. Priority types that are not explicitly named will be automatically applied at the end of the prioritization process. To remove an existing priority configuration, pass in an empty set.

Definition at line 347 of file UpdateGameSessionQueueRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::GameLift::Model::UpdateGameSessionQueueRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::GameLift::GameLiftRequest.

◆ GetServiceRequestName()

virtual const char* Aws::GameLift::Model::UpdateGameSessionQueueRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 38 of file UpdateGameSessionQueueRequest.h.

◆ GetTimeoutInSeconds()

int Aws::GameLift::Model::UpdateGameSessionQueueRequest::GetTimeoutInSeconds ( ) const
inline

The maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a TIMED_OUT status.

Definition at line 107 of file UpdateGameSessionQueueRequest.h.

◆ NameHasBeenSet()

bool Aws::GameLift::Model::UpdateGameSessionQueueRequest::NameHasBeenSet ( ) const
inline

A descriptive label that is associated with game session queue. Queue names must be unique within each Region. You can use either the queue ID or ARN value.

Definition at line 57 of file UpdateGameSessionQueueRequest.h.

◆ NotificationTargetHasBeenSet()

bool Aws::GameLift::Model::UpdateGameSessionQueueRequest::NotificationTargetHasBeenSet ( ) const
inline

An SNS topic ARN that is set up to receive game session placement notifications. See Setting up notifications for game session placement.

Definition at line 458 of file UpdateGameSessionQueueRequest.h.

◆ PlayerLatencyPoliciesHasBeenSet()

bool Aws::GameLift::Model::UpdateGameSessionQueueRequest::PlayerLatencyPoliciesHasBeenSet ( ) const
inline

A set of policies that act as a sliding cap on player latency. FleetIQ works to deliver low latency for most players in a game session. These policies ensure that no individual player can be placed into a game with unreasonably high latency. Use multiple policies to gradually relax latency requirements a step at a time. Multiple policies are applied based on their maximum allowed latency, starting with the lowest value. When updating policies, provide a complete collection of policies.

Definition at line 151 of file UpdateGameSessionQueueRequest.h.

◆ PriorityConfigurationHasBeenSet()

bool Aws::GameLift::Model::UpdateGameSessionQueueRequest::PriorityConfigurationHasBeenSet ( ) const
inline

Custom settings to use when prioritizing destinations and locations for game session placements. This configuration replaces the FleetIQ default prioritization process. Priority types that are not explicitly named will be automatically applied at the end of the prioritization process. To remove an existing priority configuration, pass in an empty set.

Definition at line 356 of file UpdateGameSessionQueueRequest.h.

◆ SerializePayload()

Aws::String Aws::GameLift::Model::UpdateGameSessionQueueRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetCustomEventData() [1/3]

void Aws::GameLift::Model::UpdateGameSessionQueueRequest::SetCustomEventData ( Aws::String &&  value)
inline

Information to be added to all events that are related to this game session queue.

Definition at line 417 of file UpdateGameSessionQueueRequest.h.

◆ SetCustomEventData() [2/3]

void Aws::GameLift::Model::UpdateGameSessionQueueRequest::SetCustomEventData ( const Aws::String value)
inline

Information to be added to all events that are related to this game session queue.

Definition at line 411 of file UpdateGameSessionQueueRequest.h.

◆ SetCustomEventData() [3/3]

void Aws::GameLift::Model::UpdateGameSessionQueueRequest::SetCustomEventData ( const char *  value)
inline

Information to be added to all events that are related to this game session queue.

Definition at line 423 of file UpdateGameSessionQueueRequest.h.

◆ SetDestinations() [1/2]

void Aws::GameLift::Model::UpdateGameSessionQueueRequest::SetDestinations ( Aws::Vector< GameSessionQueueDestination > &&  value)
inline

A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue. Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference. When updating this list, provide a complete list of destinations.

Definition at line 250 of file UpdateGameSessionQueueRequest.h.

◆ SetDestinations() [2/2]

void Aws::GameLift::Model::UpdateGameSessionQueueRequest::SetDestinations ( const Aws::Vector< GameSessionQueueDestination > &  value)
inline

A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue. Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference. When updating this list, provide a complete list of destinations.

Definition at line 242 of file UpdateGameSessionQueueRequest.h.

◆ SetFilterConfiguration() [1/2]

void Aws::GameLift::Model::UpdateGameSessionQueueRequest::SetFilterConfiguration ( const FilterConfiguration value)
inline

A list of locations where a queue is allowed to place new game sessions. Locations are specified in the form of AWS Region codes, such as us-west-2. If this parameter is not set, game sessions can be placed in any queue location. To remove an existing filter configuration, pass in an empty set.

Definition at line 310 of file UpdateGameSessionQueueRequest.h.

◆ SetFilterConfiguration() [2/2]

void Aws::GameLift::Model::UpdateGameSessionQueueRequest::SetFilterConfiguration ( FilterConfiguration &&  value)
inline

A list of locations where a queue is allowed to place new game sessions. Locations are specified in the form of AWS Region codes, such as us-west-2. If this parameter is not set, game sessions can be placed in any queue location. To remove an existing filter configuration, pass in an empty set.

Definition at line 319 of file UpdateGameSessionQueueRequest.h.

◆ SetName() [1/3]

void Aws::GameLift::Model::UpdateGameSessionQueueRequest::SetName ( Aws::String &&  value)
inline

A descriptive label that is associated with game session queue. Queue names must be unique within each Region. You can use either the queue ID or ARN value.

Definition at line 71 of file UpdateGameSessionQueueRequest.h.

◆ SetName() [2/3]

void Aws::GameLift::Model::UpdateGameSessionQueueRequest::SetName ( const Aws::String value)
inline

A descriptive label that is associated with game session queue. Queue names must be unique within each Region. You can use either the queue ID or ARN value.

Definition at line 64 of file UpdateGameSessionQueueRequest.h.

◆ SetName() [3/3]

void Aws::GameLift::Model::UpdateGameSessionQueueRequest::SetName ( const char *  value)
inline

A descriptive label that is associated with game session queue. Queue names must be unique within each Region. You can use either the queue ID or ARN value.

Definition at line 78 of file UpdateGameSessionQueueRequest.h.

◆ SetNotificationTarget() [1/3]

void Aws::GameLift::Model::UpdateGameSessionQueueRequest::SetNotificationTarget ( Aws::String &&  value)
inline

An SNS topic ARN that is set up to receive game session placement notifications. See Setting up notifications for game session placement.

Definition at line 474 of file UpdateGameSessionQueueRequest.h.

◆ SetNotificationTarget() [2/3]

void Aws::GameLift::Model::UpdateGameSessionQueueRequest::SetNotificationTarget ( const Aws::String value)
inline

An SNS topic ARN that is set up to receive game session placement notifications. See Setting up notifications for game session placement.

Definition at line 466 of file UpdateGameSessionQueueRequest.h.

◆ SetNotificationTarget() [3/3]

void Aws::GameLift::Model::UpdateGameSessionQueueRequest::SetNotificationTarget ( const char *  value)
inline

An SNS topic ARN that is set up to receive game session placement notifications. See Setting up notifications for game session placement.

Definition at line 482 of file UpdateGameSessionQueueRequest.h.

◆ SetPlayerLatencyPolicies() [1/2]

void Aws::GameLift::Model::UpdateGameSessionQueueRequest::SetPlayerLatencyPolicies ( Aws::Vector< PlayerLatencyPolicy > &&  value)
inline

A set of policies that act as a sliding cap on player latency. FleetIQ works to deliver low latency for most players in a game session. These policies ensure that no individual player can be placed into a game with unreasonably high latency. Use multiple policies to gradually relax latency requirements a step at a time. Multiple policies are applied based on their maximum allowed latency, starting with the lowest value. When updating policies, provide a complete collection of policies.

Definition at line 173 of file UpdateGameSessionQueueRequest.h.

◆ SetPlayerLatencyPolicies() [2/2]

void Aws::GameLift::Model::UpdateGameSessionQueueRequest::SetPlayerLatencyPolicies ( const Aws::Vector< PlayerLatencyPolicy > &  value)
inline

A set of policies that act as a sliding cap on player latency. FleetIQ works to deliver low latency for most players in a game session. These policies ensure that no individual player can be placed into a game with unreasonably high latency. Use multiple policies to gradually relax latency requirements a step at a time. Multiple policies are applied based on their maximum allowed latency, starting with the lowest value. When updating policies, provide a complete collection of policies.

Definition at line 162 of file UpdateGameSessionQueueRequest.h.

◆ SetPriorityConfiguration() [1/2]

void Aws::GameLift::Model::UpdateGameSessionQueueRequest::SetPriorityConfiguration ( const PriorityConfiguration value)
inline

Custom settings to use when prioritizing destinations and locations for game session placements. This configuration replaces the FleetIQ default prioritization process. Priority types that are not explicitly named will be automatically applied at the end of the prioritization process. To remove an existing priority configuration, pass in an empty set.

Definition at line 365 of file UpdateGameSessionQueueRequest.h.

◆ SetPriorityConfiguration() [2/2]

void Aws::GameLift::Model::UpdateGameSessionQueueRequest::SetPriorityConfiguration ( PriorityConfiguration &&  value)
inline

Custom settings to use when prioritizing destinations and locations for game session placements. This configuration replaces the FleetIQ default prioritization process. Priority types that are not explicitly named will be automatically applied at the end of the prioritization process. To remove an existing priority configuration, pass in an empty set.

Definition at line 374 of file UpdateGameSessionQueueRequest.h.

◆ SetTimeoutInSeconds()

void Aws::GameLift::Model::UpdateGameSessionQueueRequest::SetTimeoutInSeconds ( int  value)
inline

The maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a TIMED_OUT status.

Definition at line 121 of file UpdateGameSessionQueueRequest.h.

◆ TimeoutInSecondsHasBeenSet()

bool Aws::GameLift::Model::UpdateGameSessionQueueRequest::TimeoutInSecondsHasBeenSet ( ) const
inline

The maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a TIMED_OUT status.

Definition at line 114 of file UpdateGameSessionQueueRequest.h.

◆ WithCustomEventData() [1/3]

UpdateGameSessionQueueRequest& Aws::GameLift::Model::UpdateGameSessionQueueRequest::WithCustomEventData ( Aws::String &&  value)
inline

Information to be added to all events that are related to this game session queue.

Definition at line 435 of file UpdateGameSessionQueueRequest.h.

◆ WithCustomEventData() [2/3]

UpdateGameSessionQueueRequest& Aws::GameLift::Model::UpdateGameSessionQueueRequest::WithCustomEventData ( const Aws::String value)
inline

Information to be added to all events that are related to this game session queue.

Definition at line 429 of file UpdateGameSessionQueueRequest.h.

◆ WithCustomEventData() [3/3]

UpdateGameSessionQueueRequest& Aws::GameLift::Model::UpdateGameSessionQueueRequest::WithCustomEventData ( const char *  value)
inline

Information to be added to all events that are related to this game session queue.

Definition at line 441 of file UpdateGameSessionQueueRequest.h.

◆ WithDestinations() [1/2]

UpdateGameSessionQueueRequest& Aws::GameLift::Model::UpdateGameSessionQueueRequest::WithDestinations ( Aws::Vector< GameSessionQueueDestination > &&  value)
inline

A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue. Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference. When updating this list, provide a complete list of destinations.

Definition at line 266 of file UpdateGameSessionQueueRequest.h.

◆ WithDestinations() [2/2]

UpdateGameSessionQueueRequest& Aws::GameLift::Model::UpdateGameSessionQueueRequest::WithDestinations ( const Aws::Vector< GameSessionQueueDestination > &  value)
inline

A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue. Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference. When updating this list, provide a complete list of destinations.

Definition at line 258 of file UpdateGameSessionQueueRequest.h.

◆ WithFilterConfiguration() [1/2]

UpdateGameSessionQueueRequest& Aws::GameLift::Model::UpdateGameSessionQueueRequest::WithFilterConfiguration ( const FilterConfiguration value)
inline

A list of locations where a queue is allowed to place new game sessions. Locations are specified in the form of AWS Region codes, such as us-west-2. If this parameter is not set, game sessions can be placed in any queue location. To remove an existing filter configuration, pass in an empty set.

Definition at line 328 of file UpdateGameSessionQueueRequest.h.

◆ WithFilterConfiguration() [2/2]

UpdateGameSessionQueueRequest& Aws::GameLift::Model::UpdateGameSessionQueueRequest::WithFilterConfiguration ( FilterConfiguration &&  value)
inline

A list of locations where a queue is allowed to place new game sessions. Locations are specified in the form of AWS Region codes, such as us-west-2. If this parameter is not set, game sessions can be placed in any queue location. To remove an existing filter configuration, pass in an empty set.

Definition at line 337 of file UpdateGameSessionQueueRequest.h.

◆ WithName() [1/3]

UpdateGameSessionQueueRequest& Aws::GameLift::Model::UpdateGameSessionQueueRequest::WithName ( Aws::String &&  value)
inline

A descriptive label that is associated with game session queue. Queue names must be unique within each Region. You can use either the queue ID or ARN value.

Definition at line 92 of file UpdateGameSessionQueueRequest.h.

◆ WithName() [2/3]

UpdateGameSessionQueueRequest& Aws::GameLift::Model::UpdateGameSessionQueueRequest::WithName ( const Aws::String value)
inline

A descriptive label that is associated with game session queue. Queue names must be unique within each Region. You can use either the queue ID or ARN value.

Definition at line 85 of file UpdateGameSessionQueueRequest.h.

◆ WithName() [3/3]

UpdateGameSessionQueueRequest& Aws::GameLift::Model::UpdateGameSessionQueueRequest::WithName ( const char *  value)
inline

A descriptive label that is associated with game session queue. Queue names must be unique within each Region. You can use either the queue ID or ARN value.

Definition at line 99 of file UpdateGameSessionQueueRequest.h.

◆ WithNotificationTarget() [1/3]

UpdateGameSessionQueueRequest& Aws::GameLift::Model::UpdateGameSessionQueueRequest::WithNotificationTarget ( Aws::String &&  value)
inline

An SNS topic ARN that is set up to receive game session placement notifications. See Setting up notifications for game session placement.

Definition at line 498 of file UpdateGameSessionQueueRequest.h.

◆ WithNotificationTarget() [2/3]

UpdateGameSessionQueueRequest& Aws::GameLift::Model::UpdateGameSessionQueueRequest::WithNotificationTarget ( const Aws::String value)
inline

An SNS topic ARN that is set up to receive game session placement notifications. See Setting up notifications for game session placement.

Definition at line 490 of file UpdateGameSessionQueueRequest.h.

◆ WithNotificationTarget() [3/3]

UpdateGameSessionQueueRequest& Aws::GameLift::Model::UpdateGameSessionQueueRequest::WithNotificationTarget ( const char *  value)
inline

An SNS topic ARN that is set up to receive game session placement notifications. See Setting up notifications for game session placement.

Definition at line 506 of file UpdateGameSessionQueueRequest.h.

◆ WithPlayerLatencyPolicies() [1/2]

UpdateGameSessionQueueRequest& Aws::GameLift::Model::UpdateGameSessionQueueRequest::WithPlayerLatencyPolicies ( Aws::Vector< PlayerLatencyPolicy > &&  value)
inline

A set of policies that act as a sliding cap on player latency. FleetIQ works to deliver low latency for most players in a game session. These policies ensure that no individual player can be placed into a game with unreasonably high latency. Use multiple policies to gradually relax latency requirements a step at a time. Multiple policies are applied based on their maximum allowed latency, starting with the lowest value. When updating policies, provide a complete collection of policies.

Definition at line 195 of file UpdateGameSessionQueueRequest.h.

◆ WithPlayerLatencyPolicies() [2/2]

UpdateGameSessionQueueRequest& Aws::GameLift::Model::UpdateGameSessionQueueRequest::WithPlayerLatencyPolicies ( const Aws::Vector< PlayerLatencyPolicy > &  value)
inline

A set of policies that act as a sliding cap on player latency. FleetIQ works to deliver low latency for most players in a game session. These policies ensure that no individual player can be placed into a game with unreasonably high latency. Use multiple policies to gradually relax latency requirements a step at a time. Multiple policies are applied based on their maximum allowed latency, starting with the lowest value. When updating policies, provide a complete collection of policies.

Definition at line 184 of file UpdateGameSessionQueueRequest.h.

◆ WithPriorityConfiguration() [1/2]

UpdateGameSessionQueueRequest& Aws::GameLift::Model::UpdateGameSessionQueueRequest::WithPriorityConfiguration ( const PriorityConfiguration value)
inline

Custom settings to use when prioritizing destinations and locations for game session placements. This configuration replaces the FleetIQ default prioritization process. Priority types that are not explicitly named will be automatically applied at the end of the prioritization process. To remove an existing priority configuration, pass in an empty set.

Definition at line 383 of file UpdateGameSessionQueueRequest.h.

◆ WithPriorityConfiguration() [2/2]

UpdateGameSessionQueueRequest& Aws::GameLift::Model::UpdateGameSessionQueueRequest::WithPriorityConfiguration ( PriorityConfiguration &&  value)
inline

Custom settings to use when prioritizing destinations and locations for game session placements. This configuration replaces the FleetIQ default prioritization process. Priority types that are not explicitly named will be automatically applied at the end of the prioritization process. To remove an existing priority configuration, pass in an empty set.

Definition at line 392 of file UpdateGameSessionQueueRequest.h.

◆ WithTimeoutInSeconds()

UpdateGameSessionQueueRequest& Aws::GameLift::Model::UpdateGameSessionQueueRequest::WithTimeoutInSeconds ( int  value)
inline

The maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a TIMED_OUT status.

Definition at line 128 of file UpdateGameSessionQueueRequest.h.


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