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

#include <CreateGameSessionQueueRequest.h>

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

Public Member Functions

 CreateGameSessionQueueRequest ()
 
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)
 
CreateGameSessionQueueRequestWithName (const Aws::String &value)
 
CreateGameSessionQueueRequestWithName (Aws::String &&value)
 
CreateGameSessionQueueRequestWithName (const char *value)
 
int GetTimeoutInSeconds () const
 
bool TimeoutInSecondsHasBeenSet () const
 
void SetTimeoutInSeconds (int value)
 
CreateGameSessionQueueRequestWithTimeoutInSeconds (int value)
 
const Aws::Vector< PlayerLatencyPolicy > & GetPlayerLatencyPolicies () const
 
bool PlayerLatencyPoliciesHasBeenSet () const
 
void SetPlayerLatencyPolicies (const Aws::Vector< PlayerLatencyPolicy > &value)
 
void SetPlayerLatencyPolicies (Aws::Vector< PlayerLatencyPolicy > &&value)
 
CreateGameSessionQueueRequestWithPlayerLatencyPolicies (const Aws::Vector< PlayerLatencyPolicy > &value)
 
CreateGameSessionQueueRequestWithPlayerLatencyPolicies (Aws::Vector< PlayerLatencyPolicy > &&value)
 
CreateGameSessionQueueRequestAddPlayerLatencyPolicies (const PlayerLatencyPolicy &value)
 
CreateGameSessionQueueRequestAddPlayerLatencyPolicies (PlayerLatencyPolicy &&value)
 
const Aws::Vector< GameSessionQueueDestination > & GetDestinations () const
 
bool DestinationsHasBeenSet () const
 
void SetDestinations (const Aws::Vector< GameSessionQueueDestination > &value)
 
void SetDestinations (Aws::Vector< GameSessionQueueDestination > &&value)
 
CreateGameSessionQueueRequestWithDestinations (const Aws::Vector< GameSessionQueueDestination > &value)
 
CreateGameSessionQueueRequestWithDestinations (Aws::Vector< GameSessionQueueDestination > &&value)
 
CreateGameSessionQueueRequestAddDestinations (const GameSessionQueueDestination &value)
 
CreateGameSessionQueueRequestAddDestinations (GameSessionQueueDestination &&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 37 of file CreateGameSessionQueueRequest.h.

Constructor & Destructor Documentation

◆ CreateGameSessionQueueRequest()

Aws::GameLift::Model::CreateGameSessionQueueRequest::CreateGameSessionQueueRequest ( )

Member Function Documentation

◆ AddDestinations() [1/2]

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

List of fleets that can be used to fulfill game session placement requests in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. Destinations are listed in default preference order.

Definition at line 291 of file CreateGameSessionQueueRequest.h.

◆ AddDestinations() [2/2]

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

List of fleets that can be used to fulfill game session placement requests in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. Destinations are listed in default preference order.

Definition at line 298 of file CreateGameSessionQueueRequest.h.

◆ AddPlayerLatencyPolicies() [1/2]

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

Collection of latency policies to apply when processing game sessions placement requests with player latency information. Multiple policies are evaluated in order of the maximum latency value, starting with the lowest latency values. With just one policy, it is enforced at the start of the game session placement for the duration period. With multiple policies, each policy is enforced consecutively for its duration period. For example, a queue might enforce a 60-second policy followed by a 120-second policy, and then no policy for the remainder of the placement. A player latency policy must set a value for MaximumIndividualPlayerLatencyMilliseconds; if none is set, this API requests will fail.

Definition at line 227 of file CreateGameSessionQueueRequest.h.

◆ AddPlayerLatencyPolicies() [2/2]

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

Collection of latency policies to apply when processing game sessions placement requests with player latency information. Multiple policies are evaluated in order of the maximum latency value, starting with the lowest latency values. With just one policy, it is enforced at the start of the game session placement for the duration period. With multiple policies, each policy is enforced consecutively for its duration period. For example, a queue might enforce a 60-second policy followed by a 120-second policy, and then no policy for the remainder of the placement. A player latency policy must set a value for MaximumIndividualPlayerLatencyMilliseconds; if none is set, this API requests will fail.

Definition at line 241 of file CreateGameSessionQueueRequest.h.

◆ DestinationsHasBeenSet()

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

List of fleets that can be used to fulfill game session placement requests in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. Destinations are listed in default preference order.

Definition at line 256 of file CreateGameSessionQueueRequest.h.

◆ GetDestinations()

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

List of fleets that can be used to fulfill game session placement requests in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. Destinations are listed in default preference order.

Definition at line 249 of file CreateGameSessionQueueRequest.h.

◆ GetName()

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

Descriptive label that is associated with game session queue. Queue names must be unique within each region.

Definition at line 57 of file CreateGameSessionQueueRequest.h.

◆ GetPlayerLatencyPolicies()

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

Collection of latency policies to apply when processing game sessions placement requests with player latency information. Multiple policies are evaluated in order of the maximum latency value, starting with the lowest latency values. With just one policy, it is enforced at the start of the game session placement for the duration period. With multiple policies, each policy is enforced consecutively for its duration period. For example, a queue might enforce a 60-second policy followed by a 120-second policy, and then no policy for the remainder of the placement. A player latency policy must set a value for MaximumIndividualPlayerLatencyMilliseconds; if none is set, this API requests will fail.

Definition at line 143 of file CreateGameSessionQueueRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::GameLift::GameLiftRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 46 of file CreateGameSessionQueueRequest.h.

◆ GetTimeoutInSeconds()

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

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 CreateGameSessionQueueRequest.h.

◆ NameHasBeenSet()

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

Descriptive label that is associated with game session queue. Queue names must be unique within each region.

Definition at line 63 of file CreateGameSessionQueueRequest.h.

◆ PlayerLatencyPoliciesHasBeenSet()

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

Collection of latency policies to apply when processing game sessions placement requests with player latency information. Multiple policies are evaluated in order of the maximum latency value, starting with the lowest latency values. With just one policy, it is enforced at the start of the game session placement for the duration period. With multiple policies, each policy is enforced consecutively for its duration period. For example, a queue might enforce a 60-second policy followed by a 120-second policy, and then no policy for the remainder of the placement. A player latency policy must set a value for MaximumIndividualPlayerLatencyMilliseconds; if none is set, this API requests will fail.

Definition at line 157 of file CreateGameSessionQueueRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDestinations() [1/2]

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

List of fleets that can be used to fulfill game session placement requests in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. Destinations are listed in default preference order.

Definition at line 263 of file CreateGameSessionQueueRequest.h.

◆ SetDestinations() [2/2]

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

List of fleets that can be used to fulfill game session placement requests in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. Destinations are listed in default preference order.

Definition at line 270 of file CreateGameSessionQueueRequest.h.

◆ SetName() [1/3]

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

Descriptive label that is associated with game session queue. Queue names must be unique within each region.

Definition at line 69 of file CreateGameSessionQueueRequest.h.

◆ SetName() [2/3]

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

Descriptive label that is associated with game session queue. Queue names must be unique within each region.

Definition at line 75 of file CreateGameSessionQueueRequest.h.

◆ SetName() [3/3]

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

Descriptive label that is associated with game session queue. Queue names must be unique within each region.

Definition at line 81 of file CreateGameSessionQueueRequest.h.

◆ SetPlayerLatencyPolicies() [1/2]

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

Collection of latency policies to apply when processing game sessions placement requests with player latency information. Multiple policies are evaluated in order of the maximum latency value, starting with the lowest latency values. With just one policy, it is enforced at the start of the game session placement for the duration period. With multiple policies, each policy is enforced consecutively for its duration period. For example, a queue might enforce a 60-second policy followed by a 120-second policy, and then no policy for the remainder of the placement. A player latency policy must set a value for MaximumIndividualPlayerLatencyMilliseconds; if none is set, this API requests will fail.

Definition at line 171 of file CreateGameSessionQueueRequest.h.

◆ SetPlayerLatencyPolicies() [2/2]

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

Collection of latency policies to apply when processing game sessions placement requests with player latency information. Multiple policies are evaluated in order of the maximum latency value, starting with the lowest latency values. With just one policy, it is enforced at the start of the game session placement for the duration period. With multiple policies, each policy is enforced consecutively for its duration period. For example, a queue might enforce a 60-second policy followed by a 120-second policy, and then no policy for the remainder of the placement. A player latency policy must set a value for MaximumIndividualPlayerLatencyMilliseconds; if none is set, this API requests will fail.

Definition at line 185 of file CreateGameSessionQueueRequest.h.

◆ SetTimeoutInSeconds()

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

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 CreateGameSessionQueueRequest.h.

◆ TimeoutInSecondsHasBeenSet()

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

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 CreateGameSessionQueueRequest.h.

◆ WithDestinations() [1/2]

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

List of fleets that can be used to fulfill game session placement requests in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. Destinations are listed in default preference order.

Definition at line 277 of file CreateGameSessionQueueRequest.h.

◆ WithDestinations() [2/2]

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

List of fleets that can be used to fulfill game session placement requests in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. Destinations are listed in default preference order.

Definition at line 284 of file CreateGameSessionQueueRequest.h.

◆ WithName() [1/3]

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

Descriptive label that is associated with game session queue. Queue names must be unique within each region.

Definition at line 87 of file CreateGameSessionQueueRequest.h.

◆ WithName() [2/3]

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

Descriptive label that is associated with game session queue. Queue names must be unique within each region.

Definition at line 93 of file CreateGameSessionQueueRequest.h.

◆ WithName() [3/3]

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

Descriptive label that is associated with game session queue. Queue names must be unique within each region.

Definition at line 99 of file CreateGameSessionQueueRequest.h.

◆ WithPlayerLatencyPolicies() [1/2]

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

Collection of latency policies to apply when processing game sessions placement requests with player latency information. Multiple policies are evaluated in order of the maximum latency value, starting with the lowest latency values. With just one policy, it is enforced at the start of the game session placement for the duration period. With multiple policies, each policy is enforced consecutively for its duration period. For example, a queue might enforce a 60-second policy followed by a 120-second policy, and then no policy for the remainder of the placement. A player latency policy must set a value for MaximumIndividualPlayerLatencyMilliseconds; if none is set, this API requests will fail.

Definition at line 199 of file CreateGameSessionQueueRequest.h.

◆ WithPlayerLatencyPolicies() [2/2]

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

Collection of latency policies to apply when processing game sessions placement requests with player latency information. Multiple policies are evaluated in order of the maximum latency value, starting with the lowest latency values. With just one policy, it is enforced at the start of the game session placement for the duration period. With multiple policies, each policy is enforced consecutively for its duration period. For example, a queue might enforce a 60-second policy followed by a 120-second policy, and then no policy for the remainder of the placement. A player latency policy must set a value for MaximumIndividualPlayerLatencyMilliseconds; if none is set, this API requests will fail.

Definition at line 213 of file CreateGameSessionQueueRequest.h.

◆ WithTimeoutInSeconds()

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

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 CreateGameSessionQueueRequest.h.


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