RequestSpotInstancesRequest (AWS SDK for Android

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.ec2.model.RequestSpotInstancesRequest

All Implemented Interfaces:

DryRunSupportedRequest<RequestSpotInstancesRequest>, Serializable
```
public class RequestSpotInstancesRequest
extends AmazonWebServiceRequest
implements Serializable, DryRunSupportedRequest<RequestSpotInstancesRequest>
```
Container for the parameters to the RequestSpotInstances operation.
Creates a Spot Instance request. 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 more information about Spot Instances, see Spot Instances in the Amazon Elastic Compute Cloud User Guide .

See Also:
AmazonEC2.requestSpotInstances(RequestSpotInstancesRequest), Serialized Form

Constructor Summary

Constructors
Constructor and Description
`RequestSpotInstancesRequest()` Default constructor for a new RequestSpotInstancesRequest object.
`RequestSpotInstancesRequest(String spotPrice)` Constructs a new RequestSpotInstancesRequest object.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`String`	`getAvailabilityZoneGroup()` The user-specified name for a logical grouping of bids.
`Request<RequestSpotInstancesRequest>`	`getDryRunRequest()` This method is intended for internal use only.
`Integer`	`getInstanceCount()` The maximum number of Spot Instances to launch.
`String`	`getLaunchGroup()` The instance launch group.
`LaunchSpecification`	`getLaunchSpecification()` The launch specification.
`String`	`getSpotPrice()` The maximum hourly price for any Spot Instance launched to fulfill the request.
`String`	`getType()` The Spot Instance request type.
`Date`	`getValidFrom()` The start date of the request.
`Date`	`getValidUntil()` The end date of the request.
`int`	`hashCode()`
`void`	`setAvailabilityZoneGroup(String availabilityZoneGroup)` The user-specified name for a logical grouping of bids.
`void`	`setInstanceCount(Integer instanceCount)` The maximum number of Spot Instances to launch.
`void`	`setLaunchGroup(String launchGroup)` The instance launch group.
`void`	`setLaunchSpecification(LaunchSpecification launchSpecification)` The launch specification.
`void`	`setSpotPrice(String spotPrice)` The maximum hourly price for any Spot Instance launched to fulfill the request.
`void`	`setType(SpotInstanceType type)` The Spot Instance request type.
`void`	`setType(String type)` The Spot Instance request type.
`void`	`setValidFrom(Date validFrom)` The start date of the request.
`void`	`setValidUntil(Date validUntil)` The end date of the request.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`RequestSpotInstancesRequest`	`withAvailabilityZoneGroup(String availabilityZoneGroup)` The user-specified name for a logical grouping of bids.
`RequestSpotInstancesRequest`	`withInstanceCount(Integer instanceCount)` The maximum number of Spot Instances to launch.
`RequestSpotInstancesRequest`	`withLaunchGroup(String launchGroup)` The instance launch group.
`RequestSpotInstancesRequest`	`withLaunchSpecification(LaunchSpecification launchSpecification)` The launch specification.
`RequestSpotInstancesRequest`	`withSpotPrice(String spotPrice)` The maximum hourly price for any Spot Instance launched to fulfill the request.
`RequestSpotInstancesRequest`	`withType(SpotInstanceType type)` The Spot Instance request type.
`RequestSpotInstancesRequest`	`withType(String type)` The Spot Instance request type.
`RequestSpotInstancesRequest`	`withValidFrom(Date validFrom)` The start date of the request.
`RequestSpotInstancesRequest`	`withValidUntil(Date validUntil)` The end date of the request.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyPrivateRequestParameters, getDelegationToken, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setDelegationToken, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - RequestSpotInstancesRequest
```
public RequestSpotInstancesRequest()
```
    Default constructor for a new RequestSpotInstancesRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.
  - RequestSpotInstancesRequest
```
public RequestSpotInstancesRequest(String spotPrice)
```
    Constructs a new RequestSpotInstancesRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.
    
    Parameters:
    spotPrice - The maximum hourly price for any Spot Instance launched to fulfill the request.
- Method Detail
  - getSpotPrice
```
public String getSpotPrice()
```
    The maximum hourly price for any Spot Instance launched to fulfill the request.
    
    Returns:
    The maximum hourly price for any Spot Instance launched to fulfill the request.
  - setSpotPrice
```
public void setSpotPrice(String spotPrice)
```
    The maximum hourly price for any Spot Instance launched to fulfill the request.
    
    Parameters:
    spotPrice - The maximum hourly price for any Spot Instance launched to fulfill the request.
  - withSpotPrice
```
public RequestSpotInstancesRequest withSpotPrice(String spotPrice)
```
    The maximum hourly price for any Spot Instance launched to fulfill the request.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    spotPrice - The maximum hourly price for any Spot Instance launched to fulfill the request.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getInstanceCount
```
public Integer getInstanceCount()
```
    The maximum number of Spot Instances to launch.
    Default: 1
    
    Returns:
    The maximum number of Spot Instances to launch.
    Default: 1
  - setInstanceCount
```
public void setInstanceCount(Integer instanceCount)
```
    The maximum number of Spot Instances to launch.
    Default: 1
    
    Parameters:
    instanceCount - The maximum number of Spot Instances to launch.
    Default: 1
  - withInstanceCount
```
public RequestSpotInstancesRequest withInstanceCount(Integer instanceCount)
```
    The maximum number of Spot Instances to launch.
    Default: 1
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    instanceCount - The maximum number of Spot Instances to launch.
    Default: 1
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getType
```
public String getType()
```
    The Spot Instance request type.
    Default: one-time
    Constraints:
    Allowed Values: one-time, persistent
    
    Returns:
    The Spot Instance request type.
    Default: one-time
    See Also:
    SpotInstanceType
  - setType
```
public void setType(String type)
```
    The Spot Instance request type.
    Default: one-time
    Constraints:
    Allowed Values: one-time, persistent
    
    Parameters:
    type - The Spot Instance request type.
    Default: one-time
    See Also:
    SpotInstanceType
  - withType
```
public RequestSpotInstancesRequest withType(String type)
```
    The Spot Instance request type.
    Default: one-time
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: one-time, persistent
    
    Parameters:
    type - The Spot Instance request type.
    Default: one-time
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
    See Also:
    SpotInstanceType
  - setType
```
public void setType(SpotInstanceType type)
```
    The Spot Instance request type.
    Default: one-time
    Constraints:
    Allowed Values: one-time, persistent
    
    Parameters:
    type - The Spot Instance request type.
    Default: one-time
    See Also:
    SpotInstanceType
  - withType
```
public RequestSpotInstancesRequest withType(SpotInstanceType type)
```
    The Spot Instance request type.
    Default: one-time
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: one-time, persistent
    
    Parameters:
    type - The Spot Instance request type.
    Default: one-time
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
    See Also:
    SpotInstanceType
  - getValidFrom
```
public Date getValidFrom()
```
    The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.
    Default: The request is effective indefinitely.
    
    Returns:
    The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.
    Default: The request is effective indefinitely.
  - setValidFrom
```
public void setValidFrom(Date validFrom)
```
    The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.
    Default: The request is effective indefinitely.
    
    Parameters:
    validFrom - The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.
    Default: The request is effective indefinitely.
  - withValidFrom
```
public RequestSpotInstancesRequest withValidFrom(Date validFrom)
```
    The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.
    Default: The request is effective indefinitely.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    validFrom - The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.
    Default: The request is effective indefinitely.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getValidUntil
```
public Date getValidUntil()
```
    The end date of the request. If this is a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached.
    Default: The request is effective indefinitely.
    
    Returns:
    The end date of the request. If this is a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached.
    Default: The request is effective indefinitely.
  - setValidUntil
```
public void setValidUntil(Date validUntil)
```
    The end date of the request. If this is a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached.
    Default: The request is effective indefinitely.
    
    Parameters:
    validUntil - The end date of the request. If this is a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached.
    Default: The request is effective indefinitely.
  - withValidUntil
```
public RequestSpotInstancesRequest withValidUntil(Date validUntil)
```
    The end date of the request. If this is a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached.
    Default: The request is effective indefinitely.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    validUntil - The end date of the request. If this is a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached.
    Default: The request is effective indefinitely.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getLaunchGroup
```
public String getLaunchGroup()
```
    The instance launch group. Launch groups are Spot Instances that launch together and terminate together.
    Default: Instances are launched and terminated individually
    
    Returns:
    The instance launch group. Launch groups are Spot Instances that launch together and terminate together.
    Default: Instances are launched and terminated individually
  - setLaunchGroup
```
public void setLaunchGroup(String launchGroup)
```
    The instance launch group. Launch groups are Spot Instances that launch together and terminate together.
    Default: Instances are launched and terminated individually
    
    Parameters:
    launchGroup - The instance launch group. Launch groups are Spot Instances that launch together and terminate together.
    Default: Instances are launched and terminated individually
  - withLaunchGroup
```
public RequestSpotInstancesRequest withLaunchGroup(String launchGroup)
```
    The instance launch group. Launch groups are Spot Instances that launch together and terminate together.
    Default: Instances are launched and terminated individually
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    launchGroup - The instance launch group. Launch groups are Spot Instances that launch together and terminate together.
    Default: Instances are launched and terminated individually
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getAvailabilityZoneGroup
```
public String getAvailabilityZoneGroup()
```
    The user-specified name for a logical grouping of bids.
    When you specify an Availability Zone group in a Spot Instance request, all Spot Instances in the request are launched in the same Availability Zone. Instance proximity is maintained with this parameter, but the choice of Availability Zone is not. The group applies only to bids for Spot Instances of the same instance type. Any additional Spot Instance requests that are specified with the same Availability Zone group name are launched in that same Availability Zone, as long as at least one instance from the group is still active.
    If there is no active instance running in the Availability Zone group that you specify for a new Spot Instance request (all instances are terminated, the bid is expired, or the bid falls below current market), then Amazon EC2 launches the instance in any Availability Zone where the constraint can be met. Consequently, the subsequent set of Spot Instances could be placed in a different zone from the original request, even if you specified the same Availability Zone group.
    Default: Instances are launched in any available Availability Zone.
    
    Returns:
    The user-specified name for a logical grouping of bids.
    When you specify an Availability Zone group in a Spot Instance request, all Spot Instances in the request are launched in the same Availability Zone. Instance proximity is maintained with this parameter, but the choice of Availability Zone is not. The group applies only to bids for Spot Instances of the same instance type. Any additional Spot Instance requests that are specified with the same Availability Zone group name are launched in that same Availability Zone, as long as at least one instance from the group is still active.
    If there is no active instance running in the Availability Zone group that you specify for a new Spot Instance request (all instances are terminated, the bid is expired, or the bid falls below current market), then Amazon EC2 launches the instance in any Availability Zone where the constraint can be met. Consequently, the subsequent set of Spot Instances could be placed in a different zone from the original request, even if you specified the same Availability Zone group.
    Default: Instances are launched in any available Availability Zone.
  - setAvailabilityZoneGroup
```
public void setAvailabilityZoneGroup(String availabilityZoneGroup)
```
    The user-specified name for a logical grouping of bids.
    When you specify an Availability Zone group in a Spot Instance request, all Spot Instances in the request are launched in the same Availability Zone. Instance proximity is maintained with this parameter, but the choice of Availability Zone is not. The group applies only to bids for Spot Instances of the same instance type. Any additional Spot Instance requests that are specified with the same Availability Zone group name are launched in that same Availability Zone, as long as at least one instance from the group is still active.
    If there is no active instance running in the Availability Zone group that you specify for a new Spot Instance request (all instances are terminated, the bid is expired, or the bid falls below current market), then Amazon EC2 launches the instance in any Availability Zone where the constraint can be met. Consequently, the subsequent set of Spot Instances could be placed in a different zone from the original request, even if you specified the same Availability Zone group.
    Default: Instances are launched in any available Availability Zone.
    
    Parameters:
    availabilityZoneGroup - The user-specified name for a logical grouping of bids.
    When you specify an Availability Zone group in a Spot Instance request, all Spot Instances in the request are launched in the same Availability Zone. Instance proximity is maintained with this parameter, but the choice of Availability Zone is not. The group applies only to bids for Spot Instances of the same instance type. Any additional Spot Instance requests that are specified with the same Availability Zone group name are launched in that same Availability Zone, as long as at least one instance from the group is still active.
    If there is no active instance running in the Availability Zone group that you specify for a new Spot Instance request (all instances are terminated, the bid is expired, or the bid falls below current market), then Amazon EC2 launches the instance in any Availability Zone where the constraint can be met. Consequently, the subsequent set of Spot Instances could be placed in a different zone from the original request, even if you specified the same Availability Zone group.
    Default: Instances are launched in any available Availability Zone.
  - withAvailabilityZoneGroup
```
public RequestSpotInstancesRequest withAvailabilityZoneGroup(String availabilityZoneGroup)
```
    The user-specified name for a logical grouping of bids.
    When you specify an Availability Zone group in a Spot Instance request, all Spot Instances in the request are launched in the same Availability Zone. Instance proximity is maintained with this parameter, but the choice of Availability Zone is not. The group applies only to bids for Spot Instances of the same instance type. Any additional Spot Instance requests that are specified with the same Availability Zone group name are launched in that same Availability Zone, as long as at least one instance from the group is still active.
    If there is no active instance running in the Availability Zone group that you specify for a new Spot Instance request (all instances are terminated, the bid is expired, or the bid falls below current market), then Amazon EC2 launches the instance in any Availability Zone where the constraint can be met. Consequently, the subsequent set of Spot Instances could be placed in a different zone from the original request, even if you specified the same Availability Zone group.
    Default: Instances are launched in any available Availability Zone.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    availabilityZoneGroup - The user-specified name for a logical grouping of bids.
    When you specify an Availability Zone group in a Spot Instance request, all Spot Instances in the request are launched in the same Availability Zone. Instance proximity is maintained with this parameter, but the choice of Availability Zone is not. The group applies only to bids for Spot Instances of the same instance type. Any additional Spot Instance requests that are specified with the same Availability Zone group name are launched in that same Availability Zone, as long as at least one instance from the group is still active.
    If there is no active instance running in the Availability Zone group that you specify for a new Spot Instance request (all instances are terminated, the bid is expired, or the bid falls below current market), then Amazon EC2 launches the instance in any Availability Zone where the constraint can be met. Consequently, the subsequent set of Spot Instances could be placed in a different zone from the original request, even if you specified the same Availability Zone group.
    Default: Instances are launched in any available Availability Zone.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getLaunchSpecification
```
public LaunchSpecification getLaunchSpecification()
```
    The launch specification.
    
    Returns:
    The launch specification.
  - setLaunchSpecification
```
public void setLaunchSpecification(LaunchSpecification launchSpecification)
```
    The launch specification.
    
    Parameters:
    launchSpecification - The launch specification.
  - withLaunchSpecification
```
public RequestSpotInstancesRequest withLaunchSpecification(LaunchSpecification launchSpecification)
```
    The launch specification.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    launchSpecification - The launch specification.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getDryRunRequest
```
public Request<RequestSpotInstancesRequest> 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<RequestSpotInstancesRequest>
  - 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

Class RequestSpotInstancesRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

RequestSpotInstancesRequest

RequestSpotInstancesRequest

Method Detail

getSpotPrice

setSpotPrice

withSpotPrice

getInstanceCount

setInstanceCount

withInstanceCount

getType

setType

withType

setType

withType

getValidFrom

setValidFrom

withValidFrom

getValidUntil

setValidUntil

withValidUntil

getLaunchGroup

setLaunchGroup

withLaunchGroup

getAvailabilityZoneGroup

setAvailabilityZoneGroup

withAvailabilityZoneGroup

getLaunchSpecification

setLaunchSpecification

withLaunchSpecification

getDryRunRequest

toString

hashCode

equals