Class SearchGameSessionsRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<SearchGameSessionsRequest.Builder,
SearchGameSessionsRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
aliasId()
A unique identifier for the alias associated with the fleet to search for active game sessions.builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
String containing the search criteria for the session search.final String
fleetId()
A unique identifier for the fleet to search for active game sessions.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final Integer
limit()
The maximum number of results to return.final String
location()
A fleet location to search for game sessions.final String
A token that indicates the start of the next sequential page of results.static Class
<? extends SearchGameSessionsRequest.Builder> final String
Instructions on how to sort the search results.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
fleetId
A unique identifier for the 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.
- Returns:
- A unique identifier for the 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.
-
aliasId
A unique identifier for the 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.
- Returns:
- A unique identifier for the 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.
-
location
A fleet location to search for game sessions. You can specify a fleet's home Region or a remote location. Use the Amazon Web Services Region code format, such as
us-west-2
.- Returns:
- A fleet location to search for game sessions. You can specify a fleet's home Region or a remote location.
Use the Amazon Web Services Region code format, such as
us-west-2
.
-
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
,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 ongameSessionName
: "FilterExpression": "gameSessionName = 'Matt\\'s Awesome Game 1'"
.
To chain multiple conditions in a single expression, use the logical keywords
AND
,OR
, andNOT
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"
.- Returns:
- 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 ongameSessionName
: "FilterExpression": "gameSessionName = 'Matt\\'s Awesome Game 1'"
.
To chain multiple conditions in a single expression, use the logical keywords
AND
,OR
, andNOT
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"
. -
-
-
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
,gameSessionProperties
,maximumSessions
,creationTimeMillis
,playerSessionCount
,hasAvailablePlayerSessions
. -
Order -- Valid sort orders are
ASC
(ascending) andDESC
(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.- Returns:
- 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) andDESC
(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. -
-
-
limit
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.- Returns:
- 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.
-
nextToken
A 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.
- Returns:
- A 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.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<SearchGameSessionsRequest.Builder,
SearchGameSessionsRequest> - Specified by:
toBuilder
in classGameLiftRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-