/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include Represents the input for a request action.See Also:
AWS
* API Reference
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.
*/ inline const Aws::String& GetFleetId() const{ return m_fleetId; } /** *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.
*/ inline bool FleetIdHasBeenSet() const { return m_fleetIdHasBeenSet; } /** *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.
*/ inline void SetFleetId(const Aws::String& value) { m_fleetIdHasBeenSet = true; m_fleetId = value; } /** *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.
*/ inline void SetFleetId(Aws::String&& value) { m_fleetIdHasBeenSet = true; m_fleetId = std::move(value); } /** *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.
*/ inline void SetFleetId(const char* value) { m_fleetIdHasBeenSet = true; m_fleetId.assign(value); } /** *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.
*/ inline SearchGameSessionsRequest& WithFleetId(const Aws::String& value) { SetFleetId(value); return *this;} /** *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.
*/ inline SearchGameSessionsRequest& WithFleetId(Aws::String&& value) { SetFleetId(std::move(value)); return *this;} /** *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.
*/ inline SearchGameSessionsRequest& WithFleetId(const char* value) { SetFleetId(value); return *this;} /** *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.
*/ inline const Aws::String& GetAliasId() const{ return m_aliasId; } /** *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.
*/ inline bool AliasIdHasBeenSet() const { return m_aliasIdHasBeenSet; } /** *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.
*/ inline void SetAliasId(const Aws::String& value) { m_aliasIdHasBeenSet = true; m_aliasId = value; } /** *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.
*/ inline void SetAliasId(Aws::String&& value) { m_aliasIdHasBeenSet = true; m_aliasId = std::move(value); } /** *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.
*/ inline void SetAliasId(const char* value) { m_aliasIdHasBeenSet = true; m_aliasId.assign(value); } /** *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.
*/ inline SearchGameSessionsRequest& WithAliasId(const Aws::String& value) { SetAliasId(value); return *this;} /** *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.
*/ inline SearchGameSessionsRequest& WithAliasId(Aws::String&& value) { SetAliasId(std::move(value)); return *this;} /** *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.
*/ inline SearchGameSessionsRequest& WithAliasId(const char* value) { SetAliasId(value); return *this;} /** *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: "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".
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: "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".
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: "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".
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: "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".
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: "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".
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: "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".
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: "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".
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: "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".
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
*/ inline const Aws::String& GetNextToken() const{ return m_nextToken; } /** *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.
*/ inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; } /** *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.
*/ inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; } /** *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.
*/ inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); } /** *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.
*/ inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); } /** *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.
*/ inline SearchGameSessionsRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;} /** *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.
*/ inline SearchGameSessionsRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;} /** *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.
*/ inline SearchGameSessionsRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;} private: Aws::String m_fleetId; bool m_fleetIdHasBeenSet; Aws::String m_aliasId; bool m_aliasIdHasBeenSet; Aws::String m_filterExpression; bool m_filterExpressionHasBeenSet; Aws::String m_sortExpression; bool m_sortExpressionHasBeenSet; int m_limit; bool m_limitHasBeenSet; Aws::String m_nextToken; bool m_nextTokenHasBeenSet; }; } // namespace Model } // namespace GameLift } // namespace Aws