Class DescribePlayerSessionsRequest

    • Constructor Detail

      • DescribePlayerSessionsRequest

        public DescribePlayerSessionsRequest()
    • Method Detail

      • setGameSessionId

        public void setGameSessionId​(String gameSessionId)

        Unique identifier for a game session.

        Parameters:
        gameSessionId - Unique identifier for a game session.
      • getGameSessionId

        public String getGameSessionId()

        Unique identifier for a game session.

        Returns:
        Unique identifier for a game session.
      • withGameSessionId

        public DescribePlayerSessionsRequest withGameSessionId​(String gameSessionId)

        Unique identifier for a game session.

        Parameters:
        gameSessionId - Unique identifier for a game session.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setPlayerId

        public void setPlayerId​(String playerId)

        Unique identifier for a player.

        Parameters:
        playerId - Unique identifier for a player.
      • getPlayerId

        public String getPlayerId()

        Unique identifier for a player.

        Returns:
        Unique identifier for a player.
      • withPlayerId

        public DescribePlayerSessionsRequest withPlayerId​(String playerId)

        Unique identifier for a player.

        Parameters:
        playerId - Unique identifier for a player.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setPlayerSessionId

        public void setPlayerSessionId​(String playerSessionId)

        Unique identifier for a player session.

        Parameters:
        playerSessionId - Unique identifier for a player session.
      • getPlayerSessionId

        public String getPlayerSessionId()

        Unique identifier for a player session.

        Returns:
        Unique identifier for a player session.
      • withPlayerSessionId

        public DescribePlayerSessionsRequest withPlayerSessionId​(String playerSessionId)

        Unique identifier for a player session.

        Parameters:
        playerSessionId - Unique identifier for a player session.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setPlayerSessionStatusFilter

        public void setPlayerSessionStatusFilter​(String playerSessionStatusFilter)

        Player session status to filter results on. Possible player session states include:

        • RESERVED: The player session request has been received, but the player has not yet connected to the game server and/or been validated.
        • ACTIVE: The player has been validated by the game server 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 time-out limit (60 seconds).

        Parameters:
        playerSessionStatusFilter - Player session status to filter results on. Possible player session states include:
        • RESERVED: The player session request has been received, but the player has not yet connected to the game server and/or been validated.
        • ACTIVE: The player has been validated by the game server 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 time-out limit (60 seconds).
      • getPlayerSessionStatusFilter

        public String getPlayerSessionStatusFilter()

        Player session status to filter results on. Possible player session states include:

        • RESERVED: The player session request has been received, but the player has not yet connected to the game server and/or been validated.
        • ACTIVE: The player has been validated by the game server 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 time-out limit (60 seconds).

        Returns:
        Player session status to filter results on. Possible player session states include:
        • RESERVED: The player session request has been received, but the player has not yet connected to the game server and/or been validated.
        • ACTIVE: The player has been validated by the game server 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 time-out limit (60 seconds).
      • withPlayerSessionStatusFilter

        public DescribePlayerSessionsRequest withPlayerSessionStatusFilter​(String playerSessionStatusFilter)

        Player session status to filter results on. Possible player session states include:

        • RESERVED: The player session request has been received, but the player has not yet connected to the game server and/or been validated.
        • ACTIVE: The player has been validated by the game server 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 time-out limit (60 seconds).

        Parameters:
        playerSessionStatusFilter - Player session status to filter results on. Possible player session states include:
        • RESERVED: The player session request has been received, but the player has not yet connected to the game server and/or been validated.
        • ACTIVE: The player has been validated by the game server 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 time-out limit (60 seconds).
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setLimit

        public void setLimit​(Integer limit)

        Maximum number of results to return. You can 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 - Maximum number of results to return. You can 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.
      • getLimit

        public Integer getLimit()

        Maximum number of results to return. You can 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:
        Maximum number of results to return. You can 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.
      • withLimit

        public DescribePlayerSessionsRequest withLimit​(Integer limit)

        Maximum number of results to return. You can 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 - Maximum number of results to return. You can 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.
      • setNextToken

        public void setNextToken​(String nextToken)

        Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value. If a player session ID is specified, this parameter is ignored.

        Parameters:
        nextToken - Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value. If a player session ID is specified, this parameter is ignored.
      • getNextToken

        public String getNextToken()

        Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value. If a player session ID is specified, this parameter is ignored.

        Returns:
        Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value. If a player session ID is specified, this parameter is ignored.
      • withNextToken

        public DescribePlayerSessionsRequest withNextToken​(String nextToken)

        Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value. If a player session ID is specified, this parameter is ignored.

        Parameters:
        nextToken - Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start 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.
      • toString

        public String toString()
        Returns a string representation of this object; useful for testing and debugging.
        Overrides:
        toString in class Object
        Returns:
        A string representation of this object.
        See Also:
        Object.toString()
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object