#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 RoutingStrategyType &	GetRoutingStrategyType () const

bool	RoutingStrategyTypeHasBeenSet () const

void	SetRoutingStrategyType (const RoutingStrategyType &value)

void	SetRoutingStrategyType (RoutingStrategyType &&value)

ListAliasesRequest &	WithRoutingStrategyType (const RoutingStrategyType &value)

ListAliasesRequest &	WithRoutingStrategyType (RoutingStrategyType &&value)

const Aws::String &	GetName () const

bool	NameHasBeenSet () const

void	SetName (const Aws::String &value)

void	SetName (Aws::String &&value)

void	SetName (const char *value)

ListAliasesRequest &	WithName (const Aws::String &value)

ListAliasesRequest &	WithName (Aws::String &&value)

ListAliasesRequest &	WithName (const char *value)

int	GetLimit () const

bool	LimitHasBeenSet () const

void	SetLimit (int value)

ListAliasesRequest &	WithLimit (int value)

const Aws::String &	GetNextToken () const

bool	NextTokenHasBeenSet () const

void	SetNextToken (const Aws::String &value)

void	SetNextToken (Aws::String &&value)

void	SetNextToken (const char *value)

ListAliasesRequest &	WithNextToken (const Aws::String &value)

ListAliasesRequest &	WithNextToken (Aws::String &&value)

ListAliasesRequest &	WithNextToken (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::IOStream >	GetBody () 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 RequestSignedHandler &	GetRequestSignedHandler () const

const Aws::IOStreamFactory &	GetResponseStreamFactory () 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::DataReceivedEventHandler &	GetDataReceivedEventHandler () const

virtual const Aws::Http::DataSentEventHandler &	GetDataSentEventHandler () const

virtual const Aws::Http::ContinueRequestHandler &	GetContinueRequestHandler () const

virtual const RequestRetryHandler &	GetRequestRetryHandler () 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.

Constructor & Destructor Documentation

◆ ListAliasesRequest()

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

Member Function Documentation

◆ GetLimit()

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

◆ GetName()

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

inline

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

Definition at line 118 of file ListAliasesRequest.h.

◆ GetNextToken()

const Aws::String& Aws::GameLift::Model::ListAliasesRequest::GetNextToken ( ) const

inline

A 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 193 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

The routing type to filter results on. Use this parameter to retrieve only aliases with a certain routing 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 51 of file ListAliasesRequest.h.

◆ GetServiceRequestName()

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

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file ListAliasesRequest.h.

◆ LimitHasBeenSet()

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

◆ NameHasBeenSet()

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

inline

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

Definition at line 124 of file ListAliasesRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::GameLift::Model::ListAliasesRequest::NextTokenHasBeenSet ( ) const

inline

A 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 200 of file ListAliasesRequest.h.

◆ RoutingStrategyTypeHasBeenSet()

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

inline

The routing type to filter results on. Use this parameter to retrieve only aliases with a certain routing 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 63 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

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

Definition at line 179 of file ListAliasesRequest.h.

◆ SetName() [1/3]

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

inline

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

Definition at line 130 of file ListAliasesRequest.h.

◆ SetName() [2/3]

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

inline

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

Definition at line 136 of file ListAliasesRequest.h.

◆ SetName() [3/3]

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

inline

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

Definition at line 142 of file ListAliasesRequest.h.

◆ SetNextToken() [1/3]

void Aws::GameLift::Model::ListAliasesRequest::SetNextToken ( const Aws::String & value )

inline

A 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 207 of file ListAliasesRequest.h.

◆ SetNextToken() [2/3]

void Aws::GameLift::Model::ListAliasesRequest::SetNextToken ( Aws::String && value )

inline

A 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 214 of file ListAliasesRequest.h.

◆ SetNextToken() [3/3]

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

inline

A 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 221 of file ListAliasesRequest.h.

◆ SetRoutingStrategyType() [1/2]

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

inline

The routing type to filter results on. Use this parameter to retrieve only aliases with a certain routing 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 75 of file ListAliasesRequest.h.

◆ SetRoutingStrategyType() [2/2]

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

inline

The routing type to filter results on. Use this parameter to retrieve only aliases with a certain routing 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 87 of file ListAliasesRequest.h.

◆ WithLimit()

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

◆ WithName() [1/3]

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

inline

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

Definition at line 148 of file ListAliasesRequest.h.

◆ WithName() [2/3]

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

inline

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

Definition at line 154 of file ListAliasesRequest.h.

◆ WithName() [3/3]

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

inline

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

Definition at line 160 of file ListAliasesRequest.h.

◆ WithNextToken() [1/3]

ListAliasesRequest& Aws::GameLift::Model::ListAliasesRequest::WithNextToken ( const Aws::String & value )

inline

A 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 228 of file ListAliasesRequest.h.

◆ WithNextToken() [2/3]

ListAliasesRequest& Aws::GameLift::Model::ListAliasesRequest::WithNextToken ( Aws::String && value )

inline

A 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 235 of file ListAliasesRequest.h.

◆ WithNextToken() [3/3]

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

inline

A 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 242 of file ListAliasesRequest.h.

◆ WithRoutingStrategyType() [1/2]

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

inline

The routing type to filter results on. Use this parameter to retrieve only aliases with a certain routing 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 99 of file ListAliasesRequest.h.

◆ WithRoutingStrategyType() [2/2]

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

inline

The routing type to filter results on. Use this parameter to retrieve only aliases with a certain routing 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 111 of file ListAliasesRequest.h.

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

aws-cpp-sdk-gamelift/include/aws/gamelift/model/ListAliasesRequest.h

Public Member Functions

Additional Inherited Members

Detailed Description

See Also:

Constructor & Destructor Documentation

◆ ListAliasesRequest()

Member Function Documentation

◆ GetLimit()

◆ GetName()

◆ GetNextToken()

◆ GetRequestSpecificHeaders()

◆ GetRoutingStrategyType()

◆ GetServiceRequestName()

◆ LimitHasBeenSet()

◆ NameHasBeenSet()

◆ NextTokenHasBeenSet()

◆ RoutingStrategyTypeHasBeenSet()

◆ SerializePayload()

◆ SetLimit()

◆ SetName() [1/3]

◆ SetName() [2/3]

◆ SetName() [3/3]

◆ SetNextToken() [1/3]

◆ SetNextToken() [2/3]

◆ SetNextToken() [3/3]

◆ SetRoutingStrategyType() [1/2]

◆ SetRoutingStrategyType() [2/2]

◆ WithLimit()

◆ WithName() [1/3]

◆ WithName() [2/3]

◆ WithName() [3/3]

◆ WithNextToken() [1/3]

◆ WithNextToken() [2/3]

◆ WithNextToken() [3/3]

◆ WithRoutingStrategyType() [1/2]

◆ WithRoutingStrategyType() [2/2]