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

Methods

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 a game session.
Integer	getLimit() Maximum number of results to return.
String	getNextToken() Token indicating the start of the next sequential page of results.
String	getStatusFilter() Indicate a 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 a game session.
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) Indicate a 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 a game session.
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) Indicate a game session status to filter results on.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, 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 only one fleet ID, alias ID or game session ID.

Parameters:

fleetId - Unique identifier for a fleet. Specify only one fleet ID, alias ID or game session ID.

getFleetId

public String getFleetId()

Unique identifier for a fleet. Specify only one fleet ID, alias ID or game session ID.

Returns:

Unique identifier for a fleet. Specify only one fleet ID, alias ID or game session ID.

withFleetId

public DescribeGameSessionsRequest withFleetId(String fleetId)

Unique identifier for a fleet. Specify only one fleet ID, alias ID or game session ID.

Parameters:

fleetId - Unique identifier for a fleet. Specify only one fleet ID, alias ID or game session ID.

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 only one fleet ID, alias ID or game session ID.

Parameters:

gameSessionId - Unique identifier for a game session. Specify only one fleet ID, alias ID or game session ID.

getGameSessionId

public String getGameSessionId()

Unique identifier for a game session. Specify only one fleet ID, alias ID or game session ID.

Returns:

Unique identifier for a game session. Specify only one fleet ID, alias ID or game session ID.

withGameSessionId

public DescribeGameSessionsRequest withGameSessionId(String gameSessionId)

Unique identifier for a game session. Specify only one fleet ID, alias ID or game session ID.

Parameters:

gameSessionId - Unique identifier for a game session. Specify only one fleet ID, alias ID or game session ID.

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 only one fleet ID, alias ID or game session ID.

Parameters:

aliasId - Unique identifier for a fleet alias. Specify only one fleet ID, alias ID or game session ID.

getAliasId

public String getAliasId()

Unique identifier for a fleet alias. Specify only one fleet ID, alias ID or game session ID.

Returns:

Unique identifier for a fleet alias. Specify only one fleet ID, alias ID or game session ID.

withAliasId

public DescribeGameSessionsRequest withAliasId(String aliasId)

Unique identifier for a fleet alias. Specify only one fleet ID, alias ID or game session ID.

Parameters:

aliasId - Unique identifier for a fleet alias. Specify only one fleet ID, alias ID or game session ID.

Returns:

Returns a reference to this object so that method calls can be chained together.

setStatusFilter

public void setStatusFilter(String statusFilter)

Indicate a game session status to filter results on. (Note: ACTIVATING and TERMINATING are short-term transitory states only.)

Parameters:

statusFilter - Indicate a game session status to filter results on. (Note: ACTIVATING and TERMINATING are short-term transitory states only.)

getStatusFilter

public String getStatusFilter()

Indicate a game session status to filter results on. (Note: ACTIVATING and TERMINATING are short-term transitory states only.)

Returns:

Indicate a game session status to filter results on. (Note: ACTIVATING and TERMINATING are short-term transitory states only.)

withStatusFilter

public DescribeGameSessionsRequest withStatusFilter(String statusFilter)

Indicate a game session status to filter results on. (Note: ACTIVATING and TERMINATING are short-term transitory states only.)

Parameters:

statusFilter - Indicate a game session status to filter results on. (Note: ACTIVATING and TERMINATING are short-term transitory states only.)

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. A token is returned any time there may be additional results to be retrieved. To start at the beginning of a result set, do not set this parameter.

Parameters:

nextToken - Token indicating the start of the next sequential page of results. A token is returned any time there may be additional results to be retrieved. To start at the beginning of a result set, do not set this parameter.

getNextToken

public String getNextToken()

Token indicating the start of the next sequential page of results. A token is returned any time there may be additional results to be retrieved. To start at the beginning of a result set, do not set this parameter.

Returns:

Token indicating the start of the next sequential page of results. A token is returned any time there may be additional results to be retrieved. To start at the beginning of a result set, do not set this parameter.

withNextToken

public DescribeGameSessionsRequest withNextToken(String nextToken)

Token indicating the start of the next sequential page of results. A token is returned any time there may be additional results to be retrieved. To start at the beginning of a result set, do not set this parameter.

Parameters:

nextToken - Token indicating the start of the next sequential page of results. A token is returned any time there may be additional results to be retrieved. To start at the beginning of a result set, do not set this parameter.

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