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

#include <DescribeInstancesRequest.h>

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

Public Member Functions

 DescribeInstancesRequest ()
 
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)
 
DescribeInstancesRequestWithFleetId (const Aws::String &value)
 
DescribeInstancesRequestWithFleetId (Aws::String &&value)
 
DescribeInstancesRequestWithFleetId (const char *value)
 
const Aws::StringGetInstanceId () const
 
bool InstanceIdHasBeenSet () const
 
void SetInstanceId (const Aws::String &value)
 
void SetInstanceId (Aws::String &&value)
 
void SetInstanceId (const char *value)
 
DescribeInstancesRequestWithInstanceId (const Aws::String &value)
 
DescribeInstancesRequestWithInstanceId (Aws::String &&value)
 
DescribeInstancesRequestWithInstanceId (const char *value)
 
int GetLimit () const
 
bool LimitHasBeenSet () const
 
void SetLimit (int value)
 
DescribeInstancesRequestWithLimit (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)
 
DescribeInstancesRequestWithNextToken (const Aws::String &value)
 
DescribeInstancesRequestWithNextToken (Aws::String &&value)
 
DescribeInstancesRequestWithNextToken (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 DescribeInstancesRequest.h.

Constructor & Destructor Documentation

◆ DescribeInstancesRequest()

Aws::GameLift::Model::DescribeInstancesRequest::DescribeInstancesRequest ( )

Member Function Documentation

◆ FleetIdHasBeenSet()

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

A unique identifier for a fleet to retrieve instance information for. You can use either the fleet ID or ARN value.

Definition at line 50 of file DescribeInstancesRequest.h.

◆ GetFleetId()

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

A unique identifier for a fleet to retrieve instance information for. You can use either the fleet ID or ARN value.

Definition at line 44 of file DescribeInstancesRequest.h.

◆ GetInstanceId()

const Aws::String& Aws::GameLift::Model::DescribeInstancesRequest::GetInstanceId ( ) const
inline

A unique identifier for an instance to retrieve. Specify an instance ID or leave blank to retrieve all instances in the fleet.

Definition at line 93 of file DescribeInstancesRequest.h.

◆ GetLimit()

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

◆ GetNextToken()

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

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::GameLift::GameLiftRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file DescribeInstancesRequest.h.

◆ InstanceIdHasBeenSet()

bool Aws::GameLift::Model::DescribeInstancesRequest::InstanceIdHasBeenSet ( ) const
inline

A unique identifier for an instance to retrieve. Specify an instance ID or leave blank to retrieve all instances in the fleet.

Definition at line 99 of file DescribeInstancesRequest.h.

◆ LimitHasBeenSet()

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

◆ NextTokenHasBeenSet()

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

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetFleetId() [1/3]

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

A unique identifier for a fleet to retrieve instance information for. You can use either the fleet ID or ARN value.

Definition at line 56 of file DescribeInstancesRequest.h.

◆ SetFleetId() [2/3]

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

A unique identifier for a fleet to retrieve instance information for. You can use either the fleet ID or ARN value.

Definition at line 62 of file DescribeInstancesRequest.h.

◆ SetFleetId() [3/3]

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

A unique identifier for a fleet to retrieve instance information for. You can use either the fleet ID or ARN value.

Definition at line 68 of file DescribeInstancesRequest.h.

◆ SetInstanceId() [1/3]

void Aws::GameLift::Model::DescribeInstancesRequest::SetInstanceId ( const Aws::String value)
inline

A unique identifier for an instance to retrieve. Specify an instance ID or leave blank to retrieve all instances in the fleet.

Definition at line 105 of file DescribeInstancesRequest.h.

◆ SetInstanceId() [2/3]

void Aws::GameLift::Model::DescribeInstancesRequest::SetInstanceId ( Aws::String &&  value)
inline

A unique identifier for an instance to retrieve. Specify an instance ID or leave blank to retrieve all instances in the fleet.

Definition at line 111 of file DescribeInstancesRequest.h.

◆ SetInstanceId() [3/3]

void Aws::GameLift::Model::DescribeInstancesRequest::SetInstanceId ( const char *  value)
inline

A unique identifier for an instance to retrieve. Specify an instance ID or leave blank to retrieve all instances in the fleet.

Definition at line 117 of file DescribeInstancesRequest.h.

◆ SetLimit()

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

◆ SetNextToken() [1/3]

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

◆ SetNextToken() [2/3]

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

◆ SetNextToken() [3/3]

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

◆ WithFleetId() [1/3]

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

A unique identifier for a fleet to retrieve instance information for. You can use either the fleet ID or ARN value.

Definition at line 74 of file DescribeInstancesRequest.h.

◆ WithFleetId() [2/3]

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

A unique identifier for a fleet to retrieve instance information for. You can use either the fleet ID or ARN value.

Definition at line 80 of file DescribeInstancesRequest.h.

◆ WithFleetId() [3/3]

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

A unique identifier for a fleet to retrieve instance information for. You can use either the fleet ID or ARN value.

Definition at line 86 of file DescribeInstancesRequest.h.

◆ WithInstanceId() [1/3]

DescribeInstancesRequest& Aws::GameLift::Model::DescribeInstancesRequest::WithInstanceId ( const Aws::String value)
inline

A unique identifier for an instance to retrieve. Specify an instance ID or leave blank to retrieve all instances in the fleet.

Definition at line 123 of file DescribeInstancesRequest.h.

◆ WithInstanceId() [2/3]

DescribeInstancesRequest& Aws::GameLift::Model::DescribeInstancesRequest::WithInstanceId ( Aws::String &&  value)
inline

A unique identifier for an instance to retrieve. Specify an instance ID or leave blank to retrieve all instances in the fleet.

Definition at line 129 of file DescribeInstancesRequest.h.

◆ WithInstanceId() [3/3]

DescribeInstancesRequest& Aws::GameLift::Model::DescribeInstancesRequest::WithInstanceId ( const char *  value)
inline

A unique identifier for an instance to retrieve. Specify an instance ID or leave blank to retrieve all instances in the fleet.

Definition at line 135 of file DescribeInstancesRequest.h.

◆ WithLimit()

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

◆ WithNextToken() [1/3]

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

◆ WithNextToken() [2/3]

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

◆ WithNextToken() [3/3]

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


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