Package software.amazon.awssdk.services.gamelift.model

Interface SearchGameSessionsRequest.Builder

    • Method Detail

      • fleetId

        SearchGameSessionsRequest.Builder fleetId​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • aliasId

        SearchGameSessionsRequest.Builder aliasId​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • location

        SearchGameSessionsRequest.Builder location​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • filterExpression

        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, 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:

        1. =, <>, <, >, <=, >=

        2. Parentheses

        3. NOT

        4. AND

        5. 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".

        Parameters:
        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:

        1. =, <>, <, >, <=, >=

        2. Parentheses

        3. NOT

        4. AND

        5. 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:
        Returns a reference to this object so that method calls can be chained together.

      • sortExpression

        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, 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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • limit

        SearchGameSessionsRequest.Builder limit​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • nextToken

        SearchGameSessionsRequest.Builder nextToken​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.