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

#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::StringGetFleetId () const
 
bool FleetIdHasBeenSet () const
 
void SetFleetId (const Aws::String &value)
 
void SetFleetId (Aws::String &&value)
 
void SetFleetId (const char *value)
 
SearchGameSessionsRequestWithFleetId (const Aws::String &value)
 
SearchGameSessionsRequestWithFleetId (Aws::String &&value)
 
SearchGameSessionsRequestWithFleetId (const char *value)
 
const Aws::StringGetAliasId () const
 
bool AliasIdHasBeenSet () const
 
void SetAliasId (const Aws::String &value)
 
void SetAliasId (Aws::String &&value)
 
void SetAliasId (const char *value)
 
SearchGameSessionsRequestWithAliasId (const Aws::String &value)
 
SearchGameSessionsRequestWithAliasId (Aws::String &&value)
 
SearchGameSessionsRequestWithAliasId (const char *value)
 
const Aws::StringGetFilterExpression () const
 
bool FilterExpressionHasBeenSet () const
 
void SetFilterExpression (const Aws::String &value)
 
void SetFilterExpression (Aws::String &&value)
 
void SetFilterExpression (const char *value)
 
SearchGameSessionsRequestWithFilterExpression (const Aws::String &value)
 
SearchGameSessionsRequestWithFilterExpression (Aws::String &&value)
 
SearchGameSessionsRequestWithFilterExpression (const char *value)
 
const Aws::StringGetSortExpression () const
 
bool SortExpressionHasBeenSet () const
 
void SetSortExpression (const Aws::String &value)
 
void SetSortExpression (Aws::String &&value)
 
void SetSortExpression (const char *value)
 
SearchGameSessionsRequestWithSortExpression (const Aws::String &value)
 
SearchGameSessionsRequestWithSortExpression (Aws::String &&value)
 
SearchGameSessionsRequestWithSortExpression (const char *value)
 
int GetLimit () const
 
bool LimitHasBeenSet () const
 
void SetLimit (int value)
 
SearchGameSessionsRequestWithLimit (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)
 
SearchGameSessionsRequestWithNextToken (const Aws::String &value)
 
SearchGameSessionsRequestWithNextToken (Aws::String &&value)
 
SearchGameSessionsRequestWithNextToken (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 24 of file SearchGameSessionsRequest.h.

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 109 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:

  1. =, <>, <, >, <=, >=

  2. Parentheses

  3. NOT

  4. AND

  5. OR

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

Definition at line 218 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 52 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 102 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:

  1. =, <>, <, >, <=, >=

  2. Parentheses

  3. NOT

  4. AND

  5. OR

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

Definition at line 185 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 45 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 554 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 operation. To start at the beginning of the result set, do not specify a value.

Definition at line 586 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 33 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 433 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 562 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 operation. To start at the beginning of the result set, do not specify a value.

Definition at line 593 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 ( 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 123 of file SearchGameSessionsRequest.h.

◆ SetAliasId() [2/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 116 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 130 of file SearchGameSessionsRequest.h.

◆ SetFilterExpression() [1/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:

  1. =, <>, <, >, <=, >=

  2. Parentheses

  3. NOT

  4. AND

  5. OR

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

Definition at line 284 of file SearchGameSessionsRequest.h.

◆ SetFilterExpression() [2/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:

  1. =, <>, <, >, <=, >=

  2. Parentheses

  3. NOT

  4. AND

  5. OR

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

Definition at line 251 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:

  1. =, <>, <, >, <=, >=

  2. Parentheses

  3. NOT

  4. AND

  5. OR

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

Definition at line 317 of file SearchGameSessionsRequest.h.

◆ SetFleetId() [1/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 66 of file SearchGameSessionsRequest.h.

◆ SetFleetId() [2/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 59 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 73 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 570 of file SearchGameSessionsRequest.h.

◆ SetNextToken() [1/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 operation. To start at the beginning of the result set, do not specify a value.

Definition at line 607 of file SearchGameSessionsRequest.h.

◆ SetNextToken() [2/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 operation. To start at the beginning of the result set, do not specify a value.

Definition at line 600 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 operation. To start at the beginning of the result set, do not specify a value.

Definition at line 614 of file SearchGameSessionsRequest.h.

◆ SetSortExpression() [1/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 481 of file SearchGameSessionsRequest.h.

◆ SetSortExpression() [2/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 465 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 497 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 449 of file SearchGameSessionsRequest.h.

◆ WithAliasId() [1/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 144 of file SearchGameSessionsRequest.h.

◆ WithAliasId() [2/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 137 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 151 of file SearchGameSessionsRequest.h.

◆ WithFilterExpression() [1/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:

  1. =, <>, <, >, <=, >=

  2. Parentheses

  3. NOT

  4. AND

  5. OR

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

Definition at line 383 of file SearchGameSessionsRequest.h.

◆ WithFilterExpression() [2/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:

  1. =, <>, <, >, <=, >=

  2. Parentheses

  3. NOT

  4. AND

  5. OR

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

Definition at line 350 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:

  1. =, <>, <, >, <=, >=

  2. Parentheses

  3. NOT

  4. AND

  5. OR

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

Definition at line 416 of file SearchGameSessionsRequest.h.

◆ WithFleetId() [1/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 87 of file SearchGameSessionsRequest.h.

◆ WithFleetId() [2/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 80 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 94 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 578 of file SearchGameSessionsRequest.h.

◆ WithNextToken() [1/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 operation. To start at the beginning of the result set, do not specify a value.

Definition at line 628 of file SearchGameSessionsRequest.h.

◆ WithNextToken() [2/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 operation. To start at the beginning of the result set, do not specify a value.

Definition at line 621 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 operation. To start at the beginning of the result set, do not specify a value.

Definition at line 635 of file SearchGameSessionsRequest.h.

◆ WithSortExpression() [1/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 529 of file SearchGameSessionsRequest.h.

◆ WithSortExpression() [2/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 513 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 545 of file SearchGameSessionsRequest.h.


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