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

#include <StartMatchmakingRequest.h>

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

Public Member Functions

 StartMatchmakingRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetTicketId () const
 
bool TicketIdHasBeenSet () const
 
void SetTicketId (const Aws::String &value)
 
void SetTicketId (Aws::String &&value)
 
void SetTicketId (const char *value)
 
StartMatchmakingRequestWithTicketId (const Aws::String &value)
 
StartMatchmakingRequestWithTicketId (Aws::String &&value)
 
StartMatchmakingRequestWithTicketId (const char *value)
 
const Aws::StringGetConfigurationName () const
 
bool ConfigurationNameHasBeenSet () const
 
void SetConfigurationName (const Aws::String &value)
 
void SetConfigurationName (Aws::String &&value)
 
void SetConfigurationName (const char *value)
 
StartMatchmakingRequestWithConfigurationName (const Aws::String &value)
 
StartMatchmakingRequestWithConfigurationName (Aws::String &&value)
 
StartMatchmakingRequestWithConfigurationName (const char *value)
 
const Aws::Vector< Player > & GetPlayers () const
 
bool PlayersHasBeenSet () const
 
void SetPlayers (const Aws::Vector< Player > &value)
 
void SetPlayers (Aws::Vector< Player > &&value)
 
StartMatchmakingRequestWithPlayers (const Aws::Vector< Player > &value)
 
StartMatchmakingRequestWithPlayers (Aws::Vector< Player > &&value)
 
StartMatchmakingRequestAddPlayers (const Player &value)
 
StartMatchmakingRequestAddPlayers (Player &&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 36 of file StartMatchmakingRequest.h.

Constructor & Destructor Documentation

◆ StartMatchmakingRequest()

Aws::GameLift::Model::StartMatchmakingRequest::StartMatchmakingRequest ( )

Member Function Documentation

◆ AddPlayers() [1/2]

StartMatchmakingRequest& Aws::GameLift::Model::StartMatchmakingRequest::AddPlayers ( const Player value)
inline

Information on each player to be matched. This information must include a player ID, and may contain player attributes and latency data to be used in the matchmaking process. After a successful match, Player objects contain the name of the team the player is assigned to.

Definition at line 220 of file StartMatchmakingRequest.h.

◆ AddPlayers() [2/2]

StartMatchmakingRequest& Aws::GameLift::Model::StartMatchmakingRequest::AddPlayers ( Player &&  value)
inline

Information on each player to be matched. This information must include a player ID, and may contain player attributes and latency data to be used in the matchmaking process. After a successful match, Player objects contain the name of the team the player is assigned to.

Definition at line 228 of file StartMatchmakingRequest.h.

◆ ConfigurationNameHasBeenSet()

bool Aws::GameLift::Model::StartMatchmakingRequest::ConfigurationNameHasBeenSet ( ) const
inline

Name of the matchmaking configuration to use for this request. Matchmaking configurations must exist in the same region as this request.

Definition at line 127 of file StartMatchmakingRequest.h.

◆ GetConfigurationName()

const Aws::String& Aws::GameLift::Model::StartMatchmakingRequest::GetConfigurationName ( ) const
inline

Name of the matchmaking configuration to use for this request. Matchmaking configurations must exist in the same region as this request.

Definition at line 121 of file StartMatchmakingRequest.h.

◆ GetPlayers()

const Aws::Vector<Player>& Aws::GameLift::Model::StartMatchmakingRequest::GetPlayers ( ) const
inline

Information on each player to be matched. This information must include a player ID, and may contain player attributes and latency data to be used in the matchmaking process. After a successful match, Player objects contain the name of the team the player is assigned to.

Definition at line 172 of file StartMatchmakingRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::GameLift::GameLiftRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 45 of file StartMatchmakingRequest.h.

◆ GetTicketId()

const Aws::String& Aws::GameLift::Model::StartMatchmakingRequest::GetTicketId ( ) const
inline

Unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon GameLift will generate one in the form of a UUID. Use this identifier to track the matchmaking ticket status and retrieve match results.

Definition at line 58 of file StartMatchmakingRequest.h.

◆ PlayersHasBeenSet()

bool Aws::GameLift::Model::StartMatchmakingRequest::PlayersHasBeenSet ( ) const
inline

Information on each player to be matched. This information must include a player ID, and may contain player attributes and latency data to be used in the matchmaking process. After a successful match, Player objects contain the name of the team the player is assigned to.

Definition at line 180 of file StartMatchmakingRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetConfigurationName() [1/3]

void Aws::GameLift::Model::StartMatchmakingRequest::SetConfigurationName ( const Aws::String value)
inline

Name of the matchmaking configuration to use for this request. Matchmaking configurations must exist in the same region as this request.

Definition at line 133 of file StartMatchmakingRequest.h.

◆ SetConfigurationName() [2/3]

void Aws::GameLift::Model::StartMatchmakingRequest::SetConfigurationName ( Aws::String &&  value)
inline

Name of the matchmaking configuration to use for this request. Matchmaking configurations must exist in the same region as this request.

Definition at line 139 of file StartMatchmakingRequest.h.

◆ SetConfigurationName() [3/3]

void Aws::GameLift::Model::StartMatchmakingRequest::SetConfigurationName ( const char *  value)
inline

Name of the matchmaking configuration to use for this request. Matchmaking configurations must exist in the same region as this request.

Definition at line 145 of file StartMatchmakingRequest.h.

◆ SetPlayers() [1/2]

void Aws::GameLift::Model::StartMatchmakingRequest::SetPlayers ( const Aws::Vector< Player > &  value)
inline

Information on each player to be matched. This information must include a player ID, and may contain player attributes and latency data to be used in the matchmaking process. After a successful match, Player objects contain the name of the team the player is assigned to.

Definition at line 188 of file StartMatchmakingRequest.h.

◆ SetPlayers() [2/2]

void Aws::GameLift::Model::StartMatchmakingRequest::SetPlayers ( Aws::Vector< Player > &&  value)
inline

Information on each player to be matched. This information must include a player ID, and may contain player attributes and latency data to be used in the matchmaking process. After a successful match, Player objects contain the name of the team the player is assigned to.

Definition at line 196 of file StartMatchmakingRequest.h.

◆ SetTicketId() [1/3]

void Aws::GameLift::Model::StartMatchmakingRequest::SetTicketId ( const Aws::String value)
inline

Unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon GameLift will generate one in the form of a UUID. Use this identifier to track the matchmaking ticket status and retrieve match results.

Definition at line 74 of file StartMatchmakingRequest.h.

◆ SetTicketId() [2/3]

void Aws::GameLift::Model::StartMatchmakingRequest::SetTicketId ( Aws::String &&  value)
inline

Unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon GameLift will generate one in the form of a UUID. Use this identifier to track the matchmaking ticket status and retrieve match results.

Definition at line 82 of file StartMatchmakingRequest.h.

◆ SetTicketId() [3/3]

void Aws::GameLift::Model::StartMatchmakingRequest::SetTicketId ( const char *  value)
inline

Unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon GameLift will generate one in the form of a UUID. Use this identifier to track the matchmaking ticket status and retrieve match results.

Definition at line 90 of file StartMatchmakingRequest.h.

◆ TicketIdHasBeenSet()

bool Aws::GameLift::Model::StartMatchmakingRequest::TicketIdHasBeenSet ( ) const
inline

Unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon GameLift will generate one in the form of a UUID. Use this identifier to track the matchmaking ticket status and retrieve match results.

Definition at line 66 of file StartMatchmakingRequest.h.

◆ WithConfigurationName() [1/3]

StartMatchmakingRequest& Aws::GameLift::Model::StartMatchmakingRequest::WithConfigurationName ( const Aws::String value)
inline

Name of the matchmaking configuration to use for this request. Matchmaking configurations must exist in the same region as this request.

Definition at line 151 of file StartMatchmakingRequest.h.

◆ WithConfigurationName() [2/3]

StartMatchmakingRequest& Aws::GameLift::Model::StartMatchmakingRequest::WithConfigurationName ( Aws::String &&  value)
inline

Name of the matchmaking configuration to use for this request. Matchmaking configurations must exist in the same region as this request.

Definition at line 157 of file StartMatchmakingRequest.h.

◆ WithConfigurationName() [3/3]

StartMatchmakingRequest& Aws::GameLift::Model::StartMatchmakingRequest::WithConfigurationName ( const char *  value)
inline

Name of the matchmaking configuration to use for this request. Matchmaking configurations must exist in the same region as this request.

Definition at line 163 of file StartMatchmakingRequest.h.

◆ WithPlayers() [1/2]

StartMatchmakingRequest& Aws::GameLift::Model::StartMatchmakingRequest::WithPlayers ( const Aws::Vector< Player > &  value)
inline

Information on each player to be matched. This information must include a player ID, and may contain player attributes and latency data to be used in the matchmaking process. After a successful match, Player objects contain the name of the team the player is assigned to.

Definition at line 204 of file StartMatchmakingRequest.h.

◆ WithPlayers() [2/2]

StartMatchmakingRequest& Aws::GameLift::Model::StartMatchmakingRequest::WithPlayers ( Aws::Vector< Player > &&  value)
inline

Information on each player to be matched. This information must include a player ID, and may contain player attributes and latency data to be used in the matchmaking process. After a successful match, Player objects contain the name of the team the player is assigned to.

Definition at line 212 of file StartMatchmakingRequest.h.

◆ WithTicketId() [1/3]

StartMatchmakingRequest& Aws::GameLift::Model::StartMatchmakingRequest::WithTicketId ( const Aws::String value)
inline

Unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon GameLift will generate one in the form of a UUID. Use this identifier to track the matchmaking ticket status and retrieve match results.

Definition at line 98 of file StartMatchmakingRequest.h.

◆ WithTicketId() [2/3]

StartMatchmakingRequest& Aws::GameLift::Model::StartMatchmakingRequest::WithTicketId ( Aws::String &&  value)
inline

Unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon GameLift will generate one in the form of a UUID. Use this identifier to track the matchmaking ticket status and retrieve match results.

Definition at line 106 of file StartMatchmakingRequest.h.

◆ WithTicketId() [3/3]

StartMatchmakingRequest& Aws::GameLift::Model::StartMatchmakingRequest::WithTicketId ( const char *  value)
inline

Unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon GameLift will generate one in the form of a UUID. Use this identifier to track the matchmaking ticket status and retrieve match results.

Definition at line 114 of file StartMatchmakingRequest.h.


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