Class ListInstancesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.elasticmapreduce.model.ListInstancesRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class ListInstancesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

This input determines which instances to list.

See Also:

• Serialized Form

Field Summary

Fields inherited from class AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor	Description
ListInstancesRequest()

Method Summary

Modifier and Type	Method	Description
ListInstancesRequest	clone()	Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getClusterId()	The identifier of the cluster for which to list the instances.
String	getInstanceGroupId()	The identifier of the instance group for which to list the instances.
List<String>	getInstanceGroupTypes()	The type of instance group for which to list the instances.
List<String>	getInstanceStates()	A list of instance states that will filter the instances returned with this request.
String	getMarker()	The pagination token that indicates the next set of results to retrieve.
int	hashCode()
void	setClusterId(String clusterId)	The identifier of the cluster for which to list the instances.
void	setInstanceGroupId(String instanceGroupId)	The identifier of the instance group for which to list the instances.
void	setInstanceGroupTypes(Collection<String> instanceGroupTypes)	The type of instance group for which to list the instances.
void	setInstanceStates(Collection<String> instanceStates)	A list of instance states that will filter the instances returned with this request.
void	setMarker(String marker)	The pagination token that indicates the next set of results to retrieve.
String	toString()	Returns a string representation of this object; useful for testing and debugging.
ListInstancesRequest	withClusterId(String clusterId)	The identifier of the cluster for which to list the instances.
ListInstancesRequest	withInstanceGroupId(String instanceGroupId)	The identifier of the instance group for which to list the instances.
ListInstancesRequest	withInstanceGroupTypes(InstanceGroupType... instanceGroupTypes)	The type of instance group for which to list the instances.
ListInstancesRequest	withInstanceGroupTypes(String... instanceGroupTypes)	The type of instance group for which to list the instances.
ListInstancesRequest	withInstanceGroupTypes(Collection<String> instanceGroupTypes)	The type of instance group for which to list the instances.
ListInstancesRequest	withInstanceStates(InstanceState... instanceStates)	A list of instance states that will filter the instances returned with this request.
ListInstancesRequest	withInstanceStates(String... instanceStates)	A list of instance states that will filter the instances returned with this request.
ListInstancesRequest	withInstanceStates(Collection<String> instanceStates)	A list of instance states that will filter the instances returned with this request.
ListInstancesRequest	withMarker(String marker)	The pagination token that indicates the next set of results to retrieve.

Methods inherited from class AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ListInstancesRequest

public ListInstancesRequest()

Method Details

setClusterId

public void setClusterId(String clusterId)

The identifier of the cluster for which to list the instances.

Parameters:

clusterId - The identifier of the cluster for which to list the instances.

getClusterId

public String getClusterId()

The identifier of the cluster for which to list the instances.

Returns:

The identifier of the cluster for which to list the instances.

withClusterId

public ListInstancesRequest withClusterId(String clusterId)

The identifier of the cluster for which to list the instances.

Parameters:

clusterId - The identifier of the cluster for which to list the instances.

Returns:

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

setInstanceGroupId

public void setInstanceGroupId(String instanceGroupId)

The identifier of the instance group for which to list the instances.

Parameters:

instanceGroupId - The identifier of the instance group for which to list the instances.

getInstanceGroupId

public String getInstanceGroupId()

The identifier of the instance group for which to list the instances.

Returns:

The identifier of the instance group for which to list the instances.

withInstanceGroupId

public ListInstancesRequest withInstanceGroupId(String instanceGroupId)

The identifier of the instance group for which to list the instances.

Parameters:

instanceGroupId - The identifier of the instance group for which to list the instances.

Returns:

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

getInstanceGroupTypes

public List<String> getInstanceGroupTypes()

The type of instance group for which to list the instances.

Returns:

The type of instance group for which to list the instances.

See Also:

• InstanceGroupType

setInstanceGroupTypes

public void setInstanceGroupTypes(Collection<String> instanceGroupTypes)

The type of instance group for which to list the instances.

Parameters:

instanceGroupTypes - The type of instance group for which to list the instances.

See Also:

• InstanceGroupType

withInstanceGroupTypes

public ListInstancesRequest withInstanceGroupTypes(String... instanceGroupTypes)

The type of instance group for which to list the instances.

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

Parameters:

instanceGroupTypes - The type of instance group for which to list the instances.

Returns:

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

See Also:

• InstanceGroupType

withInstanceGroupTypes

public ListInstancesRequest withInstanceGroupTypes(Collection<String> instanceGroupTypes)

The type of instance group for which to list the instances.

Parameters:

instanceGroupTypes - The type of instance group for which to list the instances.

Returns:

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

See Also:

• InstanceGroupType

withInstanceGroupTypes

public ListInstancesRequest withInstanceGroupTypes(InstanceGroupType... instanceGroupTypes)

The type of instance group for which to list the instances.

Parameters:

instanceGroupTypes - The type of instance group for which to list the instances.

Returns:

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

See Also:

• InstanceGroupType

getInstanceStates

public List<String> getInstanceStates()

A list of instance states that will filter the instances returned with this request.

Returns:

A list of instance states that will filter the instances returned with this request.

See Also:

• InstanceState

setInstanceStates

public void setInstanceStates(Collection<String> instanceStates)

A list of instance states that will filter the instances returned with this request.

Parameters:

instanceStates - A list of instance states that will filter the instances returned with this request.

See Also:

• InstanceState

withInstanceStates

public ListInstancesRequest withInstanceStates(String... instanceStates)

A list of instance states that will filter the instances returned with this request.

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

Parameters:

instanceStates - A list of instance states that will filter the instances returned with this request.

Returns:

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

See Also:

• InstanceState

withInstanceStates

public ListInstancesRequest withInstanceStates(Collection<String> instanceStates)

A list of instance states that will filter the instances returned with this request.

Parameters:

instanceStates - A list of instance states that will filter the instances returned with this request.

Returns:

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

See Also:

• InstanceState

withInstanceStates

public ListInstancesRequest withInstanceStates(InstanceState... instanceStates)

A list of instance states that will filter the instances returned with this request.

Parameters:

instanceStates - A list of instance states that will filter the instances returned with this request.

Returns:

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

See Also:

• InstanceState

setMarker

public void setMarker(String marker)

The pagination token that indicates the next set of results to retrieve.

Parameters:

marker - The pagination token that indicates the next set of results to retrieve.

getMarker

public String getMarker()

The pagination token that indicates the next set of results to retrieve.

Returns:

The pagination token that indicates the next set of results to retrieve.

withMarker

public ListInstancesRequest withMarker(String marker)

The pagination token that indicates the next set of results to retrieve.

Parameters:

marker - The pagination token that indicates the next set of results to retrieve.

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 ListInstancesRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

• Object.clone()