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

#include <ListBuildsRequest.h>

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

Public Member Functions

 ListBuildsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const BuildStatusGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const BuildStatus &value)
 
void SetStatus (BuildStatus &&value)
 
ListBuildsRequestWithStatus (const BuildStatus &value)
 
ListBuildsRequestWithStatus (BuildStatus &&value)
 
int GetLimit () const
 
bool LimitHasBeenSet () const
 
void SetLimit (int value)
 
ListBuildsRequestWithLimit (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)
 
ListBuildsRequestWithNextToken (const Aws::String &value)
 
ListBuildsRequestWithNextToken (Aws::String &&value)
 
ListBuildsRequestWithNextToken (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 ListBuildsRequest.h.

Constructor & Destructor Documentation

◆ ListBuildsRequest()

Aws::GameLift::Model::ListBuildsRequest::ListBuildsRequest ( )

Member Function Documentation

◆ GetLimit()

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

◆ GetNextToken()

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

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::GameLift::GameLiftRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file ListBuildsRequest.h.

◆ GetStatus()

const BuildStatus& Aws::GameLift::Model::ListBuildsRequest::GetStatus ( ) const
inline

Build status to filter results by. To retrieve all builds, leave this parameter empty.

Possible build statuses include the following:

  • INITIALIZED – A new build has been defined, but no files have been uploaded. You cannot create fleets for builds that are in this status. When a build is successfully created, the build status is set to this value.

  • READY – The game build has been successfully uploaded. You can now create new fleets for this build.

  • FAILED – The game build upload failed. You cannot create new fleets for this build.

Definition at line 52 of file ListBuildsRequest.h.

◆ LimitHasBeenSet()

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

◆ NextTokenHasBeenSet()

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

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetLimit()

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

◆ SetNextToken() [1/3]

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

◆ SetNextToken() [2/3]

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

◆ SetNextToken() [3/3]

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

◆ SetStatus() [1/2]

void Aws::GameLift::Model::ListBuildsRequest::SetStatus ( const BuildStatus value)
inline

Build status to filter results by. To retrieve all builds, leave this parameter empty.

Possible build statuses include the following:

  • INITIALIZED – A new build has been defined, but no files have been uploaded. You cannot create fleets for builds that are in this status. When a build is successfully created, the build status is set to this value.

  • READY – The game build has been successfully uploaded. You can now create new fleets for this build.

  • FAILED – The game build upload failed. You cannot create new fleets for this build.

Definition at line 78 of file ListBuildsRequest.h.

◆ SetStatus() [2/2]

void Aws::GameLift::Model::ListBuildsRequest::SetStatus ( BuildStatus &&  value)
inline

Build status to filter results by. To retrieve all builds, leave this parameter empty.

Possible build statuses include the following:

  • INITIALIZED – A new build has been defined, but no files have been uploaded. You cannot create fleets for builds that are in this status. When a build is successfully created, the build status is set to this value.

  • READY – The game build has been successfully uploaded. You can now create new fleets for this build.

  • FAILED – The game build upload failed. You cannot create new fleets for this build.

Definition at line 91 of file ListBuildsRequest.h.

◆ StatusHasBeenSet()

bool Aws::GameLift::Model::ListBuildsRequest::StatusHasBeenSet ( ) const
inline

Build status to filter results by. To retrieve all builds, leave this parameter empty.

Possible build statuses include the following:

  • INITIALIZED – A new build has been defined, but no files have been uploaded. You cannot create fleets for builds that are in this status. When a build is successfully created, the build status is set to this value.

  • READY – The game build has been successfully uploaded. You can now create new fleets for this build.

  • FAILED – The game build upload failed. You cannot create new fleets for this build.

Definition at line 65 of file ListBuildsRequest.h.

◆ WithLimit()

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

◆ WithNextToken() [1/3]

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

◆ WithNextToken() [2/3]

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

◆ WithNextToken() [3/3]

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

◆ WithStatus() [1/2]

ListBuildsRequest& Aws::GameLift::Model::ListBuildsRequest::WithStatus ( const BuildStatus value)
inline

Build status to filter results by. To retrieve all builds, leave this parameter empty.

Possible build statuses include the following:

  • INITIALIZED – A new build has been defined, but no files have been uploaded. You cannot create fleets for builds that are in this status. When a build is successfully created, the build status is set to this value.

  • READY – The game build has been successfully uploaded. You can now create new fleets for this build.

  • FAILED – The game build upload failed. You cannot create new fleets for this build.

Definition at line 104 of file ListBuildsRequest.h.

◆ WithStatus() [2/2]

ListBuildsRequest& Aws::GameLift::Model::ListBuildsRequest::WithStatus ( BuildStatus &&  value)
inline

Build status to filter results by. To retrieve all builds, leave this parameter empty.

Possible build statuses include the following:

  • INITIALIZED – A new build has been defined, but no files have been uploaded. You cannot create fleets for builds that are in this status. When a build is successfully created, the build status is set to this value.

  • READY – The game build has been successfully uploaded. You can now create new fleets for this build.

  • FAILED – The game build upload failed. You cannot create new fleets for this build.

Definition at line 117 of file ListBuildsRequest.h.


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