@Generated(value="software.amazon.awssdk:codegen") public final class SearchGameSessionsRequest extends GameLiftRequest implements ToCopyableBuilder<SearchGameSessionsRequest.Builder,SearchGameSessionsRequest>
Represents the input for a request action.
Modifier and Type | Class and Description |
---|---|
static interface |
SearchGameSessionsRequest.Builder |
Modifier and Type | Method and Description |
---|---|
String |
aliasId()
Unique identifier for an alias associated with the fleet to search for active game sessions.
|
static SearchGameSessionsRequest.Builder |
builder() |
boolean |
equals(Object obj) |
String |
filterExpression()
String containing the search criteria for the session search.
|
String |
fleetId()
Unique identifier for a fleet to search for active game sessions.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
Integer |
limit()
Maximum number of results to return.
|
String |
nextToken()
Token that indicates the start of the next sequential page of results.
|
static Class<? extends SearchGameSessionsRequest.Builder> |
serializableBuilderClass() |
String |
sortExpression()
Instructions on how to sort the search results.
|
SearchGameSessionsRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
overrideConfiguration
copy
public 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.
public 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.
public 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"
.
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"
.
public 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.
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.
public 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.
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.public 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.
public SearchGameSessionsRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<SearchGameSessionsRequest.Builder,SearchGameSessionsRequest>
toBuilder
in class GameLiftRequest
public static SearchGameSessionsRequest.Builder builder()
public static Class<? extends SearchGameSessionsRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.