DescribeSpotInstanceRequestsRequest (AWS Java SDK :: Services

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:: SdkPojo, ToCopyableBuilder<DescribeSpotInstanceRequestsRequest.Builder,DescribeSpotInstanceRequestsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final 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)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<Filter>`	`filters()` One or more filters.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasFilters()` For responses, this returns true if the service returned a value for the Filters property.
`int`	`hashCode()`
`boolean`	`hasSpotInstanceRequestIds()` For responses, this returns true if the service returned a value for the SpotInstanceRequestIds property.
`Integer`	`maxResults()` The maximum number of results to return in a single call.
`String`	`nextToken()` The token to request the next set of results.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeSpotInstanceRequestsRequest.Builder>`	`serializableBuilderClass()`
`List<String>`	`spotInstanceRequestIds()` One or more Spot Instance request IDs.
`DescribeSpotInstanceRequestsRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

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

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

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

- Method Detail
  - hasFilters
```
public final boolean hasFilters()
```
    For responses, this returns true if the service returned a value for the Filters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - filters
```
public final 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 or io2 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1for Cold HDD, or standard for Magnetic.
    - launch.group-id - The ID of the security group for the instance.
    - launch.group-name - The name of 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 request 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 request status information can help you track your Amazon EC2 Spot Instance requests. For more information, see Spot request status in the Amazon EC2 User Guide for Linux Instances.
    - 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> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
    - tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
    - 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.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFilters() method.
    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 or io2 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1for Cold HDD, or standard for Magnetic.
    
    launch.group-id - The ID of the security group for the instance.
    
    launch.group-name - The name of 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 request 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 request status information can help you track your Amazon EC2 Spot Instance requests. For more information, see Spot request status in the Amazon EC2 User Guide for Linux Instances.
    
    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> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
    
    tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
    
    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.
  - hasSpotInstanceRequestIds
```
public final boolean hasSpotInstanceRequestIds()
```
    For responses, this returns true if the service returned a value for the SpotInstanceRequestIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - spotInstanceRequestIds
```
public final List<String> spotInstanceRequestIds()
```
    One or more Spot Instance request IDs.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSpotInstanceRequestIds() method.
    
    Returns:
    
    One or more Spot Instance request IDs.
  - nextToken
```
public final String nextToken()
```
    The token to request the next set of results. This value is null when there are no more results to return.
    
    Returns:
    
    The token to request the next set of results. This value is null when there are no more results to return.
  - maxResults
```
public final Integer maxResults()
```
    The maximum number of results to return in a single call. Specify a value between 5 and 1000. To retrieve the remaining results, make another call with the returned NextToken value.
    
    Returns:
    
    The maximum number of results to return in a single call. Specify a value between 5 and 1000. To retrieve the remaining results, make another call with the returned NextToken value.
  - toBuilder
```
public DescribeSpotInstanceRequestsRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeSpotInstanceRequestsRequest.Builder,DescribeSpotInstanceRequestsRequest>
    
    Specified by:
    
    toBuilder in class Ec2Request
  - builder
```
public static DescribeSpotInstanceRequestsRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeSpotInstanceRequestsRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

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

hasFilters

filters

hasSpotInstanceRequestIds

spotInstanceRequestIds

nextToken

maxResults

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields