public static interface SearchGameSessionsRequest.Builder extends GameLiftRequest.Builder, CopyableBuilder<SearchGameSessionsRequest.Builder,SearchGameSessionsRequest>
Modifier and Type | Method and Description |
---|---|
SearchGameSessionsRequest.Builder |
aliasId(String aliasId)
Unique identifier for an alias associated with the fleet to search for active game sessions.
|
SearchGameSessionsRequest.Builder |
filterExpression(String filterExpression)
String containing the search criteria for the session search.
|
SearchGameSessionsRequest.Builder |
fleetId(String fleetId)
Unique identifier for a fleet to search for active game sessions.
|
SearchGameSessionsRequest.Builder |
limit(Integer limit)
Maximum number of results to return.
|
SearchGameSessionsRequest.Builder |
nextToken(String nextToken)
Token that indicates the start of the next sequential page of results.
|
SearchGameSessionsRequest.Builder |
requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)
Add an optional request override configuration.
|
SearchGameSessionsRequest.Builder |
sortExpression(String sortExpression)
Instructions on how to sort the search results.
|
build
requestOverrideConfig, requestOverrideConfig
copy
apply, build
SearchGameSessionsRequest.Builder fleetId(String fleetId)
Unique identifier for a fleet to search for active game sessions. Each request must reference either a fleet ID or alias ID, but not both.
fleetId
- Unique identifier for a fleet to search for active game sessions. Each request must reference either a
fleet ID or alias ID, but not both.SearchGameSessionsRequest.Builder aliasId(String aliasId)
Unique identifier for an alias associated with the fleet to search for active game sessions. Each request must reference either a fleet ID or alias ID, but not both.
aliasId
- Unique identifier for an alias associated with the fleet to search for active game sessions. Each
request must reference either a fleet ID or alias ID, but not both.SearchGameSessionsRequest.Builder filterExpression(String filterExpression)
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
, creationTimeMillis
, playerSessionCount
,
maximumSessions
, hasAvailablePlayerSessions
.
Comparator -- Valid comparators are: =
, <>
, <
,
>
, <=
, >=
.
Value -- Value to be searched for. Values can be numbers, boolean values (true/false) or strings.
String values are case sensitive, 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"
.
filterExpression
- 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
, creationTimeMillis
, playerSessionCount
,
maximumSessions
, hasAvailablePlayerSessions
.
Comparator -- Valid comparators are: =
, <>
, <
,
>
, <=
, >=
.
Value -- Value to be searched for. Values can be numbers, boolean values (true/false) or
strings. String values are case sensitive, 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"
.
SearchGameSessionsRequest.Builder sortExpression(String sortExpression)
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
, creationTimeMillis
, playerSessionCount
,
maximumSessions
, 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.
sortExpression
- 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
, creationTimeMillis
, playerSessionCount
,
maximumSessions
, 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.
SearchGameSessionsRequest.Builder limit(Integer limit)
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.
limit
- 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.SearchGameSessionsRequest.Builder nextToken(String 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.
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.SearchGameSessionsRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)
AwsRequest.Builder
requestOverrideConfig
in interface AwsRequest.Builder
awsRequestOverrideConfig
- The override configuration.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.