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

#include <DescribePlayerSessionsRequest.h>

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

Public Member Functions

 DescribePlayerSessionsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetGameSessionId () const
 
bool GameSessionIdHasBeenSet () const
 
void SetGameSessionId (const Aws::String &value)
 
void SetGameSessionId (Aws::String &&value)
 
void SetGameSessionId (const char *value)
 
DescribePlayerSessionsRequestWithGameSessionId (const Aws::String &value)
 
DescribePlayerSessionsRequestWithGameSessionId (Aws::String &&value)
 
DescribePlayerSessionsRequestWithGameSessionId (const char *value)
 
const Aws::StringGetPlayerId () const
 
bool PlayerIdHasBeenSet () const
 
void SetPlayerId (const Aws::String &value)
 
void SetPlayerId (Aws::String &&value)
 
void SetPlayerId (const char *value)
 
DescribePlayerSessionsRequestWithPlayerId (const Aws::String &value)
 
DescribePlayerSessionsRequestWithPlayerId (Aws::String &&value)
 
DescribePlayerSessionsRequestWithPlayerId (const char *value)
 
const Aws::StringGetPlayerSessionId () const
 
bool PlayerSessionIdHasBeenSet () const
 
void SetPlayerSessionId (const Aws::String &value)
 
void SetPlayerSessionId (Aws::String &&value)
 
void SetPlayerSessionId (const char *value)
 
DescribePlayerSessionsRequestWithPlayerSessionId (const Aws::String &value)
 
DescribePlayerSessionsRequestWithPlayerSessionId (Aws::String &&value)
 
DescribePlayerSessionsRequestWithPlayerSessionId (const char *value)
 
const Aws::StringGetPlayerSessionStatusFilter () const
 
bool PlayerSessionStatusFilterHasBeenSet () const
 
void SetPlayerSessionStatusFilter (const Aws::String &value)
 
void SetPlayerSessionStatusFilter (Aws::String &&value)
 
void SetPlayerSessionStatusFilter (const char *value)
 
DescribePlayerSessionsRequestWithPlayerSessionStatusFilter (const Aws::String &value)
 
DescribePlayerSessionsRequestWithPlayerSessionStatusFilter (Aws::String &&value)
 
DescribePlayerSessionsRequestWithPlayerSessionStatusFilter (const char *value)
 
int GetLimit () const
 
bool LimitHasBeenSet () const
 
void SetLimit (int value)
 
DescribePlayerSessionsRequestWithLimit (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)
 
DescribePlayerSessionsRequestWithNextToken (const Aws::String &value)
 
DescribePlayerSessionsRequestWithNextToken (Aws::String &&value)
 
DescribePlayerSessionsRequestWithNextToken (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 DescribePlayerSessionsRequest.h.

Constructor & Destructor Documentation

◆ DescribePlayerSessionsRequest()

Aws::GameLift::Model::DescribePlayerSessionsRequest::DescribePlayerSessionsRequest ( )

Member Function Documentation

◆ GameSessionIdHasBeenSet()

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

Unique identifier for the game session to retrieve player sessions for.

Definition at line 58 of file DescribePlayerSessionsRequest.h.

◆ GetGameSessionId()

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

Unique identifier for the game session to retrieve player sessions for.

Definition at line 53 of file DescribePlayerSessionsRequest.h.

◆ GetLimit()

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

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. If a player session ID is specified, this parameter is ignored.

Definition at line 283 of file DescribePlayerSessionsRequest.h.

◆ GetNextToken()

const Aws::String& Aws::GameLift::Model::DescribePlayerSessionsRequest::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. If a player session ID is specified, this parameter is ignored.

Definition at line 313 of file DescribePlayerSessionsRequest.h.

◆ GetPlayerId()

const Aws::String& Aws::GameLift::Model::DescribePlayerSessionsRequest::GetPlayerId ( ) const
inline

Unique identifier for a player to retrieve player sessions for.

Definition at line 94 of file DescribePlayerSessionsRequest.h.

◆ GetPlayerSessionId()

const Aws::String& Aws::GameLift::Model::DescribePlayerSessionsRequest::GetPlayerSessionId ( ) const
inline

Unique identifier for a player session to retrieve.

Definition at line 135 of file DescribePlayerSessionsRequest.h.

◆ GetPlayerSessionStatusFilter()

const Aws::String& Aws::GameLift::Model::DescribePlayerSessionsRequest::GetPlayerSessionStatusFilter ( ) const
inline

Player session status to filter results on.

Possible player session statuses include the following:

  • RESERVED – The player session request has been received, but the player has not yet connected to the server process and/or been validated.

  • ACTIVE – The player has been validated by the server process and is currently connected.

  • COMPLETED – The player connection has been dropped.

  • TIMEDOUT – A player session request was received, but the player did not connect and/or was not validated within the timeout limit (60 seconds).

Definition at line 184 of file DescribePlayerSessionsRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::GameLift::GameLiftRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 43 of file DescribePlayerSessionsRequest.h.

◆ LimitHasBeenSet()

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

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. If a player session ID is specified, this parameter is ignored.

Definition at line 290 of file DescribePlayerSessionsRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::GameLift::Model::DescribePlayerSessionsRequest::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. If a player session ID is specified, this parameter is ignored.

Definition at line 321 of file DescribePlayerSessionsRequest.h.

◆ PlayerIdHasBeenSet()

bool Aws::GameLift::Model::DescribePlayerSessionsRequest::PlayerIdHasBeenSet ( ) const
inline

Unique identifier for a player to retrieve player sessions for.

Definition at line 99 of file DescribePlayerSessionsRequest.h.

◆ PlayerSessionIdHasBeenSet()

bool Aws::GameLift::Model::DescribePlayerSessionsRequest::PlayerSessionIdHasBeenSet ( ) const
inline

Unique identifier for a player session to retrieve.

Definition at line 140 of file DescribePlayerSessionsRequest.h.

◆ PlayerSessionStatusFilterHasBeenSet()

bool Aws::GameLift::Model::DescribePlayerSessionsRequest::PlayerSessionStatusFilterHasBeenSet ( ) const
inline

Player session status to filter results on.

Possible player session statuses include the following:

  • RESERVED – The player session request has been received, but the player has not yet connected to the server process and/or been validated.

  • ACTIVE – The player has been validated by the server process and is currently connected.

  • COMPLETED – The player connection has been dropped.

  • TIMEDOUT – A player session request was received, but the player did not connect and/or was not validated within the timeout limit (60 seconds).

Definition at line 197 of file DescribePlayerSessionsRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetGameSessionId() [1/3]

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

Unique identifier for the game session to retrieve player sessions for.

Definition at line 63 of file DescribePlayerSessionsRequest.h.

◆ SetGameSessionId() [2/3]

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

Unique identifier for the game session to retrieve player sessions for.

Definition at line 68 of file DescribePlayerSessionsRequest.h.

◆ SetGameSessionId() [3/3]

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

Unique identifier for the game session to retrieve player sessions for.

Definition at line 73 of file DescribePlayerSessionsRequest.h.

◆ SetLimit()

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

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. If a player session ID is specified, this parameter is ignored.

Definition at line 297 of file DescribePlayerSessionsRequest.h.

◆ SetNextToken() [1/3]

void Aws::GameLift::Model::DescribePlayerSessionsRequest::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. If a player session ID is specified, this parameter is ignored.

Definition at line 329 of file DescribePlayerSessionsRequest.h.

◆ SetNextToken() [2/3]

void Aws::GameLift::Model::DescribePlayerSessionsRequest::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. If a player session ID is specified, this parameter is ignored.

Definition at line 337 of file DescribePlayerSessionsRequest.h.

◆ SetNextToken() [3/3]

void Aws::GameLift::Model::DescribePlayerSessionsRequest::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. If a player session ID is specified, this parameter is ignored.

Definition at line 345 of file DescribePlayerSessionsRequest.h.

◆ SetPlayerId() [1/3]

void Aws::GameLift::Model::DescribePlayerSessionsRequest::SetPlayerId ( const Aws::String value)
inline

Unique identifier for a player to retrieve player sessions for.

Definition at line 104 of file DescribePlayerSessionsRequest.h.

◆ SetPlayerId() [2/3]

void Aws::GameLift::Model::DescribePlayerSessionsRequest::SetPlayerId ( Aws::String &&  value)
inline

Unique identifier for a player to retrieve player sessions for.

Definition at line 109 of file DescribePlayerSessionsRequest.h.

◆ SetPlayerId() [3/3]

void Aws::GameLift::Model::DescribePlayerSessionsRequest::SetPlayerId ( const char *  value)
inline

Unique identifier for a player to retrieve player sessions for.

Definition at line 114 of file DescribePlayerSessionsRequest.h.

◆ SetPlayerSessionId() [1/3]

void Aws::GameLift::Model::DescribePlayerSessionsRequest::SetPlayerSessionId ( const Aws::String value)
inline

Unique identifier for a player session to retrieve.

Definition at line 145 of file DescribePlayerSessionsRequest.h.

◆ SetPlayerSessionId() [2/3]

void Aws::GameLift::Model::DescribePlayerSessionsRequest::SetPlayerSessionId ( Aws::String &&  value)
inline

Unique identifier for a player session to retrieve.

Definition at line 150 of file DescribePlayerSessionsRequest.h.

◆ SetPlayerSessionId() [3/3]

void Aws::GameLift::Model::DescribePlayerSessionsRequest::SetPlayerSessionId ( const char *  value)
inline

Unique identifier for a player session to retrieve.

Definition at line 155 of file DescribePlayerSessionsRequest.h.

◆ SetPlayerSessionStatusFilter() [1/3]

void Aws::GameLift::Model::DescribePlayerSessionsRequest::SetPlayerSessionStatusFilter ( const Aws::String value)
inline

Player session status to filter results on.

Possible player session statuses include the following:

  • RESERVED – The player session request has been received, but the player has not yet connected to the server process and/or been validated.

  • ACTIVE – The player has been validated by the server process and is currently connected.

  • COMPLETED – The player connection has been dropped.

  • TIMEDOUT – A player session request was received, but the player did not connect and/or was not validated within the timeout limit (60 seconds).

Definition at line 210 of file DescribePlayerSessionsRequest.h.

◆ SetPlayerSessionStatusFilter() [2/3]

void Aws::GameLift::Model::DescribePlayerSessionsRequest::SetPlayerSessionStatusFilter ( Aws::String &&  value)
inline

Player session status to filter results on.

Possible player session statuses include the following:

  • RESERVED – The player session request has been received, but the player has not yet connected to the server process and/or been validated.

  • ACTIVE – The player has been validated by the server process and is currently connected.

  • COMPLETED – The player connection has been dropped.

  • TIMEDOUT – A player session request was received, but the player did not connect and/or was not validated within the timeout limit (60 seconds).

Definition at line 223 of file DescribePlayerSessionsRequest.h.

◆ SetPlayerSessionStatusFilter() [3/3]

void Aws::GameLift::Model::DescribePlayerSessionsRequest::SetPlayerSessionStatusFilter ( const char *  value)
inline

Player session status to filter results on.

Possible player session statuses include the following:

  • RESERVED – The player session request has been received, but the player has not yet connected to the server process and/or been validated.

  • ACTIVE – The player has been validated by the server process and is currently connected.

  • COMPLETED – The player connection has been dropped.

  • TIMEDOUT – A player session request was received, but the player did not connect and/or was not validated within the timeout limit (60 seconds).

Definition at line 236 of file DescribePlayerSessionsRequest.h.

◆ WithGameSessionId() [1/3]

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

Unique identifier for the game session to retrieve player sessions for.

Definition at line 78 of file DescribePlayerSessionsRequest.h.

◆ WithGameSessionId() [2/3]

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

Unique identifier for the game session to retrieve player sessions for.

Definition at line 83 of file DescribePlayerSessionsRequest.h.

◆ WithGameSessionId() [3/3]

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

Unique identifier for the game session to retrieve player sessions for.

Definition at line 88 of file DescribePlayerSessionsRequest.h.

◆ WithLimit()

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

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. If a player session ID is specified, this parameter is ignored.

Definition at line 304 of file DescribePlayerSessionsRequest.h.

◆ WithNextToken() [1/3]

DescribePlayerSessionsRequest& Aws::GameLift::Model::DescribePlayerSessionsRequest::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. If a player session ID is specified, this parameter is ignored.

Definition at line 353 of file DescribePlayerSessionsRequest.h.

◆ WithNextToken() [2/3]

DescribePlayerSessionsRequest& Aws::GameLift::Model::DescribePlayerSessionsRequest::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. If a player session ID is specified, this parameter is ignored.

Definition at line 361 of file DescribePlayerSessionsRequest.h.

◆ WithNextToken() [3/3]

DescribePlayerSessionsRequest& Aws::GameLift::Model::DescribePlayerSessionsRequest::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. If a player session ID is specified, this parameter is ignored.

Definition at line 369 of file DescribePlayerSessionsRequest.h.

◆ WithPlayerId() [1/3]

DescribePlayerSessionsRequest& Aws::GameLift::Model::DescribePlayerSessionsRequest::WithPlayerId ( const Aws::String value)
inline

Unique identifier for a player to retrieve player sessions for.

Definition at line 119 of file DescribePlayerSessionsRequest.h.

◆ WithPlayerId() [2/3]

DescribePlayerSessionsRequest& Aws::GameLift::Model::DescribePlayerSessionsRequest::WithPlayerId ( Aws::String &&  value)
inline

Unique identifier for a player to retrieve player sessions for.

Definition at line 124 of file DescribePlayerSessionsRequest.h.

◆ WithPlayerId() [3/3]

DescribePlayerSessionsRequest& Aws::GameLift::Model::DescribePlayerSessionsRequest::WithPlayerId ( const char *  value)
inline

Unique identifier for a player to retrieve player sessions for.

Definition at line 129 of file DescribePlayerSessionsRequest.h.

◆ WithPlayerSessionId() [1/3]

DescribePlayerSessionsRequest& Aws::GameLift::Model::DescribePlayerSessionsRequest::WithPlayerSessionId ( const Aws::String value)
inline

Unique identifier for a player session to retrieve.

Definition at line 160 of file DescribePlayerSessionsRequest.h.

◆ WithPlayerSessionId() [2/3]

DescribePlayerSessionsRequest& Aws::GameLift::Model::DescribePlayerSessionsRequest::WithPlayerSessionId ( Aws::String &&  value)
inline

Unique identifier for a player session to retrieve.

Definition at line 165 of file DescribePlayerSessionsRequest.h.

◆ WithPlayerSessionId() [3/3]

DescribePlayerSessionsRequest& Aws::GameLift::Model::DescribePlayerSessionsRequest::WithPlayerSessionId ( const char *  value)
inline

Unique identifier for a player session to retrieve.

Definition at line 170 of file DescribePlayerSessionsRequest.h.

◆ WithPlayerSessionStatusFilter() [1/3]

DescribePlayerSessionsRequest& Aws::GameLift::Model::DescribePlayerSessionsRequest::WithPlayerSessionStatusFilter ( const Aws::String value)
inline

Player session status to filter results on.

Possible player session statuses include the following:

  • RESERVED – The player session request has been received, but the player has not yet connected to the server process and/or been validated.

  • ACTIVE – The player has been validated by the server process and is currently connected.

  • COMPLETED – The player connection has been dropped.

  • TIMEDOUT – A player session request was received, but the player did not connect and/or was not validated within the timeout limit (60 seconds).

Definition at line 249 of file DescribePlayerSessionsRequest.h.

◆ WithPlayerSessionStatusFilter() [2/3]

DescribePlayerSessionsRequest& Aws::GameLift::Model::DescribePlayerSessionsRequest::WithPlayerSessionStatusFilter ( Aws::String &&  value)
inline

Player session status to filter results on.

Possible player session statuses include the following:

  • RESERVED – The player session request has been received, but the player has not yet connected to the server process and/or been validated.

  • ACTIVE – The player has been validated by the server process and is currently connected.

  • COMPLETED – The player connection has been dropped.

  • TIMEDOUT – A player session request was received, but the player did not connect and/or was not validated within the timeout limit (60 seconds).

Definition at line 262 of file DescribePlayerSessionsRequest.h.

◆ WithPlayerSessionStatusFilter() [3/3]

DescribePlayerSessionsRequest& Aws::GameLift::Model::DescribePlayerSessionsRequest::WithPlayerSessionStatusFilter ( const char *  value)
inline

Player session status to filter results on.

Possible player session statuses include the following:

  • RESERVED – The player session request has been received, but the player has not yet connected to the server process and/or been validated.

  • ACTIVE – The player has been validated by the server process and is currently connected.

  • COMPLETED – The player connection has been dropped.

  • TIMEDOUT – A player session request was received, but the player did not connect and/or was not validated within the timeout limit (60 seconds).

Definition at line 275 of file DescribePlayerSessionsRequest.h.


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