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

#include <DescribeGameSessionsRequest.h>

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

Public Member Functions

 DescribeGameSessionsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetFleetId () const
 
bool FleetIdHasBeenSet () const
 
void SetFleetId (const Aws::String &value)
 
void SetFleetId (Aws::String &&value)
 
void SetFleetId (const char *value)
 
DescribeGameSessionsRequestWithFleetId (const Aws::String &value)
 
DescribeGameSessionsRequestWithFleetId (Aws::String &&value)
 
DescribeGameSessionsRequestWithFleetId (const char *value)
 
const Aws::StringGetGameSessionId () const
 
bool GameSessionIdHasBeenSet () const
 
void SetGameSessionId (const Aws::String &value)
 
void SetGameSessionId (Aws::String &&value)
 
void SetGameSessionId (const char *value)
 
DescribeGameSessionsRequestWithGameSessionId (const Aws::String &value)
 
DescribeGameSessionsRequestWithGameSessionId (Aws::String &&value)
 
DescribeGameSessionsRequestWithGameSessionId (const char *value)
 
const Aws::StringGetAliasId () const
 
bool AliasIdHasBeenSet () const
 
void SetAliasId (const Aws::String &value)
 
void SetAliasId (Aws::String &&value)
 
void SetAliasId (const char *value)
 
DescribeGameSessionsRequestWithAliasId (const Aws::String &value)
 
DescribeGameSessionsRequestWithAliasId (Aws::String &&value)
 
DescribeGameSessionsRequestWithAliasId (const char *value)
 
const Aws::StringGetStatusFilter () const
 
bool StatusFilterHasBeenSet () const
 
void SetStatusFilter (const Aws::String &value)
 
void SetStatusFilter (Aws::String &&value)
 
void SetStatusFilter (const char *value)
 
DescribeGameSessionsRequestWithStatusFilter (const Aws::String &value)
 
DescribeGameSessionsRequestWithStatusFilter (Aws::String &&value)
 
DescribeGameSessionsRequestWithStatusFilter (const char *value)
 
int GetLimit () const
 
bool LimitHasBeenSet () const
 
void SetLimit (int value)
 
DescribeGameSessionsRequestWithLimit (int value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
DescribeGameSessionsRequestWithNextToken (const Aws::String &value)
 
DescribeGameSessionsRequestWithNextToken (Aws::String &&value)
 
DescribeGameSessionsRequestWithNextToken (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 34 of file DescribeGameSessionsRequest.h.

Constructor & Destructor Documentation

◆ DescribeGameSessionsRequest()

Aws::GameLift::Model::DescribeGameSessionsRequest::DescribeGameSessionsRequest ( )

Member Function Documentation

◆ AliasIdHasBeenSet()

bool Aws::GameLift::Model::DescribeGameSessionsRequest::AliasIdHasBeenSet ( ) const
inline

Unique identifier for an alias associated with the fleet to retrieve all game sessions for.

Definition at line 150 of file DescribeGameSessionsRequest.h.

◆ FleetIdHasBeenSet()

bool Aws::GameLift::Model::DescribeGameSessionsRequest::FleetIdHasBeenSet ( ) const
inline

Unique identifier for a fleet to retrieve all game sessions for.

Definition at line 58 of file DescribeGameSessionsRequest.h.

◆ GameSessionIdHasBeenSet()

bool Aws::GameLift::Model::DescribeGameSessionsRequest::GameSessionIdHasBeenSet ( ) const
inline

Unique identifier for the game session to retrieve. You can use either a GameSessionId or GameSessionArn value.

Definition at line 101 of file DescribeGameSessionsRequest.h.

◆ GetAliasId()

const Aws::String& Aws::GameLift::Model::DescribeGameSessionsRequest::GetAliasId ( ) const
inline

Unique identifier for an alias associated with the fleet to retrieve all game sessions for.

Definition at line 144 of file DescribeGameSessionsRequest.h.

◆ GetFleetId()

const Aws::String& Aws::GameLift::Model::DescribeGameSessionsRequest::GetFleetId ( ) const
inline

Unique identifier for a fleet to retrieve all game sessions for.

Definition at line 53 of file DescribeGameSessionsRequest.h.

◆ GetGameSessionId()

const Aws::String& Aws::GameLift::Model::DescribeGameSessionsRequest::GetGameSessionId ( ) const
inline

Unique identifier for the game session to retrieve. You can use either a GameSessionId or GameSessionArn value.

Definition at line 95 of file DescribeGameSessionsRequest.h.

◆ GetLimit()

int Aws::GameLift::Model::DescribeGameSessionsRequest::GetLimit ( ) const
inline

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

Definition at line 250 of file DescribeGameSessionsRequest.h.

◆ GetNextToken()

const Aws::String& Aws::GameLift::Model::DescribeGameSessionsRequest::GetNextToken ( ) const
inline

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

Definition at line 276 of file DescribeGameSessionsRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::GameLift::GameLiftRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 43 of file DescribeGameSessionsRequest.h.

◆ GetStatusFilter()

const Aws::String& Aws::GameLift::Model::DescribeGameSessionsRequest::GetStatusFilter ( ) const
inline

Game session status to filter results on. Possible game session statuses include ACTIVE, TERMINATED, ACTIVATING, and TERMINATING (the last two are transitory).

Definition at line 194 of file DescribeGameSessionsRequest.h.

◆ LimitHasBeenSet()

bool Aws::GameLift::Model::DescribeGameSessionsRequest::LimitHasBeenSet ( ) const
inline

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

Definition at line 256 of file DescribeGameSessionsRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::GameLift::Model::DescribeGameSessionsRequest::NextTokenHasBeenSet ( ) const
inline

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

Definition at line 283 of file DescribeGameSessionsRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAliasId() [1/3]

void Aws::GameLift::Model::DescribeGameSessionsRequest::SetAliasId ( const Aws::String value)
inline

Unique identifier for an alias associated with the fleet to retrieve all game sessions for.

Definition at line 156 of file DescribeGameSessionsRequest.h.

◆ SetAliasId() [2/3]

void Aws::GameLift::Model::DescribeGameSessionsRequest::SetAliasId ( Aws::String &&  value)
inline

Unique identifier for an alias associated with the fleet to retrieve all game sessions for.

Definition at line 162 of file DescribeGameSessionsRequest.h.

◆ SetAliasId() [3/3]

void Aws::GameLift::Model::DescribeGameSessionsRequest::SetAliasId ( const char *  value)
inline

Unique identifier for an alias associated with the fleet to retrieve all game sessions for.

Definition at line 168 of file DescribeGameSessionsRequest.h.

◆ SetFleetId() [1/3]

void Aws::GameLift::Model::DescribeGameSessionsRequest::SetFleetId ( const Aws::String value)
inline

Unique identifier for a fleet to retrieve all game sessions for.

Definition at line 63 of file DescribeGameSessionsRequest.h.

◆ SetFleetId() [2/3]

void Aws::GameLift::Model::DescribeGameSessionsRequest::SetFleetId ( Aws::String &&  value)
inline

Unique identifier for a fleet to retrieve all game sessions for.

Definition at line 68 of file DescribeGameSessionsRequest.h.

◆ SetFleetId() [3/3]

void Aws::GameLift::Model::DescribeGameSessionsRequest::SetFleetId ( const char *  value)
inline

Unique identifier for a fleet to retrieve all game sessions for.

Definition at line 73 of file DescribeGameSessionsRequest.h.

◆ SetGameSessionId() [1/3]

void Aws::GameLift::Model::DescribeGameSessionsRequest::SetGameSessionId ( const Aws::String value)
inline

Unique identifier for the game session to retrieve. You can use either a GameSessionId or GameSessionArn value.

Definition at line 107 of file DescribeGameSessionsRequest.h.

◆ SetGameSessionId() [2/3]

void Aws::GameLift::Model::DescribeGameSessionsRequest::SetGameSessionId ( Aws::String &&  value)
inline

Unique identifier for the game session to retrieve. You can use either a GameSessionId or GameSessionArn value.

Definition at line 113 of file DescribeGameSessionsRequest.h.

◆ SetGameSessionId() [3/3]

void Aws::GameLift::Model::DescribeGameSessionsRequest::SetGameSessionId ( const char *  value)
inline

Unique identifier for the game session to retrieve. You can use either a GameSessionId or GameSessionArn value.

Definition at line 119 of file DescribeGameSessionsRequest.h.

◆ SetLimit()

void Aws::GameLift::Model::DescribeGameSessionsRequest::SetLimit ( int  value)
inline

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

Definition at line 262 of file DescribeGameSessionsRequest.h.

◆ SetNextToken() [1/3]

void Aws::GameLift::Model::DescribeGameSessionsRequest::SetNextToken ( const Aws::String value)
inline

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

Definition at line 290 of file DescribeGameSessionsRequest.h.

◆ SetNextToken() [2/3]

void Aws::GameLift::Model::DescribeGameSessionsRequest::SetNextToken ( Aws::String &&  value)
inline

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

Definition at line 297 of file DescribeGameSessionsRequest.h.

◆ SetNextToken() [3/3]

void Aws::GameLift::Model::DescribeGameSessionsRequest::SetNextToken ( const char *  value)
inline

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

Definition at line 304 of file DescribeGameSessionsRequest.h.

◆ SetStatusFilter() [1/3]

void Aws::GameLift::Model::DescribeGameSessionsRequest::SetStatusFilter ( const Aws::String value)
inline

Game session status to filter results on. Possible game session statuses include ACTIVE, TERMINATED, ACTIVATING, and TERMINATING (the last two are transitory).

Definition at line 208 of file DescribeGameSessionsRequest.h.

◆ SetStatusFilter() [2/3]

void Aws::GameLift::Model::DescribeGameSessionsRequest::SetStatusFilter ( Aws::String &&  value)
inline

Game session status to filter results on. Possible game session statuses include ACTIVE, TERMINATED, ACTIVATING, and TERMINATING (the last two are transitory).

Definition at line 215 of file DescribeGameSessionsRequest.h.

◆ SetStatusFilter() [3/3]

void Aws::GameLift::Model::DescribeGameSessionsRequest::SetStatusFilter ( const char *  value)
inline

Game session status to filter results on. Possible game session statuses include ACTIVE, TERMINATED, ACTIVATING, and TERMINATING (the last two are transitory).

Definition at line 222 of file DescribeGameSessionsRequest.h.

◆ StatusFilterHasBeenSet()

bool Aws::GameLift::Model::DescribeGameSessionsRequest::StatusFilterHasBeenSet ( ) const
inline

Game session status to filter results on. Possible game session statuses include ACTIVE, TERMINATED, ACTIVATING, and TERMINATING (the last two are transitory).

Definition at line 201 of file DescribeGameSessionsRequest.h.

◆ WithAliasId() [1/3]

DescribeGameSessionsRequest& Aws::GameLift::Model::DescribeGameSessionsRequest::WithAliasId ( const Aws::String value)
inline

Unique identifier for an alias associated with the fleet to retrieve all game sessions for.

Definition at line 174 of file DescribeGameSessionsRequest.h.

◆ WithAliasId() [2/3]

DescribeGameSessionsRequest& Aws::GameLift::Model::DescribeGameSessionsRequest::WithAliasId ( Aws::String &&  value)
inline

Unique identifier for an alias associated with the fleet to retrieve all game sessions for.

Definition at line 180 of file DescribeGameSessionsRequest.h.

◆ WithAliasId() [3/3]

DescribeGameSessionsRequest& Aws::GameLift::Model::DescribeGameSessionsRequest::WithAliasId ( const char *  value)
inline

Unique identifier for an alias associated with the fleet to retrieve all game sessions for.

Definition at line 186 of file DescribeGameSessionsRequest.h.

◆ WithFleetId() [1/3]

DescribeGameSessionsRequest& Aws::GameLift::Model::DescribeGameSessionsRequest::WithFleetId ( const Aws::String value)
inline

Unique identifier for a fleet to retrieve all game sessions for.

Definition at line 78 of file DescribeGameSessionsRequest.h.

◆ WithFleetId() [2/3]

DescribeGameSessionsRequest& Aws::GameLift::Model::DescribeGameSessionsRequest::WithFleetId ( Aws::String &&  value)
inline

Unique identifier for a fleet to retrieve all game sessions for.

Definition at line 83 of file DescribeGameSessionsRequest.h.

◆ WithFleetId() [3/3]

DescribeGameSessionsRequest& Aws::GameLift::Model::DescribeGameSessionsRequest::WithFleetId ( const char *  value)
inline

Unique identifier for a fleet to retrieve all game sessions for.

Definition at line 88 of file DescribeGameSessionsRequest.h.

◆ WithGameSessionId() [1/3]

DescribeGameSessionsRequest& Aws::GameLift::Model::DescribeGameSessionsRequest::WithGameSessionId ( const Aws::String value)
inline

Unique identifier for the game session to retrieve. You can use either a GameSessionId or GameSessionArn value.

Definition at line 125 of file DescribeGameSessionsRequest.h.

◆ WithGameSessionId() [2/3]

DescribeGameSessionsRequest& Aws::GameLift::Model::DescribeGameSessionsRequest::WithGameSessionId ( Aws::String &&  value)
inline

Unique identifier for the game session to retrieve. You can use either a GameSessionId or GameSessionArn value.

Definition at line 131 of file DescribeGameSessionsRequest.h.

◆ WithGameSessionId() [3/3]

DescribeGameSessionsRequest& Aws::GameLift::Model::DescribeGameSessionsRequest::WithGameSessionId ( const char *  value)
inline

Unique identifier for the game session to retrieve. You can use either a GameSessionId or GameSessionArn value.

Definition at line 137 of file DescribeGameSessionsRequest.h.

◆ WithLimit()

DescribeGameSessionsRequest& Aws::GameLift::Model::DescribeGameSessionsRequest::WithLimit ( int  value)
inline

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

Definition at line 268 of file DescribeGameSessionsRequest.h.

◆ WithNextToken() [1/3]

DescribeGameSessionsRequest& Aws::GameLift::Model::DescribeGameSessionsRequest::WithNextToken ( const Aws::String value)
inline

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

Definition at line 311 of file DescribeGameSessionsRequest.h.

◆ WithNextToken() [2/3]

DescribeGameSessionsRequest& Aws::GameLift::Model::DescribeGameSessionsRequest::WithNextToken ( Aws::String &&  value)
inline

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

Definition at line 318 of file DescribeGameSessionsRequest.h.

◆ WithNextToken() [3/3]

DescribeGameSessionsRequest& Aws::GameLift::Model::DescribeGameSessionsRequest::WithNextToken ( const char *  value)
inline

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

Definition at line 325 of file DescribeGameSessionsRequest.h.

◆ WithStatusFilter() [1/3]

DescribeGameSessionsRequest& Aws::GameLift::Model::DescribeGameSessionsRequest::WithStatusFilter ( const Aws::String value)
inline

Game session status to filter results on. Possible game session statuses include ACTIVE, TERMINATED, ACTIVATING, and TERMINATING (the last two are transitory).

Definition at line 229 of file DescribeGameSessionsRequest.h.

◆ WithStatusFilter() [2/3]

DescribeGameSessionsRequest& Aws::GameLift::Model::DescribeGameSessionsRequest::WithStatusFilter ( Aws::String &&  value)
inline

Game session status to filter results on. Possible game session statuses include ACTIVE, TERMINATED, ACTIVATING, and TERMINATING (the last two are transitory).

Definition at line 236 of file DescribeGameSessionsRequest.h.

◆ WithStatusFilter() [3/3]

DescribeGameSessionsRequest& Aws::GameLift::Model::DescribeGameSessionsRequest::WithStatusFilter ( const char *  value)
inline

Game session status to filter results on. Possible game session statuses include ACTIVE, TERMINATED, ACTIVATING, and TERMINATING (the last two are transitory).

Definition at line 243 of file DescribeGameSessionsRequest.h.


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