com.amazonaws.services.gamelift.model

Class DescribeGameSessionsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.gamelift.model.DescribeGameSessionsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeGameSessionsRequest
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
DescribeGameSessionsRequest()

Method Summary

Modifier and Type	Method and Description
DescribeGameSessionsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAliasId() A unique identifier for an alias associated with the fleet to retrieve all game sessions for.
String	getFleetId() A unique identifier for a fleet to retrieve all game sessions for.
String	getGameSessionId() A unique identifier for the game session to retrieve.
Integer	getLimit() The maximum number of results to return.
String	getNextToken() Token that indicates the start of the next sequential page of results.
String	getStatusFilter() Game session status to filter results on.
int	hashCode()
void	setAliasId(String aliasId) A unique identifier for an alias associated with the fleet to retrieve all game sessions for.
void	setFleetId(String fleetId) A unique identifier for a fleet to retrieve all game sessions for.
void	setGameSessionId(String gameSessionId) A unique identifier for the game session to retrieve.
void	setLimit(Integer limit) The maximum number of results to return.
void	setNextToken(String nextToken) Token that indicates 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.
DescribeGameSessionsRequest	withAliasId(String aliasId) A unique identifier for an alias associated with the fleet to retrieve all game sessions for.
DescribeGameSessionsRequest	withFleetId(String fleetId) A unique identifier for a fleet to retrieve all game sessions for.
DescribeGameSessionsRequest	withGameSessionId(String gameSessionId) A unique identifier for the game session to retrieve.
DescribeGameSessionsRequest	withLimit(Integer limit) The maximum number of results to return.
DescribeGameSessionsRequest	withNextToken(String nextToken) Token that indicates 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

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

DescribeGameSessionsRequest

public DescribeGameSessionsRequest()

Method Detail

setFleetId

public void setFleetId(String fleetId)

A unique identifier for a fleet to retrieve all game sessions for. You can use either the fleet ID or ARN value.

Parameters:

fleetId - A unique identifier for a fleet to retrieve all game sessions for. You can use either the fleet ID or ARN value.

getFleetId

public String getFleetId()

A unique identifier for a fleet to retrieve all game sessions for. You can use either the fleet ID or ARN value.

Returns:

A unique identifier for a fleet to retrieve all game sessions for. You can use either the fleet ID or ARN value.

withFleetId

public DescribeGameSessionsRequest withFleetId(String fleetId)

A unique identifier for a fleet to retrieve all game sessions for. You can use either the fleet ID or ARN value.

Parameters:

fleetId - A unique identifier for a fleet to retrieve all game sessions for. You can use either the fleet ID or ARN value.

Returns:

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

setGameSessionId

public void setGameSessionId(String gameSessionId)

A unique identifier for the game session to retrieve.

Parameters:

gameSessionId - A unique identifier for the game session to retrieve.

getGameSessionId

public String getGameSessionId()

A unique identifier for the game session to retrieve.

Returns:

A unique identifier for the game session to retrieve.

withGameSessionId

public DescribeGameSessionsRequest withGameSessionId(String gameSessionId)

A unique identifier for the game session to retrieve.

Parameters:

gameSessionId - A unique identifier for the game session to retrieve.

Returns:

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

setAliasId

public void setAliasId(String aliasId)

A unique identifier for an alias associated with the fleet to retrieve all game sessions for. You can use either the alias ID or ARN value.

Parameters:

aliasId - A unique identifier for an alias associated with the fleet to retrieve all game sessions for. You can use either the alias ID or ARN value.

getAliasId

public String getAliasId()

A unique identifier for an alias associated with the fleet to retrieve all game sessions for. You can use either the alias ID or ARN value.

Returns:

A unique identifier for an alias associated with the fleet to retrieve all game sessions for. You can use either the alias ID or ARN value.

withAliasId

public DescribeGameSessionsRequest withAliasId(String aliasId)

A unique identifier for an alias associated with the fleet to retrieve all game sessions for. You can use either the alias ID or ARN value.

Parameters:

aliasId - A unique identifier for an alias associated with the fleet to retrieve all game sessions for. You can use either the alias ID or ARN value.

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)

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

Parameters:

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

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.

Returns:

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

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

Parameters:

limit - The 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 that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

Parameters:

nextToken - Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

getNextToken

public String getNextToken()

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

Returns:

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

withNextToken

public DescribeGameSessionsRequest withNextToken(String nextToken)

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

Parameters:

nextToken - Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning 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. 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 DescribeGameSessionsRequest 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()