Package software.amazon.awssdk.services.ec2.model

Class DescribeSpotPriceHistoryRequest

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("software.amazon.awssdk:codegen") public final class DescribeSpotPriceHistoryRequest extends Ec2Request implements ToCopyableBuilder<DescribeSpotPriceHistoryRequest.Builder,DescribeSpotPriceHistoryRequest>

Contains the parameters for DescribeSpotPriceHistory.

  • Method Details

    • availabilityZoneId

      public final String availabilityZoneId()

      Filters the results by the specified ID of the Availability Zone.

      Either AvailabilityZone or AvailabilityZoneId can be specified, but not both

      Returns:
      Filters the results by the specified ID of the Availability Zone.

      Either AvailabilityZone or AvailabilityZoneId can be specified, but not both

    • dryRun

      public final Boolean dryRun()

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

      Returns:
      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

    • 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).

    • 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.

    • 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.

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

      The filters.

      • availability-zone - The Availability Zone for which prices should be returned.

      • availability-zone-id - The ID of 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, ddd MMM dd HH:mm:ss UTC YYYY). 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:
      The filters.

      • availability-zone - The Availability Zone for which prices should be returned.

      • availability-zone-id - The ID of 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, ddd MMM dd HH:mm:ss UTC YYYY). 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.

      Either AvailabilityZone or AvailabilityZoneId can be specified, but not both

      Returns:
      Filters the results by the specified Availability Zone.

      Either AvailabilityZone or AvailabilityZoneId can be specified, but not both

    • maxResults

      public final Integer maxResults()

      The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

      Returns:
      The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

    • nextToken

      public final String nextToken()

      The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

      Returns:
      The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

    • 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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo