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

Interface DescribePlayerSessionsRequest.Builder

    • Method Detail

      • gameSessionId

        DescribePlayerSessionsRequest.Builder gameSessionId​(String gameSessionId)

        A unique identifier for the game session to retrieve player sessions for.

        Parameters:
        gameSessionId - A unique identifier for the game session to retrieve player sessions for.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • playerId

        DescribePlayerSessionsRequest.Builder playerId​(String playerId)

        A unique identifier for a player to retrieve player sessions for.

        Parameters:
        playerId - A unique identifier for a player to retrieve player sessions for.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • playerSessionId

        DescribePlayerSessionsRequest.Builder playerSessionId​(String playerSessionId)

        A unique identifier for a player session to retrieve.

        Parameters:
        playerSessionId - A unique identifier for a player session to retrieve.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • playerSessionStatusFilter

        DescribePlayerSessionsRequest.Builder playerSessionStatusFilter​(String playerSessionStatusFilter)

        Player session status to filter results on. Note that when a PlayerSessionId or PlayerId is provided in a DescribePlayerSessions request, then the PlayerSessionStatusFilter has no effect on the response.

        Possible player session statuses include the following:

        • RESERVED -- The player session request has been received, but the player has not yet connected to the server process and/or been validated.

        • ACTIVE -- The player has been validated by the server process and is currently connected.

        • COMPLETED -- The player connection has been dropped.

        • TIMEDOUT -- A player session request was received, but the player did not connect and/or was not validated within the timeout limit (60 seconds).

        Parameters:
        playerSessionStatusFilter - Player session status to filter results on. Note that when a PlayerSessionId or PlayerId is provided in a DescribePlayerSessions request, then the PlayerSessionStatusFilter has no effect on the response.

        Possible player session statuses include the following:

        • RESERVED -- The player session request has been received, but the player has not yet connected to the server process and/or been validated.

        • ACTIVE -- The player has been validated by the server process and is currently connected.

        • COMPLETED -- The player connection has been dropped.

        • TIMEDOUT -- A player session request was received, but the player did not connect and/or was not validated within the timeout limit (60 seconds).

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • limit

        DescribePlayerSessionsRequest.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. If a player session ID is specified, this parameter is ignored.

        Parameters:
        limit - The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. If a player session ID is specified, this parameter is ignored.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • nextToken

        DescribePlayerSessionsRequest.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. If a player session ID is specified, this parameter is ignored.

        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. If a player session ID is specified, this parameter is ignored.
        Returns:
        Returns a reference to this object so that method calls can be chained together.