DescribeSpotPriceHistoryRequest (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.DescribeSpotPriceHistoryRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<DescribeSpotPriceHistoryRequest.Builder,DescribeSpotPriceHistoryRequest>

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

Contains the parameters for DescribeSpotPriceHistory.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DescribeSpotPriceHistoryRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`availabilityZone()` Filters the results by the specified Availability Zone.
`static DescribeSpotPriceHistoryRequest.Builder`	`builder()`
`Instant`	`endTime()` The date and time, up to the current date, from which to stop retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
`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`	`hasInstanceTypes()` For responses, this returns true if the service returned a value for the InstanceTypes property.
`boolean`	`hasProductDescriptions()` For responses, this returns true if the service returned a value for the ProductDescriptions property.
`List<InstanceType>`	`instanceTypes()` Filters the results by the specified instance types.
`List<String>`	`instanceTypesAsStrings()` Filters the results by the specified instance types.
`Integer`	`maxResults()` The maximum number of results to return in a single call.
`String`	`nextToken()` The token for the next set of results.
`List<String>`	`productDescriptions()` Filters the results by the specified basic product descriptions.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeSpotPriceHistoryRequest.Builder>`	`serializableBuilderClass()`
`Instant`	`startTime()` The date and time, up to the past 90 days, from which to start retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
`DescribeSpotPriceHistoryRequest.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 - The Availability Zone for which prices should be returned.
    - instance-type - The type of instance (for example, m3.medium).
    - product-description - The product description for the Spot price (Linux/UNIX | Red Hat Enterprise Linux | SUSE Linux | Windows | Linux/UNIX (Amazon VPC) | Red Hat Enterprise Linux (Amazon VPC) | SUSE Linux (Amazon VPC) | Windows (Amazon VPC)).
    - spot-price - The Spot price. The value must match exactly (or use wildcards; greater than or less than comparison is not supported).
    - timestamp - The time stamp of the Spot price history, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). You can use wildcards (* and ?). Greater than or less than comparison is not supported.
    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 - The Availability Zone for which prices should be returned.
    
    instance-type - The type of instance (for example, m3.medium).
    
    product-description - The product description for the Spot price (Linux/UNIX | Red Hat Enterprise Linux | SUSE Linux | Windows | Linux/UNIX (Amazon VPC) | Red Hat Enterprise Linux (Amazon VPC) | SUSE Linux (Amazon VPC) | Windows (Amazon VPC)).
    
    spot-price - The Spot price. The value must match exactly (or use wildcards; greater than or less than comparison is not supported).
    
    timestamp - The time stamp of the Spot price history, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). You can use wildcards (* and ?). Greater than or less than comparison is not supported.
  - availabilityZone
```
public final String availabilityZone()
```
    Filters the results by the specified Availability Zone.
    
    Returns:
    
    Filters the results by the specified Availability Zone.
  - endTime
```
public final Instant endTime()
```
    The date and time, up to the current date, from which to stop retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
    
    Returns:
    
    The date and time, up to the current date, from which to stop retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
  - instanceTypes
```
public final List<InstanceType> instanceTypes()
```
    Filters the results by the specified instance types.
    
    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 hasInstanceTypes() method.
    
    Returns:
    
    Filters the results by the specified instance types.
  - hasInstanceTypes
```
public final boolean hasInstanceTypes()
```
    For responses, this returns true if the service returned a value for the InstanceTypes 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.
  - instanceTypesAsStrings
```
public final List<String> instanceTypesAsStrings()
```
    Filters the results by the specified instance types.
    
    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 hasInstanceTypes() method.
    
    Returns:
    
    Filters the results by the specified instance types.
  - maxResults
```
public final Integer maxResults()
```
    The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 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 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.
  - nextToken
```
public final String nextToken()
```
    The token for the next set of results.
    
    Returns:
    
    The token for the next set of results.
  - hasProductDescriptions
```
public final boolean hasProductDescriptions()
```
    For responses, this returns true if the service returned a value for the ProductDescriptions 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.
  - productDescriptions
```
public final List<String> productDescriptions()
```
    Filters the results by the specified basic product descriptions.
    
    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 hasProductDescriptions() method.
    
    Returns:
    
    Filters the results by the specified basic product descriptions.
  - startTime
```
public final Instant startTime()
```
    The date and time, up to the past 90 days, from which to start retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
    
    Returns:
    
    The date and time, up to the past 90 days, from which to start retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
  - toBuilder
```
public DescribeSpotPriceHistoryRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeSpotPriceHistoryRequest.Builder,DescribeSpotPriceHistoryRequest>
    
    Specified by:
    
    toBuilder in class Ec2Request
  - builder
```
public static DescribeSpotPriceHistoryRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeSpotPriceHistoryRequest.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 DescribeSpotPriceHistoryRequest

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

availabilityZone

endTime

instanceTypes

hasInstanceTypes

instanceTypesAsStrings

maxResults

nextToken

hasProductDescriptions

productDescriptions

startTime

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields