Class DescribeGameSessionsRequest

    • Constructor Detail

      • DescribeGameSessionsRequest

        public DescribeGameSessionsRequest()
    • Method Detail

      • setFleetId

        public void setFleetId​(String fleetId)

        Unique identifier for a fleet. Specify a fleet to retrieve information on all game sessions active on the fleet.

        Parameters:
        fleetId - Unique identifier for a fleet. Specify a fleet to retrieve information on all game sessions active on the fleet.
      • getFleetId

        public String getFleetId()

        Unique identifier for a fleet. Specify a fleet to retrieve information on all game sessions active on the fleet.

        Returns:
        Unique identifier for a fleet. Specify a fleet to retrieve information on all game sessions active on the fleet.
      • withFleetId

        public DescribeGameSessionsRequest withFleetId​(String fleetId)

        Unique identifier for a fleet. Specify a fleet to retrieve information on all game sessions active on the fleet.

        Parameters:
        fleetId - Unique identifier for a fleet. Specify a fleet to retrieve information on all game sessions active on the fleet.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setGameSessionId

        public void setGameSessionId​(String gameSessionId)

        Unique identifier for a game session. Specify the game session to retrieve information on.

        Parameters:
        gameSessionId - Unique identifier for a game session. Specify the game session to retrieve information on.
      • getGameSessionId

        public String getGameSessionId()

        Unique identifier for a game session. Specify the game session to retrieve information on.

        Returns:
        Unique identifier for a game session. Specify the game session to retrieve information on.
      • withGameSessionId

        public DescribeGameSessionsRequest withGameSessionId​(String gameSessionId)

        Unique identifier for a game session. Specify the game session to retrieve information on.

        Parameters:
        gameSessionId - Unique identifier for a game session. Specify the game session to retrieve information on.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setAliasId

        public void setAliasId​(String aliasId)

        Unique identifier for a fleet alias. Specify an alias to retrieve information on all game sessions active on the fleet.

        Parameters:
        aliasId - Unique identifier for a fleet alias. Specify an alias to retrieve information on all game sessions active on the fleet.
      • getAliasId

        public String getAliasId()

        Unique identifier for a fleet alias. Specify an alias to retrieve information on all game sessions active on the fleet.

        Returns:
        Unique identifier for a fleet alias. Specify an alias to retrieve information on all game sessions active on the fleet.
      • withAliasId

        public DescribeGameSessionsRequest withAliasId​(String aliasId)

        Unique identifier for a fleet alias. Specify an alias to retrieve information on all game sessions active on the fleet.

        Parameters:
        aliasId - Unique identifier for a fleet alias. Specify an alias to retrieve information on all game sessions active on the fleet.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setStatusFilter

        public void setStatusFilter​(String statusFilter)

        Game session status to filter results on. Possible game session states include ACTIVE, TERMINATED, ACTIVATING and TERMINATING (the last two are transitory).

        Parameters:
        statusFilter - Game session status to filter results on. Possible game session states include ACTIVE, TERMINATED, ACTIVATING and TERMINATING (the last two are transitory).
      • getStatusFilter

        public String getStatusFilter()

        Game session status to filter results on. Possible game session states include ACTIVE, TERMINATED, ACTIVATING and TERMINATING (the last two are transitory).

        Returns:
        Game session status to filter results on. Possible game session states include ACTIVE, TERMINATED, ACTIVATING and TERMINATING (the last two are transitory).
      • withStatusFilter

        public DescribeGameSessionsRequest withStatusFilter​(String statusFilter)

        Game session status to filter results on. Possible game session states include ACTIVE, TERMINATED, ACTIVATING and TERMINATING (the last two are transitory).

        Parameters:
        statusFilter - Game session status to filter results on. Possible game session states include ACTIVE, TERMINATED, ACTIVATING and TERMINATING (the last two are transitory).
        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.

        Parameters:
        limit - Maximum number of results to return. You can use this parameter with NextToken to get results as a set of sequential pages.
      • 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.

        Returns:
        Maximum number of results to return. You can use this parameter with NextToken to get results as a set of sequential pages.
      • withLimit

        public DescribeGameSessionsRequest 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.

        Parameters:
        limit - Maximum number of results to return. You can use this parameter with NextToken to get results as a set of sequential pages.
        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.

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

        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.
      • withNextToken

        public DescribeGameSessionsRequest 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.

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