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

#include <ListFleetsRequest.h>

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

Public Member Functions

 ListFleetsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetBuildId () const
 
bool BuildIdHasBeenSet () const
 
void SetBuildId (const Aws::String &value)
 
void SetBuildId (Aws::String &&value)
 
void SetBuildId (const char *value)
 
ListFleetsRequestWithBuildId (const Aws::String &value)
 
ListFleetsRequestWithBuildId (Aws::String &&value)
 
ListFleetsRequestWithBuildId (const char *value)
 
const Aws::StringGetScriptId () const
 
bool ScriptIdHasBeenSet () const
 
void SetScriptId (const Aws::String &value)
 
void SetScriptId (Aws::String &&value)
 
void SetScriptId (const char *value)
 
ListFleetsRequestWithScriptId (const Aws::String &value)
 
ListFleetsRequestWithScriptId (Aws::String &&value)
 
ListFleetsRequestWithScriptId (const char *value)
 
int GetLimit () const
 
bool LimitHasBeenSet () const
 
void SetLimit (int value)
 
ListFleetsRequestWithLimit (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)
 
ListFleetsRequestWithNextToken (const Aws::String &value)
 
ListFleetsRequestWithNextToken (Aws::String &&value)
 
ListFleetsRequestWithNextToken (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 ListFleetsRequest.h.

Constructor & Destructor Documentation

◆ ListFleetsRequest()

Aws::GameLift::Model::ListFleetsRequest::ListFleetsRequest ( )

Member Function Documentation

◆ BuildIdHasBeenSet()

bool Aws::GameLift::Model::ListFleetsRequest::BuildIdHasBeenSet ( ) const
inline

A unique identifier for a build to return fleets for. Use this parameter to return only fleets using a specified build. Use either the build ID or ARN value. To retrieve all fleets, do not include either a BuildId and ScriptID parameter.

Definition at line 64 of file ListFleetsRequest.h.

◆ GetBuildId()

const Aws::String& Aws::GameLift::Model::ListFleetsRequest::GetBuildId ( ) const
inline

A unique identifier for a build to return fleets for. Use this parameter to return only fleets using a specified build. Use either the build ID or ARN value. To retrieve all fleets, do not include either a BuildId and ScriptID parameter.

Definition at line 56 of file ListFleetsRequest.h.

◆ GetLimit()

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

◆ GetNextToken()

const Aws::String& Aws::GameLift::Model::ListFleetsRequest::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.

Definition at line 202 of file ListFleetsRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::GameLift::GameLiftRequest.

◆ GetScriptId()

const Aws::String& Aws::GameLift::Model::ListFleetsRequest::GetScriptId ( ) const
inline

A unique identifier for a Realtime script to return fleets for. Use this parameter to return only fleets using a specified script. Use either the script ID or ARN value. To retrieve all fleets, leave this parameter empty.

Definition at line 120 of file ListFleetsRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 43 of file ListFleetsRequest.h.

◆ LimitHasBeenSet()

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

◆ NextTokenHasBeenSet()

bool Aws::GameLift::Model::ListFleetsRequest::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.

Definition at line 209 of file ListFleetsRequest.h.

◆ ScriptIdHasBeenSet()

bool Aws::GameLift::Model::ListFleetsRequest::ScriptIdHasBeenSet ( ) const
inline

A unique identifier for a Realtime script to return fleets for. Use this parameter to return only fleets using a specified script. Use either the script ID or ARN value. To retrieve all fleets, leave this parameter empty.

Definition at line 127 of file ListFleetsRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetBuildId() [1/3]

void Aws::GameLift::Model::ListFleetsRequest::SetBuildId ( const Aws::String value)
inline

A unique identifier for a build to return fleets for. Use this parameter to return only fleets using a specified build. Use either the build ID or ARN value. To retrieve all fleets, do not include either a BuildId and ScriptID parameter.

Definition at line 72 of file ListFleetsRequest.h.

◆ SetBuildId() [2/3]

void Aws::GameLift::Model::ListFleetsRequest::SetBuildId ( Aws::String &&  value)
inline

A unique identifier for a build to return fleets for. Use this parameter to return only fleets using a specified build. Use either the build ID or ARN value. To retrieve all fleets, do not include either a BuildId and ScriptID parameter.

Definition at line 80 of file ListFleetsRequest.h.

◆ SetBuildId() [3/3]

void Aws::GameLift::Model::ListFleetsRequest::SetBuildId ( const char *  value)
inline

A unique identifier for a build to return fleets for. Use this parameter to return only fleets using a specified build. Use either the build ID or ARN value. To retrieve all fleets, do not include either a BuildId and ScriptID parameter.

Definition at line 88 of file ListFleetsRequest.h.

◆ SetLimit()

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

◆ SetNextToken() [1/3]

void Aws::GameLift::Model::ListFleetsRequest::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.

Definition at line 216 of file ListFleetsRequest.h.

◆ SetNextToken() [2/3]

void Aws::GameLift::Model::ListFleetsRequest::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.

Definition at line 223 of file ListFleetsRequest.h.

◆ SetNextToken() [3/3]

void Aws::GameLift::Model::ListFleetsRequest::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.

Definition at line 230 of file ListFleetsRequest.h.

◆ SetScriptId() [1/3]

void Aws::GameLift::Model::ListFleetsRequest::SetScriptId ( const Aws::String value)
inline

A unique identifier for a Realtime script to return fleets for. Use this parameter to return only fleets using a specified script. Use either the script ID or ARN value. To retrieve all fleets, leave this parameter empty.

Definition at line 134 of file ListFleetsRequest.h.

◆ SetScriptId() [2/3]

void Aws::GameLift::Model::ListFleetsRequest::SetScriptId ( Aws::String &&  value)
inline

A unique identifier for a Realtime script to return fleets for. Use this parameter to return only fleets using a specified script. Use either the script ID or ARN value. To retrieve all fleets, leave this parameter empty.

Definition at line 141 of file ListFleetsRequest.h.

◆ SetScriptId() [3/3]

void Aws::GameLift::Model::ListFleetsRequest::SetScriptId ( const char *  value)
inline

A unique identifier for a Realtime script to return fleets for. Use this parameter to return only fleets using a specified script. Use either the script ID or ARN value. To retrieve all fleets, leave this parameter empty.

Definition at line 148 of file ListFleetsRequest.h.

◆ WithBuildId() [1/3]

ListFleetsRequest& Aws::GameLift::Model::ListFleetsRequest::WithBuildId ( const Aws::String value)
inline

A unique identifier for a build to return fleets for. Use this parameter to return only fleets using a specified build. Use either the build ID or ARN value. To retrieve all fleets, do not include either a BuildId and ScriptID parameter.

Definition at line 96 of file ListFleetsRequest.h.

◆ WithBuildId() [2/3]

ListFleetsRequest& Aws::GameLift::Model::ListFleetsRequest::WithBuildId ( Aws::String &&  value)
inline

A unique identifier for a build to return fleets for. Use this parameter to return only fleets using a specified build. Use either the build ID or ARN value. To retrieve all fleets, do not include either a BuildId and ScriptID parameter.

Definition at line 104 of file ListFleetsRequest.h.

◆ WithBuildId() [3/3]

ListFleetsRequest& Aws::GameLift::Model::ListFleetsRequest::WithBuildId ( const char *  value)
inline

A unique identifier for a build to return fleets for. Use this parameter to return only fleets using a specified build. Use either the build ID or ARN value. To retrieve all fleets, do not include either a BuildId and ScriptID parameter.

Definition at line 112 of file ListFleetsRequest.h.

◆ WithLimit()

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

◆ WithNextToken() [1/3]

ListFleetsRequest& Aws::GameLift::Model::ListFleetsRequest::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.

Definition at line 237 of file ListFleetsRequest.h.

◆ WithNextToken() [2/3]

ListFleetsRequest& Aws::GameLift::Model::ListFleetsRequest::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.

Definition at line 244 of file ListFleetsRequest.h.

◆ WithNextToken() [3/3]

ListFleetsRequest& Aws::GameLift::Model::ListFleetsRequest::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.

Definition at line 251 of file ListFleetsRequest.h.

◆ WithScriptId() [1/3]

ListFleetsRequest& Aws::GameLift::Model::ListFleetsRequest::WithScriptId ( const Aws::String value)
inline

A unique identifier for a Realtime script to return fleets for. Use this parameter to return only fleets using a specified script. Use either the script ID or ARN value. To retrieve all fleets, leave this parameter empty.

Definition at line 155 of file ListFleetsRequest.h.

◆ WithScriptId() [2/3]

ListFleetsRequest& Aws::GameLift::Model::ListFleetsRequest::WithScriptId ( Aws::String &&  value)
inline

A unique identifier for a Realtime script to return fleets for. Use this parameter to return only fleets using a specified script. Use either the script ID or ARN value. To retrieve all fleets, leave this parameter empty.

Definition at line 162 of file ListFleetsRequest.h.

◆ WithScriptId() [3/3]

ListFleetsRequest& Aws::GameLift::Model::ListFleetsRequest::WithScriptId ( const char *  value)
inline

A unique identifier for a Realtime script to return fleets for. Use this parameter to return only fleets using a specified script. Use either the script ID or ARN value. To retrieve all fleets, leave this parameter empty.

Definition at line 169 of file ListFleetsRequest.h.


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