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

#include <ListGameServersRequest.h>

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

Public Member Functions

 ListGameServersRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetGameServerGroupName () const
 
bool GameServerGroupNameHasBeenSet () const
 
void SetGameServerGroupName (const Aws::String &value)
 
void SetGameServerGroupName (Aws::String &&value)
 
void SetGameServerGroupName (const char *value)
 
ListGameServersRequestWithGameServerGroupName (const Aws::String &value)
 
ListGameServersRequestWithGameServerGroupName (Aws::String &&value)
 
ListGameServersRequestWithGameServerGroupName (const char *value)
 
const SortOrderGetSortOrder () const
 
bool SortOrderHasBeenSet () const
 
void SetSortOrder (const SortOrder &value)
 
void SetSortOrder (SortOrder &&value)
 
ListGameServersRequestWithSortOrder (const SortOrder &value)
 
ListGameServersRequestWithSortOrder (SortOrder &&value)
 
int GetLimit () const
 
bool LimitHasBeenSet () const
 
void SetLimit (int value)
 
ListGameServersRequestWithLimit (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)
 
ListGameServersRequestWithNextToken (const Aws::String &value)
 
ListGameServersRequestWithNextToken (Aws::String &&value)
 
ListGameServersRequestWithNextToken (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

Definition at line 22 of file ListGameServersRequest.h.

Constructor & Destructor Documentation

◆ ListGameServersRequest()

Aws::GameLift::Model::ListGameServersRequest::ListGameServersRequest ( )

Member Function Documentation

◆ GameServerGroupNameHasBeenSet()

bool Aws::GameLift::Model::ListGameServersRequest::GameServerGroupNameHasBeenSet ( ) const
inline

An identifier for the game server group for the game server you want to list. Use either the GameServerGroup name or ARN value.

Definition at line 48 of file ListGameServersRequest.h.

◆ GetGameServerGroupName()

const Aws::String& Aws::GameLift::Model::ListGameServersRequest::GetGameServerGroupName ( ) const
inline

An identifier for the game server group for the game server you want to list. Use either the GameServerGroup name or ARN value.

Definition at line 42 of file ListGameServersRequest.h.

◆ GetLimit()

int Aws::GameLift::Model::ListGameServersRequest::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 134 of file ListGameServersRequest.h.

◆ GetNextToken()

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

A 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 160 of file ListGameServersRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::GameLift::GameLiftRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 31 of file ListGameServersRequest.h.

◆ GetSortOrder()

const SortOrder& Aws::GameLift::Model::ListGameServersRequest::GetSortOrder ( ) const
inline

Indicates how to sort the returned data based on the game servers' custom key sort value. If this parameter is left empty, the list of game servers is returned in no particular order.

Definition at line 92 of file ListGameServersRequest.h.

◆ LimitHasBeenSet()

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

◆ NextTokenHasBeenSet()

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

A 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 167 of file ListGameServersRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetGameServerGroupName() [1/3]

void Aws::GameLift::Model::ListGameServersRequest::SetGameServerGroupName ( const Aws::String value)
inline

An identifier for the game server group for the game server you want to list. Use either the GameServerGroup name or ARN value.

Definition at line 54 of file ListGameServersRequest.h.

◆ SetGameServerGroupName() [2/3]

void Aws::GameLift::Model::ListGameServersRequest::SetGameServerGroupName ( Aws::String &&  value)
inline

An identifier for the game server group for the game server you want to list. Use either the GameServerGroup name or ARN value.

Definition at line 60 of file ListGameServersRequest.h.

◆ SetGameServerGroupName() [3/3]

void Aws::GameLift::Model::ListGameServersRequest::SetGameServerGroupName ( const char *  value)
inline

An identifier for the game server group for the game server you want to list. Use either the GameServerGroup name or ARN value.

Definition at line 66 of file ListGameServersRequest.h.

◆ SetLimit()

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

◆ SetNextToken() [1/3]

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

A 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 174 of file ListGameServersRequest.h.

◆ SetNextToken() [2/3]

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

A 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 181 of file ListGameServersRequest.h.

◆ SetNextToken() [3/3]

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

A 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 188 of file ListGameServersRequest.h.

◆ SetSortOrder() [1/2]

void Aws::GameLift::Model::ListGameServersRequest::SetSortOrder ( const SortOrder value)
inline

Indicates how to sort the returned data based on the game servers' custom key sort value. If this parameter is left empty, the list of game servers is returned in no particular order.

Definition at line 106 of file ListGameServersRequest.h.

◆ SetSortOrder() [2/2]

void Aws::GameLift::Model::ListGameServersRequest::SetSortOrder ( SortOrder &&  value)
inline

Indicates how to sort the returned data based on the game servers' custom key sort value. If this parameter is left empty, the list of game servers is returned in no particular order.

Definition at line 113 of file ListGameServersRequest.h.

◆ SortOrderHasBeenSet()

bool Aws::GameLift::Model::ListGameServersRequest::SortOrderHasBeenSet ( ) const
inline

Indicates how to sort the returned data based on the game servers' custom key sort value. If this parameter is left empty, the list of game servers is returned in no particular order.

Definition at line 99 of file ListGameServersRequest.h.

◆ WithGameServerGroupName() [1/3]

ListGameServersRequest& Aws::GameLift::Model::ListGameServersRequest::WithGameServerGroupName ( const Aws::String value)
inline

An identifier for the game server group for the game server you want to list. Use either the GameServerGroup name or ARN value.

Definition at line 72 of file ListGameServersRequest.h.

◆ WithGameServerGroupName() [2/3]

ListGameServersRequest& Aws::GameLift::Model::ListGameServersRequest::WithGameServerGroupName ( Aws::String &&  value)
inline

An identifier for the game server group for the game server you want to list. Use either the GameServerGroup name or ARN value.

Definition at line 78 of file ListGameServersRequest.h.

◆ WithGameServerGroupName() [3/3]

ListGameServersRequest& Aws::GameLift::Model::ListGameServersRequest::WithGameServerGroupName ( const char *  value)
inline

An identifier for the game server group for the game server you want to list. Use either the GameServerGroup name or ARN value.

Definition at line 84 of file ListGameServersRequest.h.

◆ WithLimit()

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

◆ WithNextToken() [1/3]

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

A 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 195 of file ListGameServersRequest.h.

◆ WithNextToken() [2/3]

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

A 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 202 of file ListGameServersRequest.h.

◆ WithNextToken() [3/3]

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

A 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 209 of file ListGameServersRequest.h.

◆ WithSortOrder() [1/2]

ListGameServersRequest& Aws::GameLift::Model::ListGameServersRequest::WithSortOrder ( const SortOrder value)
inline

Indicates how to sort the returned data based on the game servers' custom key sort value. If this parameter is left empty, the list of game servers is returned in no particular order.

Definition at line 120 of file ListGameServersRequest.h.

◆ WithSortOrder() [2/2]

ListGameServersRequest& Aws::GameLift::Model::ListGameServersRequest::WithSortOrder ( SortOrder &&  value)
inline

Indicates how to sort the returned data based on the game servers' custom key sort value. If this parameter is left empty, the list of game servers is returned in no particular order.

Definition at line 127 of file ListGameServersRequest.h.


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