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

#include <DescribeGameSessionDetailsRequest.h>

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

Public Member Functions

 DescribeGameSessionDetailsRequest ()
 
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)
 
DescribeGameSessionDetailsRequestWithFleetId (const Aws::String &value)
 
DescribeGameSessionDetailsRequestWithFleetId (Aws::String &&value)
 
DescribeGameSessionDetailsRequestWithFleetId (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)
 
DescribeGameSessionDetailsRequestWithGameSessionId (const Aws::String &value)
 
DescribeGameSessionDetailsRequestWithGameSessionId (Aws::String &&value)
 
DescribeGameSessionDetailsRequestWithGameSessionId (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)
 
DescribeGameSessionDetailsRequestWithAliasId (const Aws::String &value)
 
DescribeGameSessionDetailsRequestWithAliasId (Aws::String &&value)
 
DescribeGameSessionDetailsRequestWithAliasId (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)
 
DescribeGameSessionDetailsRequestWithStatusFilter (const Aws::String &value)
 
DescribeGameSessionDetailsRequestWithStatusFilter (Aws::String &&value)
 
DescribeGameSessionDetailsRequestWithStatusFilter (const char *value)
 
int GetLimit () const
 
bool LimitHasBeenSet () const
 
void SetLimit (int value)
 
DescribeGameSessionDetailsRequestWithLimit (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)
 
DescribeGameSessionDetailsRequestWithNextToken (const Aws::String &value)
 
DescribeGameSessionDetailsRequestWithNextToken (Aws::String &&value)
 
DescribeGameSessionDetailsRequestWithNextToken (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 operation.

See Also:

AWS API Reference

Definition at line 24 of file DescribeGameSessionDetailsRequest.h.

Constructor & Destructor Documentation

◆ DescribeGameSessionDetailsRequest()

Aws::GameLift::Model::DescribeGameSessionDetailsRequest::DescribeGameSessionDetailsRequest ( )

Member Function Documentation

◆ AliasIdHasBeenSet()

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

A unique identifier for an alias associated with the fleet to retrieve all game sessions for. You can use either the alias ID or ARN value.

Definition at line 140 of file DescribeGameSessionDetailsRequest.h.

◆ FleetIdHasBeenSet()

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

A unique identifier for a fleet to retrieve all game sessions active on the fleet. You can use either the fleet ID or ARN value.

Definition at line 50 of file DescribeGameSessionDetailsRequest.h.

◆ GameSessionIdHasBeenSet()

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

A unique identifier for the game session to retrieve.

Definition at line 97 of file DescribeGameSessionDetailsRequest.h.

◆ GetAliasId()

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

A unique identifier for an alias associated with the fleet to retrieve all game sessions for. You can use either the alias ID or ARN value.

Definition at line 134 of file DescribeGameSessionDetailsRequest.h.

◆ GetFleetId()

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

A unique identifier for a fleet to retrieve all game sessions active on the fleet. You can use either the fleet ID or ARN value.

Definition at line 44 of file DescribeGameSessionDetailsRequest.h.

◆ GetGameSessionId()

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

A unique identifier for the game session to retrieve.

Definition at line 92 of file DescribeGameSessionDetailsRequest.h.

◆ GetLimit()

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

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

Definition at line 240 of file DescribeGameSessionDetailsRequest.h.

◆ GetNextToken()

const Aws::String& Aws::GameLift::Model::DescribeGameSessionDetailsRequest::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 operation. To start at the beginning of the result set, do not specify a value.

Definition at line 266 of file DescribeGameSessionDetailsRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::GameLift::GameLiftRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file DescribeGameSessionDetailsRequest.h.

◆ GetStatusFilter()

const Aws::String& Aws::GameLift::Model::DescribeGameSessionDetailsRequest::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 184 of file DescribeGameSessionDetailsRequest.h.

◆ LimitHasBeenSet()

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

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

Definition at line 246 of file DescribeGameSessionDetailsRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::GameLift::Model::DescribeGameSessionDetailsRequest::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 operation. To start at the beginning of the result set, do not specify a value.

Definition at line 273 of file DescribeGameSessionDetailsRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAliasId() [1/3]

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

A unique identifier for an alias associated with the fleet to retrieve all game sessions for. You can use either the alias ID or ARN value.

Definition at line 152 of file DescribeGameSessionDetailsRequest.h.

◆ SetAliasId() [2/3]

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

A unique identifier for an alias associated with the fleet to retrieve all game sessions for. You can use either the alias ID or ARN value.

Definition at line 146 of file DescribeGameSessionDetailsRequest.h.

◆ SetAliasId() [3/3]

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

A unique identifier for an alias associated with the fleet to retrieve all game sessions for. You can use either the alias ID or ARN value.

Definition at line 158 of file DescribeGameSessionDetailsRequest.h.

◆ SetFleetId() [1/3]

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

A unique identifier for a fleet to retrieve all game sessions active on the fleet. You can use either the fleet ID or ARN value.

Definition at line 62 of file DescribeGameSessionDetailsRequest.h.

◆ SetFleetId() [2/3]

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

A unique identifier for a fleet to retrieve all game sessions active on the fleet. You can use either the fleet ID or ARN value.

Definition at line 56 of file DescribeGameSessionDetailsRequest.h.

◆ SetFleetId() [3/3]

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

A unique identifier for a fleet to retrieve all game sessions active on the fleet. You can use either the fleet ID or ARN value.

Definition at line 68 of file DescribeGameSessionDetailsRequest.h.

◆ SetGameSessionId() [1/3]

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

A unique identifier for the game session to retrieve.

Definition at line 107 of file DescribeGameSessionDetailsRequest.h.

◆ SetGameSessionId() [2/3]

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

A unique identifier for the game session to retrieve.

Definition at line 102 of file DescribeGameSessionDetailsRequest.h.

◆ SetGameSessionId() [3/3]

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

A unique identifier for the game session to retrieve.

Definition at line 112 of file DescribeGameSessionDetailsRequest.h.

◆ SetLimit()

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

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

Definition at line 252 of file DescribeGameSessionDetailsRequest.h.

◆ SetNextToken() [1/3]

void Aws::GameLift::Model::DescribeGameSessionDetailsRequest::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 operation. To start at the beginning of the result set, do not specify a value.

Definition at line 287 of file DescribeGameSessionDetailsRequest.h.

◆ SetNextToken() [2/3]

void Aws::GameLift::Model::DescribeGameSessionDetailsRequest::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 operation. To start at the beginning of the result set, do not specify a value.

Definition at line 280 of file DescribeGameSessionDetailsRequest.h.

◆ SetNextToken() [3/3]

void Aws::GameLift::Model::DescribeGameSessionDetailsRequest::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 operation. To start at the beginning of the result set, do not specify a value.

Definition at line 294 of file DescribeGameSessionDetailsRequest.h.

◆ SetStatusFilter() [1/3]

void Aws::GameLift::Model::DescribeGameSessionDetailsRequest::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 205 of file DescribeGameSessionDetailsRequest.h.

◆ SetStatusFilter() [2/3]

void Aws::GameLift::Model::DescribeGameSessionDetailsRequest::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 198 of file DescribeGameSessionDetailsRequest.h.

◆ SetStatusFilter() [3/3]

void Aws::GameLift::Model::DescribeGameSessionDetailsRequest::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 212 of file DescribeGameSessionDetailsRequest.h.

◆ StatusFilterHasBeenSet()

bool Aws::GameLift::Model::DescribeGameSessionDetailsRequest::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 191 of file DescribeGameSessionDetailsRequest.h.

◆ WithAliasId() [1/3]

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

A unique identifier for an alias associated with the fleet to retrieve all game sessions for. You can use either the alias ID or ARN value.

Definition at line 170 of file DescribeGameSessionDetailsRequest.h.

◆ WithAliasId() [2/3]

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

A unique identifier for an alias associated with the fleet to retrieve all game sessions for. You can use either the alias ID or ARN value.

Definition at line 164 of file DescribeGameSessionDetailsRequest.h.

◆ WithAliasId() [3/3]

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

A unique identifier for an alias associated with the fleet to retrieve all game sessions for. You can use either the alias ID or ARN value.

Definition at line 176 of file DescribeGameSessionDetailsRequest.h.

◆ WithFleetId() [1/3]

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

A unique identifier for a fleet to retrieve all game sessions active on the fleet. You can use either the fleet ID or ARN value.

Definition at line 80 of file DescribeGameSessionDetailsRequest.h.

◆ WithFleetId() [2/3]

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

A unique identifier for a fleet to retrieve all game sessions active on the fleet. You can use either the fleet ID or ARN value.

Definition at line 74 of file DescribeGameSessionDetailsRequest.h.

◆ WithFleetId() [3/3]

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

A unique identifier for a fleet to retrieve all game sessions active on the fleet. You can use either the fleet ID or ARN value.

Definition at line 86 of file DescribeGameSessionDetailsRequest.h.

◆ WithGameSessionId() [1/3]

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

A unique identifier for the game session to retrieve.

Definition at line 122 of file DescribeGameSessionDetailsRequest.h.

◆ WithGameSessionId() [2/3]

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

A unique identifier for the game session to retrieve.

Definition at line 117 of file DescribeGameSessionDetailsRequest.h.

◆ WithGameSessionId() [3/3]

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

A unique identifier for the game session to retrieve.

Definition at line 127 of file DescribeGameSessionDetailsRequest.h.

◆ WithLimit()

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

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

Definition at line 258 of file DescribeGameSessionDetailsRequest.h.

◆ WithNextToken() [1/3]

DescribeGameSessionDetailsRequest& Aws::GameLift::Model::DescribeGameSessionDetailsRequest::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 operation. To start at the beginning of the result set, do not specify a value.

Definition at line 308 of file DescribeGameSessionDetailsRequest.h.

◆ WithNextToken() [2/3]

DescribeGameSessionDetailsRequest& Aws::GameLift::Model::DescribeGameSessionDetailsRequest::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 operation. To start at the beginning of the result set, do not specify a value.

Definition at line 301 of file DescribeGameSessionDetailsRequest.h.

◆ WithNextToken() [3/3]

DescribeGameSessionDetailsRequest& Aws::GameLift::Model::DescribeGameSessionDetailsRequest::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 operation. To start at the beginning of the result set, do not specify a value.

Definition at line 315 of file DescribeGameSessionDetailsRequest.h.

◆ WithStatusFilter() [1/3]

DescribeGameSessionDetailsRequest& Aws::GameLift::Model::DescribeGameSessionDetailsRequest::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 226 of file DescribeGameSessionDetailsRequest.h.

◆ WithStatusFilter() [2/3]

DescribeGameSessionDetailsRequest& Aws::GameLift::Model::DescribeGameSessionDetailsRequest::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 219 of file DescribeGameSessionDetailsRequest.h.

◆ WithStatusFilter() [3/3]

DescribeGameSessionDetailsRequest& Aws::GameLift::Model::DescribeGameSessionDetailsRequest::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 233 of file DescribeGameSessionDetailsRequest.h.


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