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

#include <DescribeFleetAttributesRequest.h>

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

Public Member Functions

 DescribeFleetAttributesRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::Vector< Aws::String > & GetFleetIds () const
 
bool FleetIdsHasBeenSet () const
 
void SetFleetIds (const Aws::Vector< Aws::String > &value)
 
void SetFleetIds (Aws::Vector< Aws::String > &&value)
 
DescribeFleetAttributesRequestWithFleetIds (const Aws::Vector< Aws::String > &value)
 
DescribeFleetAttributesRequestWithFleetIds (Aws::Vector< Aws::String > &&value)
 
DescribeFleetAttributesRequestAddFleetIds (const Aws::String &value)
 
DescribeFleetAttributesRequestAddFleetIds (Aws::String &&value)
 
DescribeFleetAttributesRequestAddFleetIds (const char *value)
 
int GetLimit () const
 
bool LimitHasBeenSet () const
 
void SetLimit (int value)
 
DescribeFleetAttributesRequestWithLimit (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)
 
DescribeFleetAttributesRequestWithNextToken (const Aws::String &value)
 
DescribeFleetAttributesRequestWithNextToken (Aws::String &&value)
 
DescribeFleetAttributesRequestWithNextToken (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 35 of file DescribeFleetAttributesRequest.h.

Constructor & Destructor Documentation

◆ DescribeFleetAttributesRequest()

Aws::GameLift::Model::DescribeFleetAttributesRequest::DescribeFleetAttributesRequest ( )

Member Function Documentation

◆ AddFleetIds() [1/3]

DescribeFleetAttributesRequest& Aws::GameLift::Model::DescribeFleetAttributesRequest::AddFleetIds ( const Aws::String value)
inline

A list of unique fleet identifiers to retrieve attributes for. You can use either the fleet ID or ARN value. To retrieve attributes for all current fleets, do not include this parameter. If the list of fleet identifiers includes fleets that don't currently exist, the request succeeds but no attributes for that fleet are returned.

Definition at line 112 of file DescribeFleetAttributesRequest.h.

◆ AddFleetIds() [2/3]

DescribeFleetAttributesRequest& Aws::GameLift::Model::DescribeFleetAttributesRequest::AddFleetIds ( Aws::String &&  value)
inline

A list of unique fleet identifiers to retrieve attributes for. You can use either the fleet ID or ARN value. To retrieve attributes for all current fleets, do not include this parameter. If the list of fleet identifiers includes fleets that don't currently exist, the request succeeds but no attributes for that fleet are returned.

Definition at line 121 of file DescribeFleetAttributesRequest.h.

◆ AddFleetIds() [3/3]

DescribeFleetAttributesRequest& Aws::GameLift::Model::DescribeFleetAttributesRequest::AddFleetIds ( const char *  value)
inline

A list of unique fleet identifiers to retrieve attributes for. You can use either the fleet ID or ARN value. To retrieve attributes for all current fleets, do not include this parameter. If the list of fleet identifiers includes fleets that don't currently exist, the request succeeds but no attributes for that fleet are returned.

Definition at line 130 of file DescribeFleetAttributesRequest.h.

◆ FleetIdsHasBeenSet()

bool Aws::GameLift::Model::DescribeFleetAttributesRequest::FleetIdsHasBeenSet ( ) const
inline

A list of unique fleet identifiers to retrieve attributes for. You can use either the fleet ID or ARN value. To retrieve attributes for all current fleets, do not include this parameter. If the list of fleet identifiers includes fleets that don't currently exist, the request succeeds but no attributes for that fleet are returned.

Definition at line 67 of file DescribeFleetAttributesRequest.h.

◆ GetFleetIds()

const Aws::Vector<Aws::String>& Aws::GameLift::Model::DescribeFleetAttributesRequest::GetFleetIds ( ) const
inline

A list of unique fleet identifiers to retrieve attributes for. You can use either the fleet ID or ARN value. To retrieve attributes for all current fleets, do not include this parameter. If the list of fleet identifiers includes fleets that don't currently exist, the request succeeds but no attributes for that fleet are returned.

Definition at line 58 of file DescribeFleetAttributesRequest.h.

◆ GetLimit()

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

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs.

Definition at line 138 of file DescribeFleetAttributesRequest.h.

◆ GetNextToken()

const Aws::String& Aws::GameLift::Model::DescribeFleetAttributesRequest::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. This parameter is ignored when the request specifies one or a list of fleet IDs.

Definition at line 168 of file DescribeFleetAttributesRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::GameLift::GameLiftRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 44 of file DescribeFleetAttributesRequest.h.

◆ LimitHasBeenSet()

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

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs.

Definition at line 145 of file DescribeFleetAttributesRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::GameLift::Model::DescribeFleetAttributesRequest::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. This parameter is ignored when the request specifies one or a list of fleet IDs.

Definition at line 176 of file DescribeFleetAttributesRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetFleetIds() [1/2]

void Aws::GameLift::Model::DescribeFleetAttributesRequest::SetFleetIds ( const Aws::Vector< Aws::String > &  value)
inline

A list of unique fleet identifiers to retrieve attributes for. You can use either the fleet ID or ARN value. To retrieve attributes for all current fleets, do not include this parameter. If the list of fleet identifiers includes fleets that don't currently exist, the request succeeds but no attributes for that fleet are returned.

Definition at line 76 of file DescribeFleetAttributesRequest.h.

◆ SetFleetIds() [2/2]

void Aws::GameLift::Model::DescribeFleetAttributesRequest::SetFleetIds ( Aws::Vector< Aws::String > &&  value)
inline

A list of unique fleet identifiers to retrieve attributes for. You can use either the fleet ID or ARN value. To retrieve attributes for all current fleets, do not include this parameter. If the list of fleet identifiers includes fleets that don't currently exist, the request succeeds but no attributes for that fleet are returned.

Definition at line 85 of file DescribeFleetAttributesRequest.h.

◆ SetLimit()

void Aws::GameLift::Model::DescribeFleetAttributesRequest::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. This parameter is ignored when the request specifies one or a list of fleet IDs.

Definition at line 152 of file DescribeFleetAttributesRequest.h.

◆ SetNextToken() [1/3]

void Aws::GameLift::Model::DescribeFleetAttributesRequest::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. This parameter is ignored when the request specifies one or a list of fleet IDs.

Definition at line 184 of file DescribeFleetAttributesRequest.h.

◆ SetNextToken() [2/3]

void Aws::GameLift::Model::DescribeFleetAttributesRequest::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. This parameter is ignored when the request specifies one or a list of fleet IDs.

Definition at line 192 of file DescribeFleetAttributesRequest.h.

◆ SetNextToken() [3/3]

void Aws::GameLift::Model::DescribeFleetAttributesRequest::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. This parameter is ignored when the request specifies one or a list of fleet IDs.

Definition at line 200 of file DescribeFleetAttributesRequest.h.

◆ WithFleetIds() [1/2]

DescribeFleetAttributesRequest& Aws::GameLift::Model::DescribeFleetAttributesRequest::WithFleetIds ( const Aws::Vector< Aws::String > &  value)
inline

A list of unique fleet identifiers to retrieve attributes for. You can use either the fleet ID or ARN value. To retrieve attributes for all current fleets, do not include this parameter. If the list of fleet identifiers includes fleets that don't currently exist, the request succeeds but no attributes for that fleet are returned.

Definition at line 94 of file DescribeFleetAttributesRequest.h.

◆ WithFleetIds() [2/2]

DescribeFleetAttributesRequest& Aws::GameLift::Model::DescribeFleetAttributesRequest::WithFleetIds ( Aws::Vector< Aws::String > &&  value)
inline

A list of unique fleet identifiers to retrieve attributes for. You can use either the fleet ID or ARN value. To retrieve attributes for all current fleets, do not include this parameter. If the list of fleet identifiers includes fleets that don't currently exist, the request succeeds but no attributes for that fleet are returned.

Definition at line 103 of file DescribeFleetAttributesRequest.h.

◆ WithLimit()

DescribeFleetAttributesRequest& Aws::GameLift::Model::DescribeFleetAttributesRequest::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. This parameter is ignored when the request specifies one or a list of fleet IDs.

Definition at line 159 of file DescribeFleetAttributesRequest.h.

◆ WithNextToken() [1/3]

DescribeFleetAttributesRequest& Aws::GameLift::Model::DescribeFleetAttributesRequest::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. This parameter is ignored when the request specifies one or a list of fleet IDs.

Definition at line 208 of file DescribeFleetAttributesRequest.h.

◆ WithNextToken() [2/3]

DescribeFleetAttributesRequest& Aws::GameLift::Model::DescribeFleetAttributesRequest::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. This parameter is ignored when the request specifies one or a list of fleet IDs.

Definition at line 216 of file DescribeFleetAttributesRequest.h.

◆ WithNextToken() [3/3]

DescribeFleetAttributesRequest& Aws::GameLift::Model::DescribeFleetAttributesRequest::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. This parameter is ignored when the request specifies one or a list of fleet IDs.

Definition at line 224 of file DescribeFleetAttributesRequest.h.


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