com.amazonaws.services.gamelift.model

Class DescribeGameServerInstancesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.gamelift.model.DescribeGameServerInstancesRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Method Summary

Modifier and Type	Method and Description
DescribeGameServerInstancesRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getGameServerGroupName() A unique identifier for the game server group.
List<String>	getInstanceIds() The EC2 instance IDs that you want to retrieve status on.
Integer	getLimit() The maximum number of results to return.
String	getNextToken() A token that indicates the start of the next sequential segment of results.
int	hashCode()
void	setGameServerGroupName(String gameServerGroupName) A unique identifier for the game server group.
void	setInstanceIds(Collection<String> instanceIds) The EC2 instance IDs that you want to retrieve status on.
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 segment of results.
String	toString() Returns a string representation of this object.
DescribeGameServerInstancesRequest	withGameServerGroupName(String gameServerGroupName) A unique identifier for the game server group.
DescribeGameServerInstancesRequest	withInstanceIds(Collection<String> instanceIds) The EC2 instance IDs that you want to retrieve status on.
DescribeGameServerInstancesRequest	withInstanceIds(String... instanceIds) The EC2 instance IDs that you want to retrieve status on.
DescribeGameServerInstancesRequest	withLimit(Integer limit) The maximum number of results to return.
DescribeGameServerInstancesRequest	withNextToken(String nextToken) A token that indicates the start of the next sequential segment of results.

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

DescribeGameServerInstancesRequest

public DescribeGameServerInstancesRequest()

Method Detail

setGameServerGroupName

public void setGameServerGroupName(String gameServerGroupName)

A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.

Parameters:

gameServerGroupName - A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.

getGameServerGroupName

public String getGameServerGroupName()

A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.

Returns:

A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.

withGameServerGroupName

public DescribeGameServerInstancesRequest withGameServerGroupName(String gameServerGroupName)

A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.

Parameters:

gameServerGroupName - A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.

Returns:

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

getInstanceIds

public List<String> getInstanceIds()

The EC2 instance IDs that you want to retrieve status on. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0. To retrieve all instances in the game server group, leave this parameter empty.

Returns:

The EC2 instance IDs that you want to retrieve status on. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0. To retrieve all instances in the game server group, leave this parameter empty.

setInstanceIds

public void setInstanceIds(Collection<String> instanceIds)

The EC2 instance IDs that you want to retrieve status on. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0. To retrieve all instances in the game server group, leave this parameter empty.

Parameters:

instanceIds - The EC2 instance IDs that you want to retrieve status on. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0. To retrieve all instances in the game server group, leave this parameter empty.

withInstanceIds

public DescribeGameServerInstancesRequest withInstanceIds(String... instanceIds)

The EC2 instance IDs that you want to retrieve status on. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0. To retrieve all instances in the game server group, leave this parameter empty.

NOTE: This method appends the values to the existing list (if any). Use setInstanceIds(java.util.Collection) or withInstanceIds(java.util.Collection) if you want to override the existing values.

Parameters:

instanceIds - The EC2 instance IDs that you want to retrieve status on. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0. To retrieve all instances in the game server group, leave this parameter empty.

Returns:

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

withInstanceIds

public DescribeGameServerInstancesRequest withInstanceIds(Collection<String> instanceIds)

The EC2 instance IDs that you want to retrieve status on. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0. To retrieve all instances in the game server group, leave this parameter empty.

Parameters:

instanceIds - The EC2 instance IDs that you want to retrieve status on. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0. To retrieve all instances in the game server group, leave this parameter empty.

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 segments.

Parameters:

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

getLimit

public Integer getLimit()

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

Returns:

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

withLimit

public DescribeGameServerInstancesRequest withLimit(Integer limit)

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

Parameters:

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

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 segment of results. Use the token returned with the 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 segment of results. Use the token returned with the 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 segment of results. Use the token returned with the 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 segment of results. Use the token returned with the previous call to this operation. To start at the beginning of the result set, do not specify a value.

withNextToken

public DescribeGameServerInstancesRequest withNextToken(String nextToken)

A token that indicates the start of the next sequential segment of results. Use the token returned with the 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 segment of results. Use the token returned with the 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 DescribeGameServerInstancesRequest 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()