com.amazonaws.services.gamelift.model

Class DescribePlayerSessionsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.gamelift.model.DescribePlayerSessionsRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DescribePlayerSessionsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Represents the input for a request action.

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

Modifier and Type	Method and Description
DescribePlayerSessionsRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getGameSessionId() Unique identifier for the game session to get player sessions for.
Integer	getLimit() Maximum number of results to return.
String	getNextToken() Token indicating the start of the next sequential page of results.
String	getPlayerId() Unique identifier for a player.
String	getPlayerSessionId() Unique identifier for a player session.
String	getPlayerSessionStatusFilter() Player session status to filter results on.
int	hashCode()
void	setGameSessionId(String gameSessionId) Unique identifier for the game session to get player sessions for.
void	setLimit(Integer limit) 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.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribePlayerSessionsRequest	withGameSessionId(String gameSessionId) Unique identifier for the game session to get player sessions for.
DescribePlayerSessionsRequest	withLimit(Integer limit) Maximum number of results to return.
DescribePlayerSessionsRequest	withNextToken(String nextToken) Token indicating the start of the next sequential page of results.
DescribePlayerSessionsRequest	withPlayerId(String playerId) Unique identifier for a player.
DescribePlayerSessionsRequest	withPlayerSessionId(String playerSessionId) Unique identifier for a player session.
DescribePlayerSessionsRequest	withPlayerSessionStatusFilter(String playerSessionStatusFilter) Player session status to filter results on.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, 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)

Unique identifier for the game session to get player sessions for. Game session ID format is as follows: "arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<ID string>". The value of <ID string> is either a custom ID string (if one was specified when the game session was created) an autogenerated string.

Parameters:

gameSessionId - Unique identifier for the game session to get player sessions for. Game session ID format is as follows: "arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<ID string>". The value of <ID string> is either a custom ID string (if one was specified when the game session was created) an autogenerated string.

getGameSessionId

public String getGameSessionId()

Unique identifier for the game session to get player sessions for. Game session ID format is as follows: "arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<ID string>". The value of <ID string> is either a custom ID string (if one was specified when the game session was created) an autogenerated string.

Returns:

Unique identifier for the game session to get player sessions for. Game session ID format is as follows: "arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<ID string>". The value of <ID string> is either a custom ID string (if one was specified when the game session was created) an autogenerated string.

withGameSessionId

public DescribePlayerSessionsRequest withGameSessionId(String gameSessionId)

Unique identifier for the game session to get player sessions for. Game session ID format is as follows: "arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<ID string>". The value of <ID string> is either a custom ID string (if one was specified when the game session was created) an autogenerated string.

Parameters:

gameSessionId - Unique identifier for the game session to get player sessions for. Game session ID format is as follows: "arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<ID string>". The value of <ID string> is either a custom ID string (if one was specified when the game session was created) an autogenerated string.

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 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 time-out limit (60 seconds).

Parameters:

playerSessionStatusFilter - Player session status to filter results on.

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 time-out limit (60 seconds).

getPlayerSessionStatusFilter

public String getPlayerSessionStatusFilter()

Player session status to filter results on.

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 time-out limit (60 seconds).

Returns:

Player session status to filter results on.

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 time-out limit (60 seconds).

withPlayerSessionStatusFilter

public DescribePlayerSessionsRequest withPlayerSessionStatusFilter(String playerSessionStatusFilter)

Player session status to filter results on.

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 time-out limit (60 seconds).

Parameters:

playerSessionStatusFilter - Player session status to filter results on.

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

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 request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()