#include <SearchGameSessionsRequest.h>

Inheritance diagram for Aws::GameLift::Model::SearchGameSessionsRequest:

Public Member Functions
	SearchGameSessionsRequest ()

virtual const char *	GetServiceRequestName () const override

Aws::String	SerializePayload () const override

Aws::Http::HeaderValueCollection	GetRequestSpecificHeaders () const override

const Aws::String &	GetFleetId () const

bool	FleetIdHasBeenSet () const

void	SetFleetId (const Aws::String &value)

void	SetFleetId (Aws::String &&value)

void	SetFleetId (const char *value)

SearchGameSessionsRequest &	WithFleetId (const Aws::String &value)

SearchGameSessionsRequest &	WithFleetId (Aws::String &&value)

SearchGameSessionsRequest &	WithFleetId (const char *value)

const Aws::String &	GetAliasId () const

bool	AliasIdHasBeenSet () const

void	SetAliasId (const Aws::String &value)

void	SetAliasId (Aws::String &&value)

void	SetAliasId (const char *value)

SearchGameSessionsRequest &	WithAliasId (const Aws::String &value)

SearchGameSessionsRequest &	WithAliasId (Aws::String &&value)

SearchGameSessionsRequest &	WithAliasId (const char *value)

const Aws::String &	GetFilterExpression () const

bool	FilterExpressionHasBeenSet () const

void	SetFilterExpression (const Aws::String &value)

void	SetFilterExpression (Aws::String &&value)

void	SetFilterExpression (const char *value)

SearchGameSessionsRequest &	WithFilterExpression (const Aws::String &value)

SearchGameSessionsRequest &	WithFilterExpression (Aws::String &&value)

SearchGameSessionsRequest &	WithFilterExpression (const char *value)

const Aws::String &	GetSortExpression () const

bool	SortExpressionHasBeenSet () const

void	SetSortExpression (const Aws::String &value)

void	SetSortExpression (Aws::String &&value)

void	SetSortExpression (const char *value)

SearchGameSessionsRequest &	WithSortExpression (const Aws::String &value)

SearchGameSessionsRequest &	WithSortExpression (Aws::String &&value)

SearchGameSessionsRequest &	WithSortExpression (const char *value)

int	GetLimit () const

bool	LimitHasBeenSet () const

void	SetLimit (int value)

SearchGameSessionsRequest &	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)

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

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

SearchGameSessionsRequest &	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 action.

Constructor & Destructor Documentation

◆ SearchGameSessionsRequest()

Aws::GameLift::Model::SearchGameSessionsRequest::SearchGameSessionsRequest ( )

Member Function Documentation

◆ AliasIdHasBeenSet()

bool Aws::GameLift::Model::SearchGameSessionsRequest::AliasIdHasBeenSet ( ) const

inline

A unique identifier for an alias associated with the fleet to search for active game sessions. You can use either the alias ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.

Definition at line 119 of file SearchGameSessionsRequest.h.

◆ FilterExpressionHasBeenSet()

bool Aws::GameLift::Model::SearchGameSessionsRequest::FilterExpressionHasBeenSet ( ) const

inline

String containing the search criteria for the session search. If no filter expression is included, the request returns results for all game sessions in the fleet that are in ACTIVE status.

A filter expression can contain one or multiple conditions. Each condition consists of the following:

Operand – Name of a game session attribute. Valid values are gameSessionName, gameSessionId, gameSessionProperties, maximumSessions, creationTimeMillis, playerSessionCount, hasAvailablePlayerSessions.
Comparator – Valid comparators are: =, <>, <, >, <=, >=.
Value – Value to be searched for. Values may be numbers, boolean values (true/false) or strings depending on the operand. String values are case sensitive and must be enclosed in single quotes. Special characters must be escaped. Boolean and string values can only be used with the comparators = and <>. For example, the following filter expression searches on gameSessionName: "<code>FilterExpression": "gameSessionName = 'Matt\\'s Awesome Game 1'".

To chain multiple conditions in a single expression, use the logical keywords AND, OR, and NOT and parentheses as needed. For example: x AND y AND NOT z, NOT (x OR y).

Session search evaluates conditions from left to right using the following precedence rules:

=, <>, <, >, <=, >=
Parentheses
NOT
AND
OR

For example, this filter expression retrieves game sessions hosting at least ten players that have an open player slot: "maximumSessions>=10 AND hasAvailablePlayerSessions=true".

Definition at line 228 of file SearchGameSessionsRequest.h.

◆ FleetIdHasBeenSet()

bool Aws::GameLift::Model::SearchGameSessionsRequest::FleetIdHasBeenSet ( ) const

inline

A unique identifier for a fleet to search for active game sessions. You can use either the fleet ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.

Definition at line 62 of file SearchGameSessionsRequest.h.

◆ GetAliasId()

const Aws::String& Aws::GameLift::Model::SearchGameSessionsRequest::GetAliasId ( ) const

inline

A unique identifier for an alias associated with the fleet to search for active game sessions. You can use either the alias ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.

Definition at line 112 of file SearchGameSessionsRequest.h.

◆ GetFilterExpression()

const Aws::String& Aws::GameLift::Model::SearchGameSessionsRequest::GetFilterExpression ( ) const

inline

String containing the search criteria for the session search. If no filter expression is included, the request returns results for all game sessions in the fleet that are in ACTIVE status.

A filter expression can contain one or multiple conditions. Each condition consists of the following:

Operand – Name of a game session attribute. Valid values are gameSessionName, gameSessionId, gameSessionProperties, maximumSessions, creationTimeMillis, playerSessionCount, hasAvailablePlayerSessions.
Comparator – Valid comparators are: =, <>, <, >, <=, >=.
Value – Value to be searched for. Values may be numbers, boolean values (true/false) or strings depending on the operand. String values are case sensitive and must be enclosed in single quotes. Special characters must be escaped. Boolean and string values can only be used with the comparators = and <>. For example, the following filter expression searches on gameSessionName: "<code>FilterExpression": "gameSessionName = 'Matt\\'s Awesome Game 1'".

To chain multiple conditions in a single expression, use the logical keywords AND, OR, and NOT and parentheses as needed. For example: x AND y AND NOT z, NOT (x OR y).

Session search evaluates conditions from left to right using the following precedence rules:

=, <>, <, >, <=, >=
Parentheses
NOT
AND
OR

For example, this filter expression retrieves game sessions hosting at least ten players that have an open player slot: "maximumSessions>=10 AND hasAvailablePlayerSessions=true".

Definition at line 195 of file SearchGameSessionsRequest.h.

◆ GetFleetId()

const Aws::String& Aws::GameLift::Model::SearchGameSessionsRequest::GetFleetId ( ) const

inline

A unique identifier for a fleet to search for active game sessions. You can use either the fleet ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.

Definition at line 55 of file SearchGameSessionsRequest.h.

◆ GetLimit()

int Aws::GameLift::Model::SearchGameSessionsRequest::GetLimit ( ) const

inline

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. The maximum number of results returned is 20, even if this value is not set or is set higher than 20.

Definition at line 564 of file SearchGameSessionsRequest.h.

◆ GetNextToken()

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

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::GameLift::Model::SearchGameSessionsRequest::GetRequestSpecificHeaders ( ) const

overridevirtual

Reimplemented from Aws::GameLift::GameLiftRequest.

◆ GetServiceRequestName()

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

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 43 of file SearchGameSessionsRequest.h.

◆ GetSortExpression()

const Aws::String& Aws::GameLift::Model::SearchGameSessionsRequest::GetSortExpression ( ) const

inline

Instructions on how to sort the search results. If no sort expression is included, the request returns results in random order. A sort expression consists of the following elements:

Operand – Name of a game session attribute. Valid values are gameSessionName, gameSessionId, gameSessionProperties, maximumSessions, creationTimeMillis, playerSessionCount, hasAvailablePlayerSessions.
Order – Valid sort orders are ASC (ascending) and DESC (descending).

For example, this sort expression returns the oldest active sessions first: "SortExpression": "creationTimeMillis ASC". Results with a null value for the sort operand are returned at the end of the list.

Definition at line 443 of file SearchGameSessionsRequest.h.

◆ LimitHasBeenSet()

bool Aws::GameLift::Model::SearchGameSessionsRequest::LimitHasBeenSet ( ) const

inline

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. The maximum number of results returned is 20, even if this value is not set or is set higher than 20.

Definition at line 572 of file SearchGameSessionsRequest.h.

◆ NextTokenHasBeenSet()

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

◆ SerializePayload()

Aws::String Aws::GameLift::Model::SearchGameSessionsRequest::SerializePayload ( ) const

overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAliasId() [1/3]

void Aws::GameLift::Model::SearchGameSessionsRequest::SetAliasId ( const Aws::String & value )

inline

A unique identifier for an alias associated with the fleet to search for active game sessions. You can use either the alias ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.

Definition at line 126 of file SearchGameSessionsRequest.h.

◆ SetAliasId() [2/3]

void Aws::GameLift::Model::SearchGameSessionsRequest::SetAliasId ( Aws::String && value )

inline

A unique identifier for an alias associated with the fleet to search for active game sessions. You can use either the alias ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.

Definition at line 133 of file SearchGameSessionsRequest.h.

◆ SetAliasId() [3/3]

void Aws::GameLift::Model::SearchGameSessionsRequest::SetAliasId ( const char * value )

inline

A unique identifier for an alias associated with the fleet to search for active game sessions. You can use either the alias ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.

Definition at line 140 of file SearchGameSessionsRequest.h.

◆ SetFilterExpression() [1/3]

void Aws::GameLift::Model::SearchGameSessionsRequest::SetFilterExpression ( const Aws::String & value )

inline

String containing the search criteria for the session search. If no filter expression is included, the request returns results for all game sessions in the fleet that are in ACTIVE status.

A filter expression can contain one or multiple conditions. Each condition consists of the following:

Operand – Name of a game session attribute. Valid values are gameSessionName, gameSessionId, gameSessionProperties, maximumSessions, creationTimeMillis, playerSessionCount, hasAvailablePlayerSessions.
Comparator – Valid comparators are: =, <>, <, >, <=, >=.
Value – Value to be searched for. Values may be numbers, boolean values (true/false) or strings depending on the operand. String values are case sensitive and must be enclosed in single quotes. Special characters must be escaped. Boolean and string values can only be used with the comparators = and <>. For example, the following filter expression searches on gameSessionName: "<code>FilterExpression": "gameSessionName = 'Matt\\'s Awesome Game 1'".

To chain multiple conditions in a single expression, use the logical keywords AND, OR, and NOT and parentheses as needed. For example: x AND y AND NOT z, NOT (x OR y).

Session search evaluates conditions from left to right using the following precedence rules:

=, <>, <, >, <=, >=
Parentheses
NOT
AND
OR

For example, this filter expression retrieves game sessions hosting at least ten players that have an open player slot: "maximumSessions>=10 AND hasAvailablePlayerSessions=true".

Definition at line 261 of file SearchGameSessionsRequest.h.

◆ SetFilterExpression() [2/3]

void Aws::GameLift::Model::SearchGameSessionsRequest::SetFilterExpression ( Aws::String && value )

inline

String containing the search criteria for the session search. If no filter expression is included, the request returns results for all game sessions in the fleet that are in ACTIVE status.

A filter expression can contain one or multiple conditions. Each condition consists of the following:

Operand – Name of a game session attribute. Valid values are gameSessionName, gameSessionId, gameSessionProperties, maximumSessions, creationTimeMillis, playerSessionCount, hasAvailablePlayerSessions.
Comparator – Valid comparators are: =, <>, <, >, <=, >=.
Value – Value to be searched for. Values may be numbers, boolean values (true/false) or strings depending on the operand. String values are case sensitive and must be enclosed in single quotes. Special characters must be escaped. Boolean and string values can only be used with the comparators = and <>. For example, the following filter expression searches on gameSessionName: "<code>FilterExpression": "gameSessionName = 'Matt\\'s Awesome Game 1'".

To chain multiple conditions in a single expression, use the logical keywords AND, OR, and NOT and parentheses as needed. For example: x AND y AND NOT z, NOT (x OR y).

Session search evaluates conditions from left to right using the following precedence rules:

=, <>, <, >, <=, >=
Parentheses
NOT
AND
OR

For example, this filter expression retrieves game sessions hosting at least ten players that have an open player slot: "maximumSessions>=10 AND hasAvailablePlayerSessions=true".

Definition at line 294 of file SearchGameSessionsRequest.h.

◆ SetFilterExpression() [3/3]

void Aws::GameLift::Model::SearchGameSessionsRequest::SetFilterExpression ( const char * value )

inline

String containing the search criteria for the session search. If no filter expression is included, the request returns results for all game sessions in the fleet that are in ACTIVE status.

A filter expression can contain one or multiple conditions. Each condition consists of the following:

Operand – Name of a game session attribute. Valid values are gameSessionName, gameSessionId, gameSessionProperties, maximumSessions, creationTimeMillis, playerSessionCount, hasAvailablePlayerSessions.
Comparator – Valid comparators are: =, <>, <, >, <=, >=.
Value – Value to be searched for. Values may be numbers, boolean values (true/false) or strings depending on the operand. String values are case sensitive and must be enclosed in single quotes. Special characters must be escaped. Boolean and string values can only be used with the comparators = and <>. For example, the following filter expression searches on gameSessionName: "<code>FilterExpression": "gameSessionName = 'Matt\\'s Awesome Game 1'".

To chain multiple conditions in a single expression, use the logical keywords AND, OR, and NOT and parentheses as needed. For example: x AND y AND NOT z, NOT (x OR y).

Session search evaluates conditions from left to right using the following precedence rules:

=, <>, <, >, <=, >=
Parentheses
NOT
AND
OR

For example, this filter expression retrieves game sessions hosting at least ten players that have an open player slot: "maximumSessions>=10 AND hasAvailablePlayerSessions=true".

Definition at line 327 of file SearchGameSessionsRequest.h.

◆ SetFleetId() [1/3]

void Aws::GameLift::Model::SearchGameSessionsRequest::SetFleetId ( const Aws::String & value )

inline

A unique identifier for a fleet to search for active game sessions. You can use either the fleet ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.

Definition at line 69 of file SearchGameSessionsRequest.h.

◆ SetFleetId() [2/3]

void Aws::GameLift::Model::SearchGameSessionsRequest::SetFleetId ( Aws::String && value )

inline

A unique identifier for a fleet to search for active game sessions. You can use either the fleet ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.

Definition at line 76 of file SearchGameSessionsRequest.h.

◆ SetFleetId() [3/3]

void Aws::GameLift::Model::SearchGameSessionsRequest::SetFleetId ( const char * value )

inline

A unique identifier for a fleet to search for active game sessions. You can use either the fleet ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.

Definition at line 83 of file SearchGameSessionsRequest.h.

◆ SetLimit()

void Aws::GameLift::Model::SearchGameSessionsRequest::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. The maximum number of results returned is 20, even if this value is not set or is set higher than 20.

Definition at line 580 of file SearchGameSessionsRequest.h.

◆ SetNextToken() [1/3]

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

◆ SetNextToken() [2/3]

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

◆ SetNextToken() [3/3]

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

◆ SetSortExpression() [1/3]

void Aws::GameLift::Model::SearchGameSessionsRequest::SetSortExpression ( const Aws::String & value )

inline

Instructions on how to sort the search results. If no sort expression is included, the request returns results in random order. A sort expression consists of the following elements:

Operand – Name of a game session attribute. Valid values are gameSessionName, gameSessionId, gameSessionProperties, maximumSessions, creationTimeMillis, playerSessionCount, hasAvailablePlayerSessions.
Order – Valid sort orders are ASC (ascending) and DESC (descending).

For example, this sort expression returns the oldest active sessions first: "SortExpression": "creationTimeMillis ASC". Results with a null value for the sort operand are returned at the end of the list.

Definition at line 475 of file SearchGameSessionsRequest.h.

◆ SetSortExpression() [2/3]

void Aws::GameLift::Model::SearchGameSessionsRequest::SetSortExpression ( Aws::String && value )

inline

Instructions on how to sort the search results. If no sort expression is included, the request returns results in random order. A sort expression consists of the following elements:

Operand – Name of a game session attribute. Valid values are gameSessionName, gameSessionId, gameSessionProperties, maximumSessions, creationTimeMillis, playerSessionCount, hasAvailablePlayerSessions.
Order – Valid sort orders are ASC (ascending) and DESC (descending).

For example, this sort expression returns the oldest active sessions first: "SortExpression": "creationTimeMillis ASC". Results with a null value for the sort operand are returned at the end of the list.

Definition at line 491 of file SearchGameSessionsRequest.h.

◆ SetSortExpression() [3/3]

void Aws::GameLift::Model::SearchGameSessionsRequest::SetSortExpression ( const char * value )

inline

Instructions on how to sort the search results. If no sort expression is included, the request returns results in random order. A sort expression consists of the following elements:

Operand – Name of a game session attribute. Valid values are gameSessionName, gameSessionId, gameSessionProperties, maximumSessions, creationTimeMillis, playerSessionCount, hasAvailablePlayerSessions.
Order – Valid sort orders are ASC (ascending) and DESC (descending).

For example, this sort expression returns the oldest active sessions first: "SortExpression": "creationTimeMillis ASC". Results with a null value for the sort operand are returned at the end of the list.

Definition at line 507 of file SearchGameSessionsRequest.h.

◆ SortExpressionHasBeenSet()

bool Aws::GameLift::Model::SearchGameSessionsRequest::SortExpressionHasBeenSet ( ) const

inline

Instructions on how to sort the search results. If no sort expression is included, the request returns results in random order. A sort expression consists of the following elements:

Operand – Name of a game session attribute. Valid values are gameSessionName, gameSessionId, gameSessionProperties, maximumSessions, creationTimeMillis, playerSessionCount, hasAvailablePlayerSessions.
Order – Valid sort orders are ASC (ascending) and DESC (descending).

For example, this sort expression returns the oldest active sessions first: "SortExpression": "creationTimeMillis ASC". Results with a null value for the sort operand are returned at the end of the list.

Definition at line 459 of file SearchGameSessionsRequest.h.

◆ WithAliasId() [1/3]

SearchGameSessionsRequest& Aws::GameLift::Model::SearchGameSessionsRequest::WithAliasId ( const Aws::String & value )

inline

A unique identifier for an alias associated with the fleet to search for active game sessions. You can use either the alias ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.

Definition at line 147 of file SearchGameSessionsRequest.h.

◆ WithAliasId() [2/3]

SearchGameSessionsRequest& Aws::GameLift::Model::SearchGameSessionsRequest::WithAliasId ( Aws::String && value )

inline

A unique identifier for an alias associated with the fleet to search for active game sessions. You can use either the alias ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.

Definition at line 154 of file SearchGameSessionsRequest.h.

◆ WithAliasId() [3/3]

SearchGameSessionsRequest& Aws::GameLift::Model::SearchGameSessionsRequest::WithAliasId ( const char * value )

inline

A unique identifier for an alias associated with the fleet to search for active game sessions. You can use either the alias ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.

Definition at line 161 of file SearchGameSessionsRequest.h.

◆ WithFilterExpression() [1/3]

SearchGameSessionsRequest& Aws::GameLift::Model::SearchGameSessionsRequest::WithFilterExpression ( const Aws::String & value )

inline

String containing the search criteria for the session search. If no filter expression is included, the request returns results for all game sessions in the fleet that are in ACTIVE status.

A filter expression can contain one or multiple conditions. Each condition consists of the following:

Operand – Name of a game session attribute. Valid values are gameSessionName, gameSessionId, gameSessionProperties, maximumSessions, creationTimeMillis, playerSessionCount, hasAvailablePlayerSessions.
Comparator – Valid comparators are: =, <>, <, >, <=, >=.
Value – Value to be searched for. Values may be numbers, boolean values (true/false) or strings depending on the operand. String values are case sensitive and must be enclosed in single quotes. Special characters must be escaped. Boolean and string values can only be used with the comparators = and <>. For example, the following filter expression searches on gameSessionName: "<code>FilterExpression": "gameSessionName = 'Matt\\'s Awesome Game 1'".

To chain multiple conditions in a single expression, use the logical keywords AND, OR, and NOT and parentheses as needed. For example: x AND y AND NOT z, NOT (x OR y).

Session search evaluates conditions from left to right using the following precedence rules:

=, <>, <, >, <=, >=
Parentheses
NOT
AND
OR

For example, this filter expression retrieves game sessions hosting at least ten players that have an open player slot: "maximumSessions>=10 AND hasAvailablePlayerSessions=true".

Definition at line 360 of file SearchGameSessionsRequest.h.

◆ WithFilterExpression() [2/3]

SearchGameSessionsRequest& Aws::GameLift::Model::SearchGameSessionsRequest::WithFilterExpression ( Aws::String && value )

inline

String containing the search criteria for the session search. If no filter expression is included, the request returns results for all game sessions in the fleet that are in ACTIVE status.

A filter expression can contain one or multiple conditions. Each condition consists of the following:

Operand – Name of a game session attribute. Valid values are gameSessionName, gameSessionId, gameSessionProperties, maximumSessions, creationTimeMillis, playerSessionCount, hasAvailablePlayerSessions.
Comparator – Valid comparators are: =, <>, <, >, <=, >=.
Value – Value to be searched for. Values may be numbers, boolean values (true/false) or strings depending on the operand. String values are case sensitive and must be enclosed in single quotes. Special characters must be escaped. Boolean and string values can only be used with the comparators = and <>. For example, the following filter expression searches on gameSessionName: "<code>FilterExpression": "gameSessionName = 'Matt\\'s Awesome Game 1'".

To chain multiple conditions in a single expression, use the logical keywords AND, OR, and NOT and parentheses as needed. For example: x AND y AND NOT z, NOT (x OR y).

Session search evaluates conditions from left to right using the following precedence rules:

=, <>, <, >, <=, >=
Parentheses
NOT
AND
OR

For example, this filter expression retrieves game sessions hosting at least ten players that have an open player slot: "maximumSessions>=10 AND hasAvailablePlayerSessions=true".

Definition at line 393 of file SearchGameSessionsRequest.h.

◆ WithFilterExpression() [3/3]

SearchGameSessionsRequest& Aws::GameLift::Model::SearchGameSessionsRequest::WithFilterExpression ( const char * value )

inline

String containing the search criteria for the session search. If no filter expression is included, the request returns results for all game sessions in the fleet that are in ACTIVE status.

A filter expression can contain one or multiple conditions. Each condition consists of the following:

Operand – Name of a game session attribute. Valid values are gameSessionName, gameSessionId, gameSessionProperties, maximumSessions, creationTimeMillis, playerSessionCount, hasAvailablePlayerSessions.
Comparator – Valid comparators are: =, <>, <, >, <=, >=.
Value – Value to be searched for. Values may be numbers, boolean values (true/false) or strings depending on the operand. String values are case sensitive and must be enclosed in single quotes. Special characters must be escaped. Boolean and string values can only be used with the comparators = and <>. For example, the following filter expression searches on gameSessionName: "<code>FilterExpression": "gameSessionName = 'Matt\\'s Awesome Game 1'".

To chain multiple conditions in a single expression, use the logical keywords AND, OR, and NOT and parentheses as needed. For example: x AND y AND NOT z, NOT (x OR y).

Session search evaluates conditions from left to right using the following precedence rules:

=, <>, <, >, <=, >=
Parentheses
NOT
AND
OR

For example, this filter expression retrieves game sessions hosting at least ten players that have an open player slot: "maximumSessions>=10 AND hasAvailablePlayerSessions=true".

Definition at line 426 of file SearchGameSessionsRequest.h.

◆ WithFleetId() [1/3]

SearchGameSessionsRequest& Aws::GameLift::Model::SearchGameSessionsRequest::WithFleetId ( const Aws::String & value )

inline

A unique identifier for a fleet to search for active game sessions. You can use either the fleet ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.

Definition at line 90 of file SearchGameSessionsRequest.h.

◆ WithFleetId() [2/3]

SearchGameSessionsRequest& Aws::GameLift::Model::SearchGameSessionsRequest::WithFleetId ( Aws::String && value )

inline

A unique identifier for a fleet to search for active game sessions. You can use either the fleet ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.

Definition at line 97 of file SearchGameSessionsRequest.h.

◆ WithFleetId() [3/3]

SearchGameSessionsRequest& Aws::GameLift::Model::SearchGameSessionsRequest::WithFleetId ( const char * value )

inline

A unique identifier for a fleet to search for active game sessions. You can use either the fleet ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.

Definition at line 104 of file SearchGameSessionsRequest.h.

◆ WithLimit()

SearchGameSessionsRequest& Aws::GameLift::Model::SearchGameSessionsRequest::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. The maximum number of results returned is 20, even if this value is not set or is set higher than 20.

Definition at line 588 of file SearchGameSessionsRequest.h.

◆ WithNextToken() [1/3]

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

◆ WithNextToken() [2/3]

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

◆ WithNextToken() [3/3]

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

◆ WithSortExpression() [1/3]

SearchGameSessionsRequest& Aws::GameLift::Model::SearchGameSessionsRequest::WithSortExpression ( const Aws::String & value )

inline

Instructions on how to sort the search results. If no sort expression is included, the request returns results in random order. A sort expression consists of the following elements:

Operand – Name of a game session attribute. Valid values are gameSessionName, gameSessionId, gameSessionProperties, maximumSessions, creationTimeMillis, playerSessionCount, hasAvailablePlayerSessions.
Order – Valid sort orders are ASC (ascending) and DESC (descending).

For example, this sort expression returns the oldest active sessions first: "SortExpression": "creationTimeMillis ASC". Results with a null value for the sort operand are returned at the end of the list.

Definition at line 523 of file SearchGameSessionsRequest.h.

◆ WithSortExpression() [2/3]

SearchGameSessionsRequest& Aws::GameLift::Model::SearchGameSessionsRequest::WithSortExpression ( Aws::String && value )

inline

Instructions on how to sort the search results. If no sort expression is included, the request returns results in random order. A sort expression consists of the following elements:

Operand – Name of a game session attribute. Valid values are gameSessionName, gameSessionId, gameSessionProperties, maximumSessions, creationTimeMillis, playerSessionCount, hasAvailablePlayerSessions.
Order – Valid sort orders are ASC (ascending) and DESC (descending).

For example, this sort expression returns the oldest active sessions first: "SortExpression": "creationTimeMillis ASC". Results with a null value for the sort operand are returned at the end of the list.

Definition at line 539 of file SearchGameSessionsRequest.h.

◆ WithSortExpression() [3/3]

SearchGameSessionsRequest& Aws::GameLift::Model::SearchGameSessionsRequest::WithSortExpression ( const char * value )

inline

Instructions on how to sort the search results. If no sort expression is included, the request returns results in random order. A sort expression consists of the following elements:

Operand – Name of a game session attribute. Valid values are gameSessionName, gameSessionId, gameSessionProperties, maximumSessions, creationTimeMillis, playerSessionCount, hasAvailablePlayerSessions.
Order – Valid sort orders are ASC (ascending) and DESC (descending).

For example, this sort expression returns the oldest active sessions first: "SortExpression": "creationTimeMillis ASC". Results with a null value for the sort operand are returned at the end of the list.

Definition at line 555 of file SearchGameSessionsRequest.h.

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

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

Public Member Functions

Additional Inherited Members

Detailed Description

See Also:

Constructor & Destructor Documentation

◆ SearchGameSessionsRequest()

Member Function Documentation

◆ AliasIdHasBeenSet()

◆ FilterExpressionHasBeenSet()

◆ FleetIdHasBeenSet()

◆ GetAliasId()

◆ GetFilterExpression()

◆ GetFleetId()

◆ GetLimit()

◆ GetNextToken()

◆ GetRequestSpecificHeaders()

◆ GetServiceRequestName()

◆ GetSortExpression()

◆ LimitHasBeenSet()

◆ NextTokenHasBeenSet()

◆ SerializePayload()

◆ SetAliasId() [1/3]

◆ SetAliasId() [2/3]

◆ SetAliasId() [3/3]

◆ SetFilterExpression() [1/3]

◆ SetFilterExpression() [2/3]

◆ SetFilterExpression() [3/3]

◆ SetFleetId() [1/3]

◆ SetFleetId() [2/3]

◆ SetFleetId() [3/3]

◆ SetLimit()

◆ SetNextToken() [1/3]

◆ SetNextToken() [2/3]

◆ SetNextToken() [3/3]

◆ SetSortExpression() [1/3]

◆ SetSortExpression() [2/3]

◆ SetSortExpression() [3/3]

◆ SortExpressionHasBeenSet()

◆ WithAliasId() [1/3]

◆ WithAliasId() [2/3]

◆ WithAliasId() [3/3]

◆ WithFilterExpression() [1/3]

◆ WithFilterExpression() [2/3]

◆ WithFilterExpression() [3/3]

◆ WithFleetId() [1/3]

◆ WithFleetId() [2/3]

◆ WithFleetId() [3/3]

◆ WithLimit()

◆ WithNextToken() [1/3]

◆ WithNextToken() [2/3]

◆ WithNextToken() [3/3]

◆ WithSortExpression() [1/3]

◆ WithSortExpression() [2/3]

◆ WithSortExpression() [3/3]