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

#include <StartGameSessionPlacementRequest.h>

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

Public Member Functions

 StartGameSessionPlacementRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetPlacementId () const
 
bool PlacementIdHasBeenSet () const
 
void SetPlacementId (const Aws::String &value)
 
void SetPlacementId (Aws::String &&value)
 
void SetPlacementId (const char *value)
 
StartGameSessionPlacementRequestWithPlacementId (const Aws::String &value)
 
StartGameSessionPlacementRequestWithPlacementId (Aws::String &&value)
 
StartGameSessionPlacementRequestWithPlacementId (const char *value)
 
const Aws::StringGetGameSessionQueueName () const
 
bool GameSessionQueueNameHasBeenSet () const
 
void SetGameSessionQueueName (const Aws::String &value)
 
void SetGameSessionQueueName (Aws::String &&value)
 
void SetGameSessionQueueName (const char *value)
 
StartGameSessionPlacementRequestWithGameSessionQueueName (const Aws::String &value)
 
StartGameSessionPlacementRequestWithGameSessionQueueName (Aws::String &&value)
 
StartGameSessionPlacementRequestWithGameSessionQueueName (const char *value)
 
const Aws::Vector< GameProperty > & GetGameProperties () const
 
bool GamePropertiesHasBeenSet () const
 
void SetGameProperties (const Aws::Vector< GameProperty > &value)
 
void SetGameProperties (Aws::Vector< GameProperty > &&value)
 
StartGameSessionPlacementRequestWithGameProperties (const Aws::Vector< GameProperty > &value)
 
StartGameSessionPlacementRequestWithGameProperties (Aws::Vector< GameProperty > &&value)
 
StartGameSessionPlacementRequestAddGameProperties (const GameProperty &value)
 
StartGameSessionPlacementRequestAddGameProperties (GameProperty &&value)
 
int GetMaximumPlayerSessionCount () const
 
bool MaximumPlayerSessionCountHasBeenSet () const
 
void SetMaximumPlayerSessionCount (int value)
 
StartGameSessionPlacementRequestWithMaximumPlayerSessionCount (int value)
 
const Aws::StringGetGameSessionName () const
 
bool GameSessionNameHasBeenSet () const
 
void SetGameSessionName (const Aws::String &value)
 
void SetGameSessionName (Aws::String &&value)
 
void SetGameSessionName (const char *value)
 
StartGameSessionPlacementRequestWithGameSessionName (const Aws::String &value)
 
StartGameSessionPlacementRequestWithGameSessionName (Aws::String &&value)
 
StartGameSessionPlacementRequestWithGameSessionName (const char *value)
 
const Aws::Vector< PlayerLatency > & GetPlayerLatencies () const
 
bool PlayerLatenciesHasBeenSet () const
 
void SetPlayerLatencies (const Aws::Vector< PlayerLatency > &value)
 
void SetPlayerLatencies (Aws::Vector< PlayerLatency > &&value)
 
StartGameSessionPlacementRequestWithPlayerLatencies (const Aws::Vector< PlayerLatency > &value)
 
StartGameSessionPlacementRequestWithPlayerLatencies (Aws::Vector< PlayerLatency > &&value)
 
StartGameSessionPlacementRequestAddPlayerLatencies (const PlayerLatency &value)
 
StartGameSessionPlacementRequestAddPlayerLatencies (PlayerLatency &&value)
 
const Aws::Vector< DesiredPlayerSession > & GetDesiredPlayerSessions () const
 
bool DesiredPlayerSessionsHasBeenSet () const
 
void SetDesiredPlayerSessions (const Aws::Vector< DesiredPlayerSession > &value)
 
void SetDesiredPlayerSessions (Aws::Vector< DesiredPlayerSession > &&value)
 
StartGameSessionPlacementRequestWithDesiredPlayerSessions (const Aws::Vector< DesiredPlayerSession > &value)
 
StartGameSessionPlacementRequestWithDesiredPlayerSessions (Aws::Vector< DesiredPlayerSession > &&value)
 
StartGameSessionPlacementRequestAddDesiredPlayerSessions (const DesiredPlayerSession &value)
 
StartGameSessionPlacementRequestAddDesiredPlayerSessions (DesiredPlayerSession &&value)
 
const Aws::StringGetGameSessionData () const
 
bool GameSessionDataHasBeenSet () const
 
void SetGameSessionData (const Aws::String &value)
 
void SetGameSessionData (Aws::String &&value)
 
void SetGameSessionData (const char *value)
 
StartGameSessionPlacementRequestWithGameSessionData (const Aws::String &value)
 
StartGameSessionPlacementRequestWithGameSessionData (Aws::String &&value)
 
StartGameSessionPlacementRequestWithGameSessionData (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 action.

See Also:

AWS API Reference

Definition at line 38 of file StartGameSessionPlacementRequest.h.

Constructor & Destructor Documentation

◆ StartGameSessionPlacementRequest()

Aws::GameLift::Model::StartGameSessionPlacementRequest::StartGameSessionPlacementRequest ( )

Member Function Documentation

◆ AddDesiredPlayerSessions() [1/2]

StartGameSessionPlacementRequest& Aws::GameLift::Model::StartGameSessionPlacementRequest::AddDesiredPlayerSessions ( const DesiredPlayerSession value)
inline

Set of information on each player to create a player session for.

Definition at line 405 of file StartGameSessionPlacementRequest.h.

◆ AddDesiredPlayerSessions() [2/2]

StartGameSessionPlacementRequest& Aws::GameLift::Model::StartGameSessionPlacementRequest::AddDesiredPlayerSessions ( DesiredPlayerSession &&  value)
inline

Set of information on each player to create a player session for.

Definition at line 410 of file StartGameSessionPlacementRequest.h.

◆ AddGameProperties() [1/2]

StartGameSessionPlacementRequest& Aws::GameLift::Model::StartGameSessionPlacementRequest::AddGameProperties ( const GameProperty value)
inline

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

Definition at line 221 of file StartGameSessionPlacementRequest.h.

◆ AddGameProperties() [2/2]

StartGameSessionPlacementRequest& Aws::GameLift::Model::StartGameSessionPlacementRequest::AddGameProperties ( GameProperty &&  value)
inline

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

Definition at line 230 of file StartGameSessionPlacementRequest.h.

◆ AddPlayerLatencies() [1/2]

StartGameSessionPlacementRequest& Aws::GameLift::Model::StartGameSessionPlacementRequest::AddPlayerLatencies ( const PlayerLatency value)
inline

Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS regions. This information is used to try to place the new game session where it can offer the best possible gameplay experience for the players.

Definition at line 361 of file StartGameSessionPlacementRequest.h.

◆ AddPlayerLatencies() [2/2]

StartGameSessionPlacementRequest& Aws::GameLift::Model::StartGameSessionPlacementRequest::AddPlayerLatencies ( PlayerLatency &&  value)
inline

Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS regions. This information is used to try to place the new game session where it can offer the best possible gameplay experience for the players.

Definition at line 369 of file StartGameSessionPlacementRequest.h.

◆ DesiredPlayerSessionsHasBeenSet()

bool Aws::GameLift::Model::StartGameSessionPlacementRequest::DesiredPlayerSessionsHasBeenSet ( ) const
inline

Set of information on each player to create a player session for.

Definition at line 380 of file StartGameSessionPlacementRequest.h.

◆ GamePropertiesHasBeenSet()

bool Aws::GameLift::Model::StartGameSessionPlacementRequest::GamePropertiesHasBeenSet ( ) const
inline

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

Definition at line 176 of file StartGameSessionPlacementRequest.h.

◆ GameSessionDataHasBeenSet()

bool Aws::GameLift::Model::StartGameSessionPlacementRequest::GameSessionDataHasBeenSet ( ) const
inline

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

Definition at line 429 of file StartGameSessionPlacementRequest.h.

◆ GameSessionNameHasBeenSet()

bool Aws::GameLift::Model::StartGameSessionPlacementRequest::GameSessionNameHasBeenSet ( ) const
inline

Descriptive label that is associated with a game session. Session names do not need to be unique.

Definition at line 268 of file StartGameSessionPlacementRequest.h.

◆ GameSessionQueueNameHasBeenSet()

bool Aws::GameLift::Model::StartGameSessionPlacementRequest::GameSessionQueueNameHasBeenSet ( ) const
inline

Name of the queue to use to place the new game session.

Definition at line 127 of file StartGameSessionPlacementRequest.h.

◆ GetDesiredPlayerSessions()

const Aws::Vector<DesiredPlayerSession>& Aws::GameLift::Model::StartGameSessionPlacementRequest::GetDesiredPlayerSessions ( ) const
inline

Set of information on each player to create a player session for.

Definition at line 375 of file StartGameSessionPlacementRequest.h.

◆ GetGameProperties()

const Aws::Vector<GameProperty>& Aws::GameLift::Model::StartGameSessionPlacementRequest::GetGameProperties ( ) const
inline

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

Definition at line 167 of file StartGameSessionPlacementRequest.h.

◆ GetGameSessionData()

const Aws::String& Aws::GameLift::Model::StartGameSessionPlacementRequest::GetGameSessionData ( ) const
inline

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

Definition at line 420 of file StartGameSessionPlacementRequest.h.

◆ GetGameSessionName()

const Aws::String& Aws::GameLift::Model::StartGameSessionPlacementRequest::GetGameSessionName ( ) const
inline

Descriptive label that is associated with a game session. Session names do not need to be unique.

Definition at line 262 of file StartGameSessionPlacementRequest.h.

◆ GetGameSessionQueueName()

const Aws::String& Aws::GameLift::Model::StartGameSessionPlacementRequest::GetGameSessionQueueName ( ) const
inline

Name of the queue to use to place the new game session.

Definition at line 122 of file StartGameSessionPlacementRequest.h.

◆ GetMaximumPlayerSessionCount()

int Aws::GameLift::Model::StartGameSessionPlacementRequest::GetMaximumPlayerSessionCount ( ) const
inline

Maximum number of players that can be connected simultaneously to the game session.

Definition at line 237 of file StartGameSessionPlacementRequest.h.

◆ GetPlacementId()

const Aws::String& Aws::GameLift::Model::StartGameSessionPlacementRequest::GetPlacementId ( ) const
inline

Unique identifier to assign to the new game session placement. This value is developer-defined. The value must be unique across all regions and cannot be reused unless you are resubmitting a canceled or timed-out placement request.

Definition at line 60 of file StartGameSessionPlacementRequest.h.

◆ GetPlayerLatencies()

const Aws::Vector<PlayerLatency>& Aws::GameLift::Model::StartGameSessionPlacementRequest::GetPlayerLatencies ( ) const
inline

Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS regions. This information is used to try to place the new game session where it can offer the best possible gameplay experience for the players.

Definition at line 313 of file StartGameSessionPlacementRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::GameLift::GameLiftRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 47 of file StartGameSessionPlacementRequest.h.

◆ MaximumPlayerSessionCountHasBeenSet()

bool Aws::GameLift::Model::StartGameSessionPlacementRequest::MaximumPlayerSessionCountHasBeenSet ( ) const
inline

Maximum number of players that can be connected simultaneously to the game session.

Definition at line 243 of file StartGameSessionPlacementRequest.h.

◆ PlacementIdHasBeenSet()

bool Aws::GameLift::Model::StartGameSessionPlacementRequest::PlacementIdHasBeenSet ( ) const
inline

Unique identifier to assign to the new game session placement. This value is developer-defined. The value must be unique across all regions and cannot be reused unless you are resubmitting a canceled or timed-out placement request.

Definition at line 68 of file StartGameSessionPlacementRequest.h.

◆ PlayerLatenciesHasBeenSet()

bool Aws::GameLift::Model::StartGameSessionPlacementRequest::PlayerLatenciesHasBeenSet ( ) const
inline

Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS regions. This information is used to try to place the new game session where it can offer the best possible gameplay experience for the players.

Definition at line 321 of file StartGameSessionPlacementRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDesiredPlayerSessions() [1/2]

void Aws::GameLift::Model::StartGameSessionPlacementRequest::SetDesiredPlayerSessions ( const Aws::Vector< DesiredPlayerSession > &  value)
inline

Set of information on each player to create a player session for.

Definition at line 385 of file StartGameSessionPlacementRequest.h.

◆ SetDesiredPlayerSessions() [2/2]

void Aws::GameLift::Model::StartGameSessionPlacementRequest::SetDesiredPlayerSessions ( Aws::Vector< DesiredPlayerSession > &&  value)
inline

Set of information on each player to create a player session for.

Definition at line 390 of file StartGameSessionPlacementRequest.h.

◆ SetGameProperties() [1/2]

void Aws::GameLift::Model::StartGameSessionPlacementRequest::SetGameProperties ( const Aws::Vector< GameProperty > &  value)
inline

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

Definition at line 185 of file StartGameSessionPlacementRequest.h.

◆ SetGameProperties() [2/2]

void Aws::GameLift::Model::StartGameSessionPlacementRequest::SetGameProperties ( Aws::Vector< GameProperty > &&  value)
inline

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

Definition at line 194 of file StartGameSessionPlacementRequest.h.

◆ SetGameSessionData() [1/3]

void Aws::GameLift::Model::StartGameSessionPlacementRequest::SetGameSessionData ( const Aws::String value)
inline

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

Definition at line 438 of file StartGameSessionPlacementRequest.h.

◆ SetGameSessionData() [2/3]

void Aws::GameLift::Model::StartGameSessionPlacementRequest::SetGameSessionData ( Aws::String &&  value)
inline

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

Definition at line 447 of file StartGameSessionPlacementRequest.h.

◆ SetGameSessionData() [3/3]

void Aws::GameLift::Model::StartGameSessionPlacementRequest::SetGameSessionData ( const char *  value)
inline

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

Definition at line 456 of file StartGameSessionPlacementRequest.h.

◆ SetGameSessionName() [1/3]

void Aws::GameLift::Model::StartGameSessionPlacementRequest::SetGameSessionName ( const Aws::String value)
inline

Descriptive label that is associated with a game session. Session names do not need to be unique.

Definition at line 274 of file StartGameSessionPlacementRequest.h.

◆ SetGameSessionName() [2/3]

void Aws::GameLift::Model::StartGameSessionPlacementRequest::SetGameSessionName ( Aws::String &&  value)
inline

Descriptive label that is associated with a game session. Session names do not need to be unique.

Definition at line 280 of file StartGameSessionPlacementRequest.h.

◆ SetGameSessionName() [3/3]

void Aws::GameLift::Model::StartGameSessionPlacementRequest::SetGameSessionName ( const char *  value)
inline

Descriptive label that is associated with a game session. Session names do not need to be unique.

Definition at line 286 of file StartGameSessionPlacementRequest.h.

◆ SetGameSessionQueueName() [1/3]

void Aws::GameLift::Model::StartGameSessionPlacementRequest::SetGameSessionQueueName ( const Aws::String value)
inline

Name of the queue to use to place the new game session.

Definition at line 132 of file StartGameSessionPlacementRequest.h.

◆ SetGameSessionQueueName() [2/3]

void Aws::GameLift::Model::StartGameSessionPlacementRequest::SetGameSessionQueueName ( Aws::String &&  value)
inline

Name of the queue to use to place the new game session.

Definition at line 137 of file StartGameSessionPlacementRequest.h.

◆ SetGameSessionQueueName() [3/3]

void Aws::GameLift::Model::StartGameSessionPlacementRequest::SetGameSessionQueueName ( const char *  value)
inline

Name of the queue to use to place the new game session.

Definition at line 142 of file StartGameSessionPlacementRequest.h.

◆ SetMaximumPlayerSessionCount()

void Aws::GameLift::Model::StartGameSessionPlacementRequest::SetMaximumPlayerSessionCount ( int  value)
inline

Maximum number of players that can be connected simultaneously to the game session.

Definition at line 249 of file StartGameSessionPlacementRequest.h.

◆ SetPlacementId() [1/3]

void Aws::GameLift::Model::StartGameSessionPlacementRequest::SetPlacementId ( const Aws::String value)
inline

Unique identifier to assign to the new game session placement. This value is developer-defined. The value must be unique across all regions and cannot be reused unless you are resubmitting a canceled or timed-out placement request.

Definition at line 76 of file StartGameSessionPlacementRequest.h.

◆ SetPlacementId() [2/3]

void Aws::GameLift::Model::StartGameSessionPlacementRequest::SetPlacementId ( Aws::String &&  value)
inline

Unique identifier to assign to the new game session placement. This value is developer-defined. The value must be unique across all regions and cannot be reused unless you are resubmitting a canceled or timed-out placement request.

Definition at line 84 of file StartGameSessionPlacementRequest.h.

◆ SetPlacementId() [3/3]

void Aws::GameLift::Model::StartGameSessionPlacementRequest::SetPlacementId ( const char *  value)
inline

Unique identifier to assign to the new game session placement. This value is developer-defined. The value must be unique across all regions and cannot be reused unless you are resubmitting a canceled or timed-out placement request.

Definition at line 92 of file StartGameSessionPlacementRequest.h.

◆ SetPlayerLatencies() [1/2]

void Aws::GameLift::Model::StartGameSessionPlacementRequest::SetPlayerLatencies ( const Aws::Vector< PlayerLatency > &  value)
inline

Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS regions. This information is used to try to place the new game session where it can offer the best possible gameplay experience for the players.

Definition at line 329 of file StartGameSessionPlacementRequest.h.

◆ SetPlayerLatencies() [2/2]

void Aws::GameLift::Model::StartGameSessionPlacementRequest::SetPlayerLatencies ( Aws::Vector< PlayerLatency > &&  value)
inline

Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS regions. This information is used to try to place the new game session where it can offer the best possible gameplay experience for the players.

Definition at line 337 of file StartGameSessionPlacementRequest.h.

◆ WithDesiredPlayerSessions() [1/2]

StartGameSessionPlacementRequest& Aws::GameLift::Model::StartGameSessionPlacementRequest::WithDesiredPlayerSessions ( const Aws::Vector< DesiredPlayerSession > &  value)
inline

Set of information on each player to create a player session for.

Definition at line 395 of file StartGameSessionPlacementRequest.h.

◆ WithDesiredPlayerSessions() [2/2]

StartGameSessionPlacementRequest& Aws::GameLift::Model::StartGameSessionPlacementRequest::WithDesiredPlayerSessions ( Aws::Vector< DesiredPlayerSession > &&  value)
inline

Set of information on each player to create a player session for.

Definition at line 400 of file StartGameSessionPlacementRequest.h.

◆ WithGameProperties() [1/2]

StartGameSessionPlacementRequest& Aws::GameLift::Model::StartGameSessionPlacementRequest::WithGameProperties ( const Aws::Vector< GameProperty > &  value)
inline

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

Definition at line 203 of file StartGameSessionPlacementRequest.h.

◆ WithGameProperties() [2/2]

StartGameSessionPlacementRequest& Aws::GameLift::Model::StartGameSessionPlacementRequest::WithGameProperties ( Aws::Vector< GameProperty > &&  value)
inline

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

Definition at line 212 of file StartGameSessionPlacementRequest.h.

◆ WithGameSessionData() [1/3]

StartGameSessionPlacementRequest& Aws::GameLift::Model::StartGameSessionPlacementRequest::WithGameSessionData ( const Aws::String value)
inline

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

Definition at line 465 of file StartGameSessionPlacementRequest.h.

◆ WithGameSessionData() [2/3]

StartGameSessionPlacementRequest& Aws::GameLift::Model::StartGameSessionPlacementRequest::WithGameSessionData ( Aws::String &&  value)
inline

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

Definition at line 474 of file StartGameSessionPlacementRequest.h.

◆ WithGameSessionData() [3/3]

StartGameSessionPlacementRequest& Aws::GameLift::Model::StartGameSessionPlacementRequest::WithGameSessionData ( const char *  value)
inline

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

Definition at line 483 of file StartGameSessionPlacementRequest.h.

◆ WithGameSessionName() [1/3]

StartGameSessionPlacementRequest& Aws::GameLift::Model::StartGameSessionPlacementRequest::WithGameSessionName ( const Aws::String value)
inline

Descriptive label that is associated with a game session. Session names do not need to be unique.

Definition at line 292 of file StartGameSessionPlacementRequest.h.

◆ WithGameSessionName() [2/3]

StartGameSessionPlacementRequest& Aws::GameLift::Model::StartGameSessionPlacementRequest::WithGameSessionName ( Aws::String &&  value)
inline

Descriptive label that is associated with a game session. Session names do not need to be unique.

Definition at line 298 of file StartGameSessionPlacementRequest.h.

◆ WithGameSessionName() [3/3]

StartGameSessionPlacementRequest& Aws::GameLift::Model::StartGameSessionPlacementRequest::WithGameSessionName ( const char *  value)
inline

Descriptive label that is associated with a game session. Session names do not need to be unique.

Definition at line 304 of file StartGameSessionPlacementRequest.h.

◆ WithGameSessionQueueName() [1/3]

StartGameSessionPlacementRequest& Aws::GameLift::Model::StartGameSessionPlacementRequest::WithGameSessionQueueName ( const Aws::String value)
inline

Name of the queue to use to place the new game session.

Definition at line 147 of file StartGameSessionPlacementRequest.h.

◆ WithGameSessionQueueName() [2/3]

StartGameSessionPlacementRequest& Aws::GameLift::Model::StartGameSessionPlacementRequest::WithGameSessionQueueName ( Aws::String &&  value)
inline

Name of the queue to use to place the new game session.

Definition at line 152 of file StartGameSessionPlacementRequest.h.

◆ WithGameSessionQueueName() [3/3]

StartGameSessionPlacementRequest& Aws::GameLift::Model::StartGameSessionPlacementRequest::WithGameSessionQueueName ( const char *  value)
inline

Name of the queue to use to place the new game session.

Definition at line 157 of file StartGameSessionPlacementRequest.h.

◆ WithMaximumPlayerSessionCount()

StartGameSessionPlacementRequest& Aws::GameLift::Model::StartGameSessionPlacementRequest::WithMaximumPlayerSessionCount ( int  value)
inline

Maximum number of players that can be connected simultaneously to the game session.

Definition at line 255 of file StartGameSessionPlacementRequest.h.

◆ WithPlacementId() [1/3]

StartGameSessionPlacementRequest& Aws::GameLift::Model::StartGameSessionPlacementRequest::WithPlacementId ( const Aws::String value)
inline

Unique identifier to assign to the new game session placement. This value is developer-defined. The value must be unique across all regions and cannot be reused unless you are resubmitting a canceled or timed-out placement request.

Definition at line 100 of file StartGameSessionPlacementRequest.h.

◆ WithPlacementId() [2/3]

StartGameSessionPlacementRequest& Aws::GameLift::Model::StartGameSessionPlacementRequest::WithPlacementId ( Aws::String &&  value)
inline

Unique identifier to assign to the new game session placement. This value is developer-defined. The value must be unique across all regions and cannot be reused unless you are resubmitting a canceled or timed-out placement request.

Definition at line 108 of file StartGameSessionPlacementRequest.h.

◆ WithPlacementId() [3/3]

StartGameSessionPlacementRequest& Aws::GameLift::Model::StartGameSessionPlacementRequest::WithPlacementId ( const char *  value)
inline

Unique identifier to assign to the new game session placement. This value is developer-defined. The value must be unique across all regions and cannot be reused unless you are resubmitting a canceled or timed-out placement request.

Definition at line 116 of file StartGameSessionPlacementRequest.h.

◆ WithPlayerLatencies() [1/2]

StartGameSessionPlacementRequest& Aws::GameLift::Model::StartGameSessionPlacementRequest::WithPlayerLatencies ( const Aws::Vector< PlayerLatency > &  value)
inline

Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS regions. This information is used to try to place the new game session where it can offer the best possible gameplay experience for the players.

Definition at line 345 of file StartGameSessionPlacementRequest.h.

◆ WithPlayerLatencies() [2/2]

StartGameSessionPlacementRequest& Aws::GameLift::Model::StartGameSessionPlacementRequest::WithPlayerLatencies ( Aws::Vector< PlayerLatency > &&  value)
inline

Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS regions. This information is used to try to place the new game session where it can offer the best possible gameplay experience for the players.

Definition at line 353 of file StartGameSessionPlacementRequest.h.


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