com.amazonaws.services.gamelift.model

Class DescribeInstancesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.gamelift.model.DescribeInstancesRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Method Summary

Modifier and Type	Method and Description
DescribeInstancesRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getFleetId() A unique identifier for the fleet to retrieve instance information for.
String	getInstanceId() A unique identifier for an instance to retrieve.
Integer	getLimit() The maximum number of results to return.
String	getLocation() The name of a location to retrieve instance information for, in the form of an Amazon Web Services Region code such as us-west-2.
String	getNextToken() A token that indicates the start of the next sequential page of results.
int	hashCode()
void	setFleetId(String fleetId) A unique identifier for the fleet to retrieve instance information for.
void	setInstanceId(String instanceId) A unique identifier for an instance to retrieve.
void	setLimit(Integer limit) The maximum number of results to return.
void	setLocation(String location) The name of a location to retrieve instance information for, in the form of an Amazon Web Services Region code such as us-west-2.
void	setNextToken(String nextToken) A token that indicates the start of the next sequential page of results.
String	toString() Returns a string representation of this object.
DescribeInstancesRequest	withFleetId(String fleetId) A unique identifier for the fleet to retrieve instance information for.
DescribeInstancesRequest	withInstanceId(String instanceId) A unique identifier for an instance to retrieve.
DescribeInstancesRequest	withLimit(Integer limit) The maximum number of results to return.
DescribeInstancesRequest	withLocation(String location) The name of a location to retrieve instance information for, in the form of an Amazon Web Services Region code such as us-west-2.
DescribeInstancesRequest	withNextToken(String nextToken) A token that indicates the start of the next sequential page 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

DescribeInstancesRequest

public DescribeInstancesRequest()

Method Detail

setFleetId

public void setFleetId(String fleetId)

A unique identifier for the fleet to retrieve instance information for. You can use either the fleet ID or ARN value.

Parameters:

fleetId - A unique identifier for the fleet to retrieve instance information for. You can use either the fleet ID or ARN value.

getFleetId

public String getFleetId()

A unique identifier for the fleet to retrieve instance information for. You can use either the fleet ID or ARN value.

Returns:

A unique identifier for the fleet to retrieve instance information for. You can use either the fleet ID or ARN value.

withFleetId

public DescribeInstancesRequest withFleetId(String fleetId)

A unique identifier for the fleet to retrieve instance information for. You can use either the fleet ID or ARN value.

Parameters:

fleetId - A unique identifier for the fleet to retrieve instance information 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.

setInstanceId

public void setInstanceId(String instanceId)

A unique identifier for an instance to retrieve. Specify an instance ID or leave blank to retrieve all instances in the fleet.

Parameters:

instanceId - A unique identifier for an instance to retrieve. Specify an instance ID or leave blank to retrieve all instances in the fleet.

getInstanceId

public String getInstanceId()

A unique identifier for an instance to retrieve. Specify an instance ID or leave blank to retrieve all instances in the fleet.

Returns:

A unique identifier for an instance to retrieve. Specify an instance ID or leave blank to retrieve all instances in the fleet.

withInstanceId

public DescribeInstancesRequest withInstanceId(String instanceId)

A unique identifier for an instance to retrieve. Specify an instance ID or leave blank to retrieve all instances in the fleet.

Parameters:

instanceId - A unique identifier for an instance to retrieve. Specify an instance ID or leave blank to retrieve all instances in the fleet.

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

setLocation

public void setLocation(String location)

The name of a location to retrieve instance information for, in the form of an Amazon Web Services Region code such as us-west-2.

Parameters:

location - The name of a location to retrieve instance information for, in the form of an Amazon Web Services Region code such as us-west-2.

getLocation

public String getLocation()

The name of a location to retrieve instance information for, in the form of an Amazon Web Services Region code such as us-west-2.

Returns:

The name of a location to retrieve instance information for, in the form of an Amazon Web Services Region code such as us-west-2.

withLocation

public DescribeInstancesRequest withLocation(String location)

The name of a location to retrieve instance information for, in the form of an Amazon Web Services Region code such as us-west-2.

Parameters:

location - The name of a location to retrieve instance information for, in the form of an Amazon Web Services Region code such as us-west-2.

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 DescribeInstancesRequest 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()