All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribePlayerSessionsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable 

See Also:

AWS API Documentation, Serialized Form

• Field Summary

  • Fields inherited from class com.amazonaws.AmazonWebServiceRequest

    NOOP

• Constructor Summary

  Constructors

  Constructor and Description
  DescribePlayerSessionsRequest ()

• Method Summary

  All Methods

  Modifier and Type	Method and Description
  DescribePlayerSessionsRequest	clone () Creates a shallow clone of this object for all fields except the handler context.
  boolean	equals (Object obj)
  String	getGameSessionId () A unique identifier for the game session to retrieve player sessions for.
  Integer	getLimit () The maximum number of results to return.
  String	getNextToken () A token that indicates the start of the next sequential page of results.
  String	getPlayerId () A unique identifier for a player to retrieve player sessions for.
  String	getPlayerSessionId () A unique identifier for a player session to retrieve.
  String	getPlayerSessionStatusFilter () Player session status to filter results on.
  int	hashCode ()
  void	setGameSessionId (String gameSessionId) A unique identifier for the game session to retrieve player sessions for.
  void	setLimit (Integer limit) The maximum number of results to return.
  void	setNextToken (String nextToken) A token that indicates the start of the next sequential page of results.
  void	setPlayerId (String playerId) A unique identifier for a player to retrieve player sessions for.
  void	setPlayerSessionId (String playerSessionId) A unique identifier for a player session to retrieve.
  void	setPlayerSessionStatusFilter (String playerSessionStatusFilter) Player session status to filter results on.
  String	toString () Returns a string representation of this object.
  DescribePlayerSessionsRequest	withGameSessionId (String gameSessionId) A unique identifier for the game session to retrieve player sessions for.
  DescribePlayerSessionsRequest	withLimit (Integer limit) The maximum number of results to return.
  DescribePlayerSessionsRequest	withNextToken (String nextToken) A token that indicates the start of the next sequential page of results.
  DescribePlayerSessionsRequest	withPlayerId (String playerId) A unique identifier for a player to retrieve player sessions for.
  DescribePlayerSessionsRequest	withPlayerSessionId (String playerSessionId) A unique identifier for a player session to retrieve.
  DescribePlayerSessionsRequest	withPlayerSessionStatusFilter (String playerSessionStatusFilter) Player session status to filter results on.

  • Methods inherited from class com.amazonaws.AmazonWebServiceRequest

    addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

  • Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

• Constructor Detail

  • DescribePlayerSessionsRequest

    public DescribePlayerSessionsRequest()

• Method Detail

  • setGameSessionId

    public void setGameSessionId(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.

  • getGameSessionId

    public String getGameSessionId()

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

    Returns:

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

  • withGameSessionId

    public DescribePlayerSessionsRequest withGameSessionId(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.

  • setPlayerId

    public void setPlayerId(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.

  • getPlayerId

    public String getPlayerId()

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

    Returns:

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

  • withPlayerId

    public DescribePlayerSessionsRequest withPlayerId(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.

  • setPlayerSessionId

    public void setPlayerSessionId(String playerSessionId)

    A unique identifier for a player session to retrieve.

    Parameters:

    playerSessionId - A unique identifier for a player session to retrieve.

  • getPlayerSessionId

    public String getPlayerSessionId()

    A unique identifier for a player session to retrieve.

    Returns:

    A unique identifier for a player session to retrieve.

  • withPlayerSessionId

    public DescribePlayerSessionsRequest withPlayerSessionId(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.

  • setPlayerSessionStatusFilter

    public void setPlayerSessionStatusFilter(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).

  • getPlayerSessionStatusFilter

    public String getPlayerSessionStatusFilter()

    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:

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

  • withPlayerSessionStatusFilter

    public DescribePlayerSessionsRequest withPlayerSessionStatusFilter(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.

  • setLimit

    public void setLimit(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.

  • getLimit

    public Integer getLimit()

    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:

    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.

  • withLimit

    public DescribePlayerSessionsRequest withLimit(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.

  • setNextToken

    public void setNextToken(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.

  • getNextToken

    public String getNextToken()

    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:

    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.

  • withNextToken

    public DescribePlayerSessionsRequest withNextToken(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.

  • toString

    public 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

    Returns:

    A string representation of this object.

    See Also:

    Object.toString()

  • equals

    public boolean equals(Object obj)

    Overrides:

    equals in class Object

  • hashCode

    public int hashCode()

    Overrides:

    hashCode in class Object

  • clone

    public DescribePlayerSessionsRequest clone()

    Description copied from class: AmazonWebServiceRequest
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

    Overrides:

    clone in class AmazonWebServiceRequest

    See Also:

    Object.clone()