java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.gamelift.model.GameLiftRequest
    - - software.amazon.awssdk.services.gamelift.model.SearchGameSessionsRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<SearchGameSessionsRequest.Builder,SearchGameSessionsRequest>

@Generated("software.amazon.awssdk:codegen")
public final class SearchGameSessionsRequest
extends GameLiftRequest
implements ToCopyableBuilder<SearchGameSessionsRequest.Builder,SearchGameSessionsRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface SearchGameSessionsRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`aliasId()`	A unique identifier for the alias associated with the fleet to search for active game sessions.
`static SearchGameSessionsRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`filterExpression()`	String containing the search criteria for the session search.
`String`	`fleetId()`	A unique identifier for the fleet to search for active game sessions.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Integer`	`limit()`	The maximum number of results to return.
`String`	`location()`	A fleet location to search for game sessions.
`String`	`nextToken()`	A token that indicates the start of the next sequential page of results.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends SearchGameSessionsRequest.Builder>`	`serializableBuilderClass()`
`String`	`sortExpression()`	Instructions on how to sort the search results.
`SearchGameSessionsRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - fleetId
```
public final String 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
```
public final String 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
```
public final String 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
```
public final 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, 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".
    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 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".
  - sortExpression
```
public final 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, 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.
    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) 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.
  - limit
```
public final Integer 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
```
public final String 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
```
public SearchGameSessionsRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<SearchGameSessionsRequest.Builder,SearchGameSessionsRequest>
    
    Specified by:
    
    toBuilder in class GameLiftRequest
  - builder
```
public static SearchGameSessionsRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends SearchGameSessionsRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String 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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class SearchGameSessionsRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

fleetId

aliasId

location

filterExpression

sortExpression

limit

nextToken

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields