com.amazonaws.services.gamelift.model

Class ListGameServersRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.gamelift.model.ListGameServersRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ListGameServersRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListGameServersRequest()

Method Summary

Modifier and Type	Method and Description
ListGameServersRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getGameServerGroupName() An identifier for the game server group to retrieve a list of game servers from.
Integer	getLimit() The maximum number of results to return.
String	getNextToken() A token that indicates the start of the next sequential page of results.
String	getSortOrder() Indicates how to sort the returned data based on game server registration timestamp.
int	hashCode()
void	setGameServerGroupName(String gameServerGroupName) An identifier for the game server group to retrieve a list of game servers from.
void	setLimit(Integer limit) The maximum number of results to return.
void	setNextToken(String nextToken) A token that indicates the start of the next sequential page of results.
void	setSortOrder(String sortOrder) Indicates how to sort the returned data based on game server registration timestamp.
String	toString() Returns a string representation of this object.
ListGameServersRequest	withGameServerGroupName(String gameServerGroupName) An identifier for the game server group to retrieve a list of game servers from.
ListGameServersRequest	withLimit(Integer limit) The maximum number of results to return.
ListGameServersRequest	withNextToken(String nextToken) A token that indicates the start of the next sequential page of results.
ListGameServersRequest	withSortOrder(SortOrder sortOrder) Indicates how to sort the returned data based on game server registration timestamp.
ListGameServersRequest	withSortOrder(String sortOrder) Indicates how to sort the returned data based on game server registration timestamp.

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

ListGameServersRequest

public ListGameServersRequest()

Method Detail

setGameServerGroupName

public void setGameServerGroupName(String gameServerGroupName)

An identifier for the game server group to retrieve a list of game servers from. Use either the name or ARN value.

Parameters:

gameServerGroupName - An identifier for the game server group to retrieve a list of game servers from. Use either the name or ARN value.

getGameServerGroupName

public String getGameServerGroupName()

An identifier for the game server group to retrieve a list of game servers from. Use either the name or ARN value.

Returns:

An identifier for the game server group to retrieve a list of game servers from. Use either the name or ARN value.

withGameServerGroupName

public ListGameServersRequest withGameServerGroupName(String gameServerGroupName)

An identifier for the game server group to retrieve a list of game servers from. Use either the name or ARN value.

Parameters:

gameServerGroupName - An identifier for the game server group to retrieve a list of game servers from. Use either the name or ARN value.

Returns:

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

setSortOrder

public void setSortOrder(String sortOrder)

Indicates how to sort the returned data based on game server registration timestamp. Use ASCENDING to retrieve oldest game servers first, or use DESCENDING to retrieve newest game servers first. If this parameter is left empty, game servers are returned in no particular order.

Parameters:

sortOrder - Indicates how to sort the returned data based on game server registration timestamp. Use ASCENDING to retrieve oldest game servers first, or use DESCENDING to retrieve newest game servers first. If this parameter is left empty, game servers are returned in no particular order.

See Also:

SortOrder

getSortOrder

public String getSortOrder()

Indicates how to sort the returned data based on game server registration timestamp. Use ASCENDING to retrieve oldest game servers first, or use DESCENDING to retrieve newest game servers first. If this parameter is left empty, game servers are returned in no particular order.

Returns:

Indicates how to sort the returned data based on game server registration timestamp. Use ASCENDING to retrieve oldest game servers first, or use DESCENDING to retrieve newest game servers first. If this parameter is left empty, game servers are returned in no particular order.

See Also:

SortOrder

withSortOrder

public ListGameServersRequest withSortOrder(String sortOrder)

Indicates how to sort the returned data based on game server registration timestamp. Use ASCENDING to retrieve oldest game servers first, or use DESCENDING to retrieve newest game servers first. If this parameter is left empty, game servers are returned in no particular order.

Parameters:

sortOrder - Indicates how to sort the returned data based on game server registration timestamp. Use ASCENDING to retrieve oldest game servers first, or use DESCENDING to retrieve newest game servers first. If this parameter is left empty, game servers are returned in no particular order.

Returns:

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

See Also:

SortOrder

withSortOrder

public ListGameServersRequest withSortOrder(SortOrder sortOrder)

Indicates how to sort the returned data based on game server registration timestamp. Use ASCENDING to retrieve oldest game servers first, or use DESCENDING to retrieve newest game servers first. If this parameter is left empty, game servers are returned in no particular order.

Parameters:

sortOrder - Indicates how to sort the returned data based on game server registration timestamp. Use ASCENDING to retrieve oldest game servers first, or use DESCENDING to retrieve newest game servers first. If this parameter is left empty, game servers are returned in no particular order.

Returns:

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

See Also:

SortOrder

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

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

Parameters:

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

getNextToken

public String getNextToken()

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

Returns:

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

withNextToken

public ListGameServersRequest withNextToken(String nextToken)

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

Parameters:

nextToken - A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. 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 ListGameServersRequest 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()