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

#include <DescribeGameServerInstancesRequest.h>

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

Public Member Functions

 DescribeGameServerInstancesRequest ()
 
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)
 
DescribeGameServerInstancesRequestWithGameServerGroupName (const Aws::String &value)
 
DescribeGameServerInstancesRequestWithGameServerGroupName (Aws::String &&value)
 
DescribeGameServerInstancesRequestWithGameServerGroupName (const char *value)
 
const Aws::Vector< Aws::String > & GetInstanceIds () const
 
bool InstanceIdsHasBeenSet () const
 
void SetInstanceIds (const Aws::Vector< Aws::String > &value)
 
void SetInstanceIds (Aws::Vector< Aws::String > &&value)
 
DescribeGameServerInstancesRequestWithInstanceIds (const Aws::Vector< Aws::String > &value)
 
DescribeGameServerInstancesRequestWithInstanceIds (Aws::Vector< Aws::String > &&value)
 
DescribeGameServerInstancesRequestAddInstanceIds (const Aws::String &value)
 
DescribeGameServerInstancesRequestAddInstanceIds (Aws::String &&value)
 
DescribeGameServerInstancesRequestAddInstanceIds (const char *value)
 
int GetLimit () const
 
bool LimitHasBeenSet () const
 
void SetLimit (int value)
 
DescribeGameServerInstancesRequestWithLimit (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)
 
DescribeGameServerInstancesRequestWithNextToken (const Aws::String &value)
 
DescribeGameServerInstancesRequestWithNextToken (Aws::String &&value)
 
DescribeGameServerInstancesRequestWithNextToken (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 DescribeGameServerInstancesRequest.h.

Constructor & Destructor Documentation

◆ DescribeGameServerInstancesRequest()

Aws::GameLift::Model::DescribeGameServerInstancesRequest::DescribeGameServerInstancesRequest ( )

Member Function Documentation

◆ AddInstanceIds() [1/3]

DescribeGameServerInstancesRequest& Aws::GameLift::Model::DescribeGameServerInstancesRequest::AddInstanceIds ( Aws::String &&  value)
inline

The EC2 instance IDs that you want to retrieve status on. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0. To retrieve all instances in the game server group, leave this parameter empty.

Definition at line 149 of file DescribeGameServerInstancesRequest.h.

◆ AddInstanceIds() [2/3]

DescribeGameServerInstancesRequest& Aws::GameLift::Model::DescribeGameServerInstancesRequest::AddInstanceIds ( const Aws::String value)
inline

The EC2 instance IDs that you want to retrieve status on. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0. To retrieve all instances in the game server group, leave this parameter empty.

Definition at line 141 of file DescribeGameServerInstancesRequest.h.

◆ AddInstanceIds() [3/3]

DescribeGameServerInstancesRequest& Aws::GameLift::Model::DescribeGameServerInstancesRequest::AddInstanceIds ( const char *  value)
inline

The EC2 instance IDs that you want to retrieve status on. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0. To retrieve all instances in the game server group, leave this parameter empty.

Definition at line 157 of file DescribeGameServerInstancesRequest.h.

◆ GameServerGroupNameHasBeenSet()

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

A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.

Definition at line 48 of file DescribeGameServerInstancesRequest.h.

◆ GetGameServerGroupName()

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

A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.

Definition at line 42 of file DescribeGameServerInstancesRequest.h.

◆ GetInstanceIds()

const Aws::Vector<Aws::String>& Aws::GameLift::Model::DescribeGameServerInstancesRequest::GetInstanceIds ( ) const
inline

The EC2 instance IDs that you want to retrieve status on. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0. To retrieve all instances in the game server group, leave this parameter empty.

Definition at line 93 of file DescribeGameServerInstancesRequest.h.

◆ GetLimit()

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

◆ GetNextToken()

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

Definition at line 190 of file DescribeGameServerInstancesRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::GameLift::GameLiftRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 31 of file DescribeGameServerInstancesRequest.h.

◆ InstanceIdsHasBeenSet()

bool Aws::GameLift::Model::DescribeGameServerInstancesRequest::InstanceIdsHasBeenSet ( ) const
inline

The EC2 instance IDs that you want to retrieve status on. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0. To retrieve all instances in the game server group, leave this parameter empty.

Definition at line 101 of file DescribeGameServerInstancesRequest.h.

◆ LimitHasBeenSet()

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

◆ NextTokenHasBeenSet()

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

Definition at line 197 of file DescribeGameServerInstancesRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetGameServerGroupName() [1/3]

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

A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.

Definition at line 60 of file DescribeGameServerInstancesRequest.h.

◆ SetGameServerGroupName() [2/3]

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

A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.

Definition at line 54 of file DescribeGameServerInstancesRequest.h.

◆ SetGameServerGroupName() [3/3]

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

A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.

Definition at line 66 of file DescribeGameServerInstancesRequest.h.

◆ SetInstanceIds() [1/2]

void Aws::GameLift::Model::DescribeGameServerInstancesRequest::SetInstanceIds ( Aws::Vector< Aws::String > &&  value)
inline

The EC2 instance IDs that you want to retrieve status on. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0. To retrieve all instances in the game server group, leave this parameter empty.

Definition at line 117 of file DescribeGameServerInstancesRequest.h.

◆ SetInstanceIds() [2/2]

void Aws::GameLift::Model::DescribeGameServerInstancesRequest::SetInstanceIds ( const Aws::Vector< Aws::String > &  value)
inline

The EC2 instance IDs that you want to retrieve status on. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0. To retrieve all instances in the game server group, leave this parameter empty.

Definition at line 109 of file DescribeGameServerInstancesRequest.h.

◆ SetLimit()

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

◆ SetNextToken() [1/3]

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

Definition at line 211 of file DescribeGameServerInstancesRequest.h.

◆ SetNextToken() [2/3]

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

Definition at line 204 of file DescribeGameServerInstancesRequest.h.

◆ SetNextToken() [3/3]

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

Definition at line 218 of file DescribeGameServerInstancesRequest.h.

◆ WithGameServerGroupName() [1/3]

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

A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.

Definition at line 78 of file DescribeGameServerInstancesRequest.h.

◆ WithGameServerGroupName() [2/3]

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

A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.

Definition at line 72 of file DescribeGameServerInstancesRequest.h.

◆ WithGameServerGroupName() [3/3]

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

A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.

Definition at line 84 of file DescribeGameServerInstancesRequest.h.

◆ WithInstanceIds() [1/2]

DescribeGameServerInstancesRequest& Aws::GameLift::Model::DescribeGameServerInstancesRequest::WithInstanceIds ( Aws::Vector< Aws::String > &&  value)
inline

The EC2 instance IDs that you want to retrieve status on. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0. To retrieve all instances in the game server group, leave this parameter empty.

Definition at line 133 of file DescribeGameServerInstancesRequest.h.

◆ WithInstanceIds() [2/2]

DescribeGameServerInstancesRequest& Aws::GameLift::Model::DescribeGameServerInstancesRequest::WithInstanceIds ( const Aws::Vector< Aws::String > &  value)
inline

The EC2 instance IDs that you want to retrieve status on. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0. To retrieve all instances in the game server group, leave this parameter empty.

Definition at line 125 of file DescribeGameServerInstancesRequest.h.

◆ WithLimit()

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

◆ WithNextToken() [1/3]

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

Definition at line 232 of file DescribeGameServerInstancesRequest.h.

◆ WithNextToken() [2/3]

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

Definition at line 225 of file DescribeGameServerInstancesRequest.h.

◆ WithNextToken() [3/3]

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

Definition at line 239 of file DescribeGameServerInstancesRequest.h.


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