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

#include <ListAliasesRequest.h>

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

Public Member Functions

 ListAliasesRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const RoutingStrategyTypeGetRoutingStrategyType () const
 
bool RoutingStrategyTypeHasBeenSet () const
 
void SetRoutingStrategyType (const RoutingStrategyType &value)
 
void SetRoutingStrategyType (RoutingStrategyType &&value)
 
ListAliasesRequestWithRoutingStrategyType (const RoutingStrategyType &value)
 
ListAliasesRequestWithRoutingStrategyType (RoutingStrategyType &&value)
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
ListAliasesRequestWithName (const Aws::String &value)
 
ListAliasesRequestWithName (Aws::String &&value)
 
ListAliasesRequestWithName (const char *value)
 
int GetLimit () const
 
bool LimitHasBeenSet () const
 
void SetLimit (int value)
 
ListAliasesRequestWithLimit (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)
 
ListAliasesRequestWithNextToken (const Aws::String &value)
 
ListAliasesRequestWithNextToken (Aws::String &&value)
 
ListAliasesRequestWithNextToken (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 ListAliasesRequest.h.

Constructor & Destructor Documentation

◆ ListAliasesRequest()

Aws::GameLift::Model::ListAliasesRequest::ListAliasesRequest ( )

Member Function Documentation

◆ GetLimit()

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

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

Definition at line 177 of file ListAliasesRequest.h.

◆ GetName()

const Aws::String& Aws::GameLift::Model::ListAliasesRequest::GetName ( ) const
inline

Descriptive label that is associated with an alias. Alias names do not need to be unique.

Definition at line 128 of file ListAliasesRequest.h.

◆ GetNextToken()

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

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::GameLift::GameLiftRequest.

◆ GetRoutingStrategyType()

const RoutingStrategyType& Aws::GameLift::Model::ListAliasesRequest::GetRoutingStrategyType ( ) const
inline

Type of routing to filter results on. Use this parameter to retrieve only aliases of a certain type. To retrieve all aliases, leave this parameter empty.

Possible routing types include the following:

  • SIMPLE – The alias resolves to one specific fleet. Use this type when routing to active fleets.

  • TERMINAL – The alias does not resolve to a fleet but instead can be used to display a message to the user. A terminal alias throws a TerminalRoutingStrategyException with the RoutingStrategy message embedded.

Definition at line 61 of file ListAliasesRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 44 of file ListAliasesRequest.h.

◆ LimitHasBeenSet()

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

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

Definition at line 183 of file ListAliasesRequest.h.

◆ NameHasBeenSet()

bool Aws::GameLift::Model::ListAliasesRequest::NameHasBeenSet ( ) const
inline

Descriptive label that is associated with an alias. Alias names do not need to be unique.

Definition at line 134 of file ListAliasesRequest.h.

◆ NextTokenHasBeenSet()

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

◆ RoutingStrategyTypeHasBeenSet()

bool Aws::GameLift::Model::ListAliasesRequest::RoutingStrategyTypeHasBeenSet ( ) const
inline

Type of routing to filter results on. Use this parameter to retrieve only aliases of a certain type. To retrieve all aliases, leave this parameter empty.

Possible routing types include the following:

  • SIMPLE – The alias resolves to one specific fleet. Use this type when routing to active fleets.

  • TERMINAL – The alias does not resolve to a fleet but instead can be used to display a message to the user. A terminal alias throws a TerminalRoutingStrategyException with the RoutingStrategy message embedded.

Definition at line 73 of file ListAliasesRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetLimit()

void Aws::GameLift::Model::ListAliasesRequest::SetLimit ( int  value)
inline

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

Definition at line 189 of file ListAliasesRequest.h.

◆ SetName() [1/3]

void Aws::GameLift::Model::ListAliasesRequest::SetName ( const Aws::String value)
inline

Descriptive label that is associated with an alias. Alias names do not need to be unique.

Definition at line 140 of file ListAliasesRequest.h.

◆ SetName() [2/3]

void Aws::GameLift::Model::ListAliasesRequest::SetName ( Aws::String &&  value)
inline

Descriptive label that is associated with an alias. Alias names do not need to be unique.

Definition at line 146 of file ListAliasesRequest.h.

◆ SetName() [3/3]

void Aws::GameLift::Model::ListAliasesRequest::SetName ( const char *  value)
inline

Descriptive label that is associated with an alias. Alias names do not need to be unique.

Definition at line 152 of file ListAliasesRequest.h.

◆ SetNextToken() [1/3]

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

◆ SetNextToken() [2/3]

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

◆ SetNextToken() [3/3]

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

◆ SetRoutingStrategyType() [1/2]

void Aws::GameLift::Model::ListAliasesRequest::SetRoutingStrategyType ( const RoutingStrategyType value)
inline

Type of routing to filter results on. Use this parameter to retrieve only aliases of a certain type. To retrieve all aliases, leave this parameter empty.

Possible routing types include the following:

  • SIMPLE – The alias resolves to one specific fleet. Use this type when routing to active fleets.

  • TERMINAL – The alias does not resolve to a fleet but instead can be used to display a message to the user. A terminal alias throws a TerminalRoutingStrategyException with the RoutingStrategy message embedded.

Definition at line 85 of file ListAliasesRequest.h.

◆ SetRoutingStrategyType() [2/2]

void Aws::GameLift::Model::ListAliasesRequest::SetRoutingStrategyType ( RoutingStrategyType &&  value)
inline

Type of routing to filter results on. Use this parameter to retrieve only aliases of a certain type. To retrieve all aliases, leave this parameter empty.

Possible routing types include the following:

  • SIMPLE – The alias resolves to one specific fleet. Use this type when routing to active fleets.

  • TERMINAL – The alias does not resolve to a fleet but instead can be used to display a message to the user. A terminal alias throws a TerminalRoutingStrategyException with the RoutingStrategy message embedded.

Definition at line 97 of file ListAliasesRequest.h.

◆ WithLimit()

ListAliasesRequest& Aws::GameLift::Model::ListAliasesRequest::WithLimit ( int  value)
inline

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

Definition at line 195 of file ListAliasesRequest.h.

◆ WithName() [1/3]

ListAliasesRequest& Aws::GameLift::Model::ListAliasesRequest::WithName ( const Aws::String value)
inline

Descriptive label that is associated with an alias. Alias names do not need to be unique.

Definition at line 158 of file ListAliasesRequest.h.

◆ WithName() [2/3]

ListAliasesRequest& Aws::GameLift::Model::ListAliasesRequest::WithName ( Aws::String &&  value)
inline

Descriptive label that is associated with an alias. Alias names do not need to be unique.

Definition at line 164 of file ListAliasesRequest.h.

◆ WithName() [3/3]

ListAliasesRequest& Aws::GameLift::Model::ListAliasesRequest::WithName ( const char *  value)
inline

Descriptive label that is associated with an alias. Alias names do not need to be unique.

Definition at line 170 of file ListAliasesRequest.h.

◆ WithNextToken() [1/3]

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

◆ WithNextToken() [2/3]

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

◆ WithNextToken() [3/3]

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

◆ WithRoutingStrategyType() [1/2]

ListAliasesRequest& Aws::GameLift::Model::ListAliasesRequest::WithRoutingStrategyType ( const RoutingStrategyType value)
inline

Type of routing to filter results on. Use this parameter to retrieve only aliases of a certain type. To retrieve all aliases, leave this parameter empty.

Possible routing types include the following:

  • SIMPLE – The alias resolves to one specific fleet. Use this type when routing to active fleets.

  • TERMINAL – The alias does not resolve to a fleet but instead can be used to display a message to the user. A terminal alias throws a TerminalRoutingStrategyException with the RoutingStrategy message embedded.

Definition at line 109 of file ListAliasesRequest.h.

◆ WithRoutingStrategyType() [2/2]

ListAliasesRequest& Aws::GameLift::Model::ListAliasesRequest::WithRoutingStrategyType ( RoutingStrategyType &&  value)
inline

Type of routing to filter results on. Use this parameter to retrieve only aliases of a certain type. To retrieve all aliases, leave this parameter empty.

Possible routing types include the following:

  • SIMPLE – The alias resolves to one specific fleet. Use this type when routing to active fleets.

  • TERMINAL – The alias does not resolve to a fleet but instead can be used to display a message to the user. A terminal alias throws a TerminalRoutingStrategyException with the RoutingStrategy message embedded.

Definition at line 121 of file ListAliasesRequest.h.


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