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

#include <DescribeFleetUtilizationRequest.h>

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

Public Member Functions

 DescribeFleetUtilizationRequest ()
 
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)
 
DescribeFleetUtilizationRequestWithFleetIds (const Aws::Vector< Aws::String > &value)
 
DescribeFleetUtilizationRequestWithFleetIds (Aws::Vector< Aws::String > &&value)
 
DescribeFleetUtilizationRequestAddFleetIds (const Aws::String &value)
 
DescribeFleetUtilizationRequestAddFleetIds (Aws::String &&value)
 
DescribeFleetUtilizationRequestAddFleetIds (const char *value)
 
int GetLimit () const
 
bool LimitHasBeenSet () const
 
void SetLimit (int value)
 
DescribeFleetUtilizationRequestWithLimit (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)
 
DescribeFleetUtilizationRequestWithNextToken (const Aws::String &value)
 
DescribeFleetUtilizationRequestWithNextToken (Aws::String &&value)
 
DescribeFleetUtilizationRequestWithNextToken (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 25 of file DescribeFleetUtilizationRequest.h.

Constructor & Destructor Documentation

◆ DescribeFleetUtilizationRequest()

Aws::GameLift::Model::DescribeFleetUtilizationRequest::DescribeFleetUtilizationRequest ( )

Member Function Documentation

◆ AddFleetIds() [1/3]

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

A unique identifier for a fleet(s) to retrieve utilization data 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 102 of file DescribeFleetUtilizationRequest.h.

◆ AddFleetIds() [2/3]

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

A unique identifier for a fleet(s) to retrieve utilization data 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 111 of file DescribeFleetUtilizationRequest.h.

◆ AddFleetIds() [3/3]

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

A unique identifier for a fleet(s) to retrieve utilization data 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 120 of file DescribeFleetUtilizationRequest.h.

◆ FleetIdsHasBeenSet()

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

A unique identifier for a fleet(s) to retrieve utilization data 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 57 of file DescribeFleetUtilizationRequest.h.

◆ GetFleetIds()

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

A unique identifier for a fleet(s) to retrieve utilization data 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 48 of file DescribeFleetUtilizationRequest.h.

◆ GetLimit()

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

◆ GetNextToken()

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

Definition at line 158 of file DescribeFleetUtilizationRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::GameLift::GameLiftRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file DescribeFleetUtilizationRequest.h.

◆ LimitHasBeenSet()

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

◆ NextTokenHasBeenSet()

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

Definition at line 166 of file DescribeFleetUtilizationRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetFleetIds() [1/2]

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

A unique identifier for a fleet(s) to retrieve utilization data 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 66 of file DescribeFleetUtilizationRequest.h.

◆ SetFleetIds() [2/2]

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

A unique identifier for a fleet(s) to retrieve utilization data 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 75 of file DescribeFleetUtilizationRequest.h.

◆ SetLimit()

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

◆ SetNextToken() [1/3]

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

Definition at line 174 of file DescribeFleetUtilizationRequest.h.

◆ SetNextToken() [2/3]

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

Definition at line 182 of file DescribeFleetUtilizationRequest.h.

◆ SetNextToken() [3/3]

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

Definition at line 190 of file DescribeFleetUtilizationRequest.h.

◆ WithFleetIds() [1/2]

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

A unique identifier for a fleet(s) to retrieve utilization data 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 84 of file DescribeFleetUtilizationRequest.h.

◆ WithFleetIds() [2/2]

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

A unique identifier for a fleet(s) to retrieve utilization data 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 93 of file DescribeFleetUtilizationRequest.h.

◆ WithLimit()

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

◆ WithNextToken() [1/3]

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

Definition at line 198 of file DescribeFleetUtilizationRequest.h.

◆ WithNextToken() [2/3]

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

Definition at line 206 of file DescribeFleetUtilizationRequest.h.

◆ WithNextToken() [3/3]

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

Definition at line 214 of file DescribeFleetUtilizationRequest.h.


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