AWS SDK for C++  1.7.349
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)
 
- 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 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 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. When updating this list, provide a complete list of destinations.

Definition at line 298 of file UpdateGameSessionQueueRequest.h.

◆ AddDestinations() [2/2]

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

A 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. When updating this list, provide a complete list of destinations.

Definition at line 306 of file UpdateGameSessionQueueRequest.h.

◆ AddPlayerLatencyPolicies() [1/2]

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

A 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, the policy 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. When updating policies, provide a complete collection of policies.

Definition at line 228 of file UpdateGameSessionQueueRequest.h.

◆ AddPlayerLatencyPolicies() [2/2]

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

A 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, the policy 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. When updating policies, provide a complete collection of policies.

Definition at line 241 of file UpdateGameSessionQueueRequest.h.

◆ DestinationsHasBeenSet()

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

A 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. When updating this list, provide a complete list of destinations.

Definition at line 258 of file UpdateGameSessionQueueRequest.h.

◆ GetDestinations()

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

A 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. When updating this list, provide a complete list of destinations.

Definition at line 250 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 58 of file UpdateGameSessionQueueRequest.h.

◆ GetPlayerLatencyPolicies()

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

A 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, the policy 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. When updating policies, provide a complete collection of policies.

Definition at line 150 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 46 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 115 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 65 of file UpdateGameSessionQueueRequest.h.

◆ PlayerLatencyPoliciesHasBeenSet()

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

A 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, the policy 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. When updating policies, provide a complete collection of policies.

Definition at line 163 of file UpdateGameSessionQueueRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDestinations() [1/2]

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

A 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. When updating this list, provide a complete list of destinations.

Definition at line 266 of file UpdateGameSessionQueueRequest.h.

◆ SetDestinations() [2/2]

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

A 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. When updating this list, provide a complete list of destinations.

Definition at line 274 of file UpdateGameSessionQueueRequest.h.

◆ SetName() [1/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 72 of file UpdateGameSessionQueueRequest.h.

◆ SetName() [2/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 79 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 86 of file UpdateGameSessionQueueRequest.h.

◆ SetPlayerLatencyPolicies() [1/2]

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

A 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, the policy 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. When updating policies, provide a complete collection of policies.

Definition at line 176 of file UpdateGameSessionQueueRequest.h.

◆ SetPlayerLatencyPolicies() [2/2]

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

A 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, the policy 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. When updating policies, provide a complete collection of policies.

Definition at line 189 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 129 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 122 of file UpdateGameSessionQueueRequest.h.

◆ WithDestinations() [1/2]

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

A 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. When updating this list, provide a complete list of destinations.

Definition at line 282 of file UpdateGameSessionQueueRequest.h.

◆ WithDestinations() [2/2]

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

A 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. When updating this list, provide a complete list of destinations.

Definition at line 290 of file UpdateGameSessionQueueRequest.h.

◆ WithName() [1/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 93 of file UpdateGameSessionQueueRequest.h.

◆ WithName() [2/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 100 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 107 of file UpdateGameSessionQueueRequest.h.

◆ WithPlayerLatencyPolicies() [1/2]

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

A 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, the policy 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. When updating policies, provide a complete collection of policies.

Definition at line 202 of file UpdateGameSessionQueueRequest.h.

◆ WithPlayerLatencyPolicies() [2/2]

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

A 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, the policy 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. When updating policies, provide a complete collection of policies.

Definition at line 215 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 136 of file UpdateGameSessionQueueRequest.h.


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