Class DescribePlayerSessionsRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
Represents the input for a request action.
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
Unique identifier for a game session.getLimit()
Maximum number of results to return.Token indicating the start of the next sequential page of results.Unique identifier for a player.Unique identifier for a player session.Player session status to filter results on.int
hashCode()
void
setGameSessionId
(String gameSessionId) Unique identifier for a game session.void
Maximum number of results to return.void
setNextToken
(String nextToken) Token indicating the start of the next sequential page of results.void
setPlayerId
(String playerId) Unique identifier for a player.void
setPlayerSessionId
(String playerSessionId) Unique identifier for a player session.void
setPlayerSessionStatusFilter
(String playerSessionStatusFilter) Player session status to filter results on.toString()
Returns a string representation of this object; useful for testing and debugging.withGameSessionId
(String gameSessionId) Unique identifier for a game session.Maximum number of results to return.withNextToken
(String nextToken) Token indicating the start of the next sequential page of results.withPlayerId
(String playerId) Unique identifier for a player.withPlayerSessionId
(String playerSessionId) Unique identifier for a player session.withPlayerSessionStatusFilter
(String playerSessionStatusFilter) Player session status to filter results on.Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
Constructor Details
-
DescribePlayerSessionsRequest
public DescribePlayerSessionsRequest()
-
-
Method Details
-
setGameSessionId
Unique identifier for a game session.
- Parameters:
gameSessionId
- Unique identifier for a game session.
-
getGameSessionId
Unique identifier for a game session.
- Returns:
- Unique identifier for a game session.
-
withGameSessionId
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
Unique identifier for a player.
- Parameters:
playerId
- Unique identifier for a player.
-
getPlayerId
Unique identifier for a player.
- Returns:
- Unique identifier for a player.
-
withPlayerId
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
Unique identifier for a player session.
- Parameters:
playerSessionId
- Unique identifier for a player session.
-
getPlayerSessionId
Unique identifier for a player session.
- Returns:
- Unique identifier for a player session.
-
withPlayerSessionId
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
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
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
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
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
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
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
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
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
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
-