com.amazonaws.services.gamelift.model

Class DescribeGameSessionsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.gamelift.model.DescribeGameSessionsRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DescribeGameSessionsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Represents the input for a request action.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeGameSessionsRequest()

Method Summary

Modifier and Type	Method and Description
DescribeGameSessionsRequest	clone()
boolean	equals(Object obj)
String	getAliasId() Unique identifier for a fleet alias.
String	getFleetId() Unique identifier for a fleet.
String	getGameSessionId() Unique identifier for the game session to retrieve information on.
Integer	getLimit() Maximum number of results to return.
String	getNextToken() Token indicating the start of the next sequential page of results.
String	getStatusFilter() Game session status to filter results on.
int	hashCode()
void	setAliasId(String aliasId) Unique identifier for a fleet alias.
void	setFleetId(String fleetId) Unique identifier for a fleet.
void	setGameSessionId(String gameSessionId) Unique identifier for the game session to retrieve information on.
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	setStatusFilter(String statusFilter) Game session status to filter results on.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeGameSessionsRequest	withAliasId(String aliasId) Unique identifier for a fleet alias.
DescribeGameSessionsRequest	withFleetId(String fleetId) Unique identifier for a fleet.
DescribeGameSessionsRequest	withGameSessionId(String gameSessionId) Unique identifier for the game session to retrieve information on.
DescribeGameSessionsRequest	withLimit(Integer limit) Maximum number of results to return.
DescribeGameSessionsRequest	withNextToken(String nextToken) Token indicating the start of the next sequential page of results.
DescribeGameSessionsRequest	withStatusFilter(String statusFilter) Game 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

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

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 the game session to retrieve information on. 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 auto-generated string.

Parameters:

gameSessionId - Unique identifier for the game session to retrieve information on. 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 auto-generated string.

getGameSessionId

public String getGameSessionId()

Unique identifier for the game session to retrieve information on. 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 auto-generated string.

Returns:

Unique identifier for the game session to retrieve information on. 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 auto-generated string.

withGameSessionId

public DescribeGameSessionsRequest withGameSessionId(String gameSessionId)

Unique identifier for the game session to retrieve information on. 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 auto-generated string.

Parameters:

gameSessionId - Unique identifier for the game session to retrieve information on. 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 auto-generated string.

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 statuses include ACTIVE, TERMINATED, ACTIVATING, and TERMINATING (the last two are transitory).

Parameters:

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

Returns:

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

Parameters:

statusFilter - Game session status to filter results on. Possible game session statuses 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. Use this parameter with NextToken to get results as a set of sequential pages.

Parameters:

limit - Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

getLimit

public Integer getLimit()

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

Returns:

Maximum number of results to return. 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. Use this parameter with NextToken to get results as a set of sequential pages.

Parameters:

limit - Maximum number of results to return. 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()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public DescribeGameSessionsRequest clone()

Overrides:

clone in class AmazonWebServiceRequest