AWS SDK for C++
1.8.127
AWS SDK for C++
|
#include <SearchGameSessionsRequest.h>
Additional Inherited Members | |
![]() | |
virtual void | DumpBodyToUrl (Aws::Http::URI &uri) const |
Represents the input for a request operation.
Definition at line 24 of file SearchGameSessionsRequest.h.
Aws::GameLift::Model::SearchGameSessionsRequest::SearchGameSessionsRequest | ( | ) |
|
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.
|
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 218 of file SearchGameSessionsRequest.h.
|
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.
|
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.
|
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 185 of file SearchGameSessionsRequest.h.
|
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.
|
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.
|
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.
|
overridevirtual |
Reimplemented from Aws::GameLift::GameLiftRequest.
|
inlineoverridevirtual |
Implements Aws::AmazonWebServiceRequest.
Definition at line 33 of file SearchGameSessionsRequest.h.
|
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.
|
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.
|
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.
|
overridevirtual |
Convert payload into String.
Implements Aws::AmazonSerializableWebServiceRequest.
|
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.
|
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.
|
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.
|
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 284 of file SearchGameSessionsRequest.h.
|
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 251 of file SearchGameSessionsRequest.h.
|
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 317 of file SearchGameSessionsRequest.h.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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 383 of file SearchGameSessionsRequest.h.
|
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 350 of file SearchGameSessionsRequest.h.
|
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 416 of file SearchGameSessionsRequest.h.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.