com.amazonaws.services.ec2.model

Class DescribeSpotInstanceRequestsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.DescribeSpotInstanceRequestsRequest

All Implemented Interfaces:

DryRunSupportedRequest<DescribeSpotInstanceRequestsRequest>, Serializable

public class DescribeSpotInstanceRequestsRequest
extends AmazonWebServiceRequest
implements Serializable, DryRunSupportedRequest<DescribeSpotInstanceRequestsRequest>

Container for the parameters to the DescribeSpotInstanceRequests operation.

Describes Spot Instance requests. Spot Instances are instances that Amazon EC2 starts on your behalf when the maximum price that you specify exceeds the current Spot Price. Amazon EC2 periodically sets the Spot Price based on available Spot Instance capacity and current spot instance requests. For conceptual information about Spot Instances, refer to the Amazon Elastic Compute Cloud Developer Guide or Amazon Elastic Compute Cloud User Guide .

You can filter the results to return information only about Spot Instance requests that match criteria you specify. For example, you could get information about requests where the Spot Price you specified is a certain value (you can't use greater than or less than comparison, but you can use * and ? wildcards). You can specify multiple values for a filter. A Spot Instance request must match at least one of the specified values for it to be included in the results.

You can specify multiple filters (e.g., the Spot Price is equal to a particular value, and the instance type is m1.small ). The result includes information for a particular request only if it matches all your filters. If there's no match, no special message is returned; the response is simply empty.

You can use wildcards with the filter values: an asterisk matches zero or more characters, and ? matches exactly one character. You can escape special characters using a backslash before the character. For example, a value of \*amazon\?\\ searches for the literal string *amazon?\ .

See Also:

AmazonEC2.describeSpotInstanceRequests(DescribeSpotInstanceRequestsRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
DescribeSpotInstanceRequestsRequest()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
Request<DescribeSpotInstanceRequestsRequest>	getDryRunRequest() This method is intended for internal use only.
List<Filter>	getFilters() A list of filters used to match properties for SpotInstances.
List<String>	getSpotInstanceRequestIds() The ID of the request.
int	hashCode()
void	setFilters(Collection<Filter> filters) A list of filters used to match properties for SpotInstances.
void	setSpotInstanceRequestIds(Collection<String> spotInstanceRequestIds) The ID of the request.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeSpotInstanceRequestsRequest	withFilters(Collection<Filter> filters) A list of filters used to match properties for SpotInstances.
DescribeSpotInstanceRequestsRequest	withFilters(Filter... filters) A list of filters used to match properties for SpotInstances.
DescribeSpotInstanceRequestsRequest	withSpotInstanceRequestIds(Collection<String> spotInstanceRequestIds) The ID of the request.
DescribeSpotInstanceRequestsRequest	withSpotInstanceRequestIds(String... spotInstanceRequestIds) The ID of the request.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeSpotInstanceRequestsRequest

public DescribeSpotInstanceRequestsRequest()

Method Detail

getSpotInstanceRequestIds

public List<String> getSpotInstanceRequestIds()

The ID of the request.

Returns:

The ID of the request.

setSpotInstanceRequestIds

public void setSpotInstanceRequestIds(Collection<String> spotInstanceRequestIds)

The ID of the request.

Parameters:

spotInstanceRequestIds - The ID of the request.

withSpotInstanceRequestIds

public DescribeSpotInstanceRequestsRequest withSpotInstanceRequestIds(String... spotInstanceRequestIds)

The ID of the request.

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

Parameters:

spotInstanceRequestIds - The ID of the request.

Returns:

A reference to this updated object so that method calls can be chained together.

withSpotInstanceRequestIds

public DescribeSpotInstanceRequestsRequest withSpotInstanceRequestIds(Collection<String> spotInstanceRequestIds)

The ID of the request.

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

Parameters:

spotInstanceRequestIds - The ID of the request.

Returns:

A reference to this updated object so that method calls can be chained together.

getFilters

public List<Filter> getFilters()

A list of filters used to match properties for SpotInstances. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

Returns:

A list of filters used to match properties for SpotInstances. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

setFilters

public void setFilters(Collection<Filter> filters)

A list of filters used to match properties for SpotInstances. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

Parameters:

filters - A list of filters used to match properties for SpotInstances. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

withFilters

public DescribeSpotInstanceRequestsRequest withFilters(Filter... filters)

A list of filters used to match properties for SpotInstances. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

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

Parameters:

filters - A list of filters used to match properties for SpotInstances. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

Returns:

A reference to this updated object so that method calls can be chained together.

withFilters

public DescribeSpotInstanceRequestsRequest withFilters(Collection<Filter> filters)

A list of filters used to match properties for SpotInstances. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

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

Parameters:

filters - A list of filters used to match properties for SpotInstances. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

Returns:

A reference to this updated object so that method calls can be chained together.

getDryRunRequest

public Request<DescribeSpotInstanceRequestsRequest> getDryRunRequest()

This method is intended for internal use only. Returns the marshaled request configured with additional parameters to enable operation dry-run.

Specified by:

getDryRunRequest in interface DryRunSupportedRequest<DescribeSpotInstanceRequestsRequest>

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object