DescribeSpotInstanceRequestsRequest (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.ec2.model.EC2Request
    - - software.amazon.awssdk.services.ec2.model.DescribeSpotInstanceRequestsRequest

All Implemented Interfaces:: ToCopyableBuilder<DescribeSpotInstanceRequestsRequest.Builder,DescribeSpotInstanceRequestsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public class DescribeSpotInstanceRequestsRequest
extends EC2Request
implements ToCopyableBuilder<DescribeSpotInstanceRequestsRequest.Builder,DescribeSpotInstanceRequestsRequest>

Contains the parameters for DescribeSpotInstanceRequests.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DescribeSpotInstanceRequestsRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DescribeSpotInstanceRequestsRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DescribeSpotInstanceRequestsRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`List<Filter>`	`filters()` One or more filters.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`int`	`hashCode()`
`static Class<? extends DescribeSpotInstanceRequestsRequest.Builder>`	`serializableBuilderClass()`
`List<String>`	`spotInstanceRequestIds()` One or more Spot instance request IDs.
`DescribeSpotInstanceRequestsRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
requestOverrideConfig

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - filters
```
public List<Filter> filters()
```
    One or more filters.
    - availability-zone-group - The Availability Zone group.
    - create-time - The time stamp when the Spot instance request was created.
    - fault-code - The fault code related to the request.
    - fault-message - The fault message related to the request.
    - instance-id - The ID of the instance that fulfilled the request.
    - launch-group - The Spot instance launch group.
    - launch.block-device-mapping.delete-on-termination - Indicates whether the EBS volume is deleted on instance termination.
    - launch.block-device-mapping.device-name - The device name for the volume in the block device mapping (for example, /dev/sdh or xvdh).
    - launch.block-device-mapping.snapshot-id - The ID of the snapshot for the EBS volume.
    - launch.block-device-mapping.volume-size - The size of the EBS volume, in GiB.
    - launch.block-device-mapping.volume-type - The type of EBS volume: gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1for Cold HDD, or standard for Magnetic.
    - launch.group-id - The security group for the instance.
    - launch.image-id - The ID of the AMI.
    - launch.instance-type - The type of instance (for example, m3.medium).
    - launch.kernel-id - The kernel ID.
    - launch.key-name - The name of the key pair the instance launched with.
    - launch.monitoring-enabled - Whether detailed monitoring is enabled for the Spot instance.
    - launch.ramdisk-id - The RAM disk ID.
    - launched-availability-zone - The Availability Zone in which the bid is launched.
    - network-interface.addresses.primary - Indicates whether the IP address is the primary private IP address.
    - network-interface.delete-on-termination - Indicates whether the network interface is deleted when the instance is terminated.
    - network-interface.description - A description of the network interface.
    - network-interface.device-index - The index of the device for the network interface attachment on the instance.
    - network-interface.group-id - The ID of the security group associated with the network interface.
    - network-interface.network-interface-id - The ID of the network interface.
    - network-interface.private-ip-address - The primary private IP address of the network interface.
    - network-interface.subnet-id - The ID of the subnet for the instance.
    - product-description - The product description associated with the instance (Linux/UNIX | Windows).
    - spot-instance-request-id - The Spot instance request ID.
    - spot-price - The maximum hourly price for any Spot instance launched to fulfill the request.
    - state - The state of the Spot instance request (open | active | closed | cancelled | failed). Spot bid status information can help you track your Amazon EC2 Spot instance requests. For more information, see Spot Bid Status in the Amazon Elastic Compute Cloud User Guide.
    - status-code - The short code describing the most recent evaluation of your Spot instance request.
    - status-message - The message explaining the status of the Spot instance request.
    - tag:key=value - The key/value combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value.
    - tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.
    - tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
    - type - The type of Spot instance request (one-time | persistent).
    - valid-from - The start date of the request.
    - valid-until - The end date of the request.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    Returns:
    One or more filters.
    
    availability-zone-group - The Availability Zone group.
    
    create-time - The time stamp when the Spot instance request was created.
    
    fault-code - The fault code related to the request.
    
    fault-message - The fault message related to the request.
    
    instance-id - The ID of the instance that fulfilled the request.
    
    launch-group - The Spot instance launch group.
    
    launch.block-device-mapping.delete-on-termination - Indicates whether the EBS volume is deleted on instance termination.
    
    launch.block-device-mapping.device-name - The device name for the volume in the block device mapping (for example, /dev/sdh or xvdh).
    
    launch.block-device-mapping.snapshot-id - The ID of the snapshot for the EBS volume.
    
    launch.block-device-mapping.volume-size - The size of the EBS volume, in GiB.
    
    launch.block-device-mapping.volume-type - The type of EBS volume: gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1for Cold HDD, or standard for Magnetic.
    
    launch.group-id - The security group for the instance.
    
    launch.image-id - The ID of the AMI.
    
    launch.instance-type - The type of instance (for example, m3.medium).
    
    launch.kernel-id - The kernel ID.
    
    launch.key-name - The name of the key pair the instance launched with.
    
    launch.monitoring-enabled - Whether detailed monitoring is enabled for the Spot instance.
    
    launch.ramdisk-id - The RAM disk ID.
    
    launched-availability-zone - The Availability Zone in which the bid is launched.
    
    network-interface.addresses.primary - Indicates whether the IP address is the primary private IP address.
    
    network-interface.delete-on-termination - Indicates whether the network interface is deleted when the instance is terminated.
    
    network-interface.description - A description of the network interface.
    
    network-interface.device-index - The index of the device for the network interface attachment on the instance.
    
    network-interface.group-id - The ID of the security group associated with the network interface.
    
    network-interface.network-interface-id - The ID of the network interface.
    
    network-interface.private-ip-address - The primary private IP address of the network interface.
    
    network-interface.subnet-id - The ID of the subnet for the instance.
    
    product-description - The product description associated with the instance ( Linux/UNIX | Windows).
    
    spot-instance-request-id - The Spot instance request ID.
    
    spot-price - The maximum hourly price for any Spot instance launched to fulfill the request.
    
    state - The state of the Spot instance request (open | active | closed | cancelled | failed). Spot bid status information can help you track your Amazon EC2 Spot instance requests. For more information, see Spot Bid Status in the Amazon Elastic Compute Cloud User Guide.
    
    status-code - The short code describing the most recent evaluation of your Spot instance request.
    
    status-message - The message explaining the status of the Spot instance request.
    
    tag:key=value - The key/value combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value.
    
    tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.
    
    tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
    
    type - The type of Spot instance request (one-time | persistent).
    
    valid-from - The start date of the request.
    
    valid-until - The end date of the request.
  - spotInstanceRequestIds
```
public List<String> spotInstanceRequestIds()
```
    One or more Spot instance request IDs.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    One or more Spot instance request IDs.
  - toBuilder
```
public DescribeSpotInstanceRequestsRequest.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeSpotInstanceRequestsRequest.Builder,DescribeSpotInstanceRequestsRequest>
    
    Specified by:
    
    toBuilder in class EC2Request
    
    Returns:
    
    a builder for type T
  - builder
```
public static DescribeSpotInstanceRequestsRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeSpotInstanceRequestsRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value

Class DescribeSpotInstanceRequestsRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

filters

spotInstanceRequestIds

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField