Class DescribeReservedInstancesOfferingsRequest

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.DescribeReservedInstancesOfferingsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeReservedInstancesOfferingsRequest.Builder,DescribeReservedInstancesOfferingsRequest>
@Generated("software.amazon.awssdk:codegen") public final class DescribeReservedInstancesOfferingsRequest extends Ec2Request implements ToCopyableBuilder<DescribeReservedInstancesOfferingsRequest.Builder,DescribeReservedInstancesOfferingsRequest>

Contains the parameters for DescribeReservedInstancesOfferings.

  • Method Details

    • availabilityZone

      public final String availabilityZone()

      The Availability Zone in which the Reserved Instance can be used.

      Returns:
      The Availability Zone in which the Reserved Instance can be used.

    • includeMarketplace

      public final Boolean includeMarketplace()

      Include Reserved Instance Marketplace offerings in the response.

      Returns:
      Include Reserved Instance Marketplace offerings in the response.

    • instanceType

      public final InstanceType instanceType()

      The instance type that the reservation will cover (for example, m1.small). For more information, see Amazon EC2 instance types in the Amazon EC2 User Guide.

      If the service returns an enum value that is not available in the current SDK version, instanceType will return InstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTypeAsString().

      Returns:
      The instance type that the reservation will cover (for example, m1.small). For more information, see Amazon EC2 instance types in the Amazon EC2 User Guide.
      See Also:

    • instanceTypeAsString

      public final String instanceTypeAsString()

      The instance type that the reservation will cover (for example, m1.small). For more information, see Amazon EC2 instance types in the Amazon EC2 User Guide.

      If the service returns an enum value that is not available in the current SDK version, instanceType will return InstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTypeAsString().

      Returns:
      The instance type that the reservation will cover (for example, m1.small). For more information, see Amazon EC2 instance types in the Amazon EC2 User Guide.
      See Also:

    • maxDuration

      public final Long maxDuration()

      The maximum duration (in seconds) to filter when searching for offerings.

      Default: 94608000 (3 years)

      Returns:
      The maximum duration (in seconds) to filter when searching for offerings.

      Default: 94608000 (3 years)

    • maxInstanceCount

      public final Integer maxInstanceCount()

      The maximum number of instances to filter when searching for offerings.

      Default: 20

      Returns:
      The maximum number of instances to filter when searching for offerings.

      Default: 20

    • minDuration

      public final Long minDuration()

      The minimum duration (in seconds) to filter when searching for offerings.

      Default: 2592000 (1 month)

      Returns:
      The minimum duration (in seconds) to filter when searching for offerings.

      Default: 2592000 (1 month)

    • offeringClass

      public final OfferingClassType offeringClass()

      The offering class of the Reserved Instance. Can be standard or convertible.

      If the service returns an enum value that is not available in the current SDK version, offeringClass will return OfferingClassType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from offeringClassAsString().

      Returns:
      The offering class of the Reserved Instance. Can be standard or convertible.
      See Also:

    • offeringClassAsString

      public final String offeringClassAsString()

      The offering class of the Reserved Instance. Can be standard or convertible.

      If the service returns an enum value that is not available in the current SDK version, offeringClass will return OfferingClassType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from offeringClassAsString().

      Returns:
      The offering class of the Reserved Instance. Can be standard or convertible.
      See Also:

    • productDescription

      public final RIProductDescription productDescription()

      The Reserved Instance product platform description. Instances that include (Amazon VPC) in the description are for use with Amazon VPC.

      If the service returns an enum value that is not available in the current SDK version, productDescription will return RIProductDescription.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from productDescriptionAsString().

      Returns:
      The Reserved Instance product platform description. Instances that include (Amazon VPC) in the description are for use with Amazon VPC.
      See Also:

    • productDescriptionAsString

      public final String productDescriptionAsString()

      The Reserved Instance product platform description. Instances that include (Amazon VPC) in the description are for use with Amazon VPC.

      If the service returns an enum value that is not available in the current SDK version, productDescription will return RIProductDescription.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from productDescriptionAsString().

      Returns:
      The Reserved Instance product platform description. Instances that include (Amazon VPC) in the description are for use with Amazon VPC.
      See Also:

    • hasReservedInstancesOfferingIds

      public final boolean hasReservedInstancesOfferingIds()
      For responses, this returns true if the service returned a value for the ReservedInstancesOfferingIds 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.

    • reservedInstancesOfferingIds

      public final List<String> reservedInstancesOfferingIds()

      One or more Reserved Instances offering 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 hasReservedInstancesOfferingIds() method.

      Returns:
      One or more Reserved Instances offering IDs.

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

    • 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 where the Reserved Instance can be used.

      • duration - The duration of the Reserved Instance (for example, one year or three years), in seconds (31536000 | 94608000).

      • fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).

      • instance-type - The instance type that is covered by the reservation.

      • marketplace - Set to true to show only Reserved Instance Marketplace offerings. When this filter is not used, which is the default behavior, all offerings from both Amazon Web Services and the Reserved Instance Marketplace are listed.

      • product-description - The Reserved Instance product platform description (Linux/UNIX | Linux with SQL Server Standard | Linux with SQL Server Web | Linux with SQL Server Enterprise | SUSE Linux | Red Hat Enterprise Linux | Red Hat Enterprise Linux with HA | Windows | Windows with SQL Server Standard | Windows with SQL Server Web | Windows with SQL Server Enterprise).

      • reserved-instances-offering-id - The Reserved Instances offering ID.

      • scope - The scope of the Reserved Instance (Availability Zone or Region).

      • usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).

      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 where the Reserved Instance can be used.

      • duration - The duration of the Reserved Instance (for example, one year or three years), in seconds (31536000 | 94608000).

      • fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).

      • instance-type - The instance type that is covered by the reservation.

      • marketplace - Set to true to show only Reserved Instance Marketplace offerings. When this filter is not used, which is the default behavior, all offerings from both Amazon Web Services and the Reserved Instance Marketplace are listed.

      • product-description - The Reserved Instance product platform description ( Linux/UNIX | Linux with SQL Server Standard | Linux with SQL Server Web | Linux with SQL Server Enterprise | SUSE Linux | Red Hat Enterprise Linux | Red Hat Enterprise Linux with HA | Windows | Windows with SQL Server Standard | Windows with SQL Server Web | Windows with SQL Server Enterprise).

      • reserved-instances-offering-id - The Reserved Instances offering ID.

      • scope - The scope of the Reserved Instance (Availability Zone or Region).

      • usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).

    • instanceTenancy

      public final Tenancy instanceTenancy()

      The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy of dedicated is applied to instances that run in a VPC on single-tenant hardware (i.e., Dedicated Instances).

      Important: The host value cannot be used with this parameter. Use the default or dedicated values only.

      Default: default

      If the service returns an enum value that is not available in the current SDK version, instanceTenancy will return Tenancy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTenancyAsString().

      Returns:
      The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy of dedicated is applied to instances that run in a VPC on single-tenant hardware (i.e., Dedicated Instances).

      Important: The host value cannot be used with this parameter. Use the default or dedicated values only.

      Default: default

      See Also:

    • instanceTenancyAsString

      public final String instanceTenancyAsString()

      The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy of dedicated is applied to instances that run in a VPC on single-tenant hardware (i.e., Dedicated Instances).

      Important: The host value cannot be used with this parameter. Use the default or dedicated values only.

      Default: default

      If the service returns an enum value that is not available in the current SDK version, instanceTenancy will return Tenancy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTenancyAsString().

      Returns:
      The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy of dedicated is applied to instances that run in a VPC on single-tenant hardware (i.e., Dedicated Instances).

      Important: The host value cannot be used with this parameter. Use the default or dedicated values only.

      Default: default

      See Also:

    • offeringType

      public final OfferingTypeValues offeringType()

      The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.

      If the service returns an enum value that is not available in the current SDK version, offeringType will return OfferingTypeValues.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from offeringTypeAsString().

      Returns:
      The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.
      See Also:

    • offeringTypeAsString

      public final String offeringTypeAsString()

      The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.

      If the service returns an enum value that is not available in the current SDK version, offeringType will return OfferingTypeValues.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from offeringTypeAsString().

      Returns:
      The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.
      See Also:

    • nextToken

      public final String nextToken()

      The token to retrieve the next page of results.

      Returns:
      The token to retrieve the next page of results.

    • maxResults

      public final Integer maxResults()

      The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. The maximum is 100.

      Default: 100

      Returns:
      The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. The maximum is 100.

      Default: 100

    • toBuilder

      public DescribeReservedInstancesOfferingsRequest.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<DescribeReservedInstancesOfferingsRequest.Builder,DescribeReservedInstancesOfferingsRequest>
      Specified by:
      toBuilder in class Ec2Request
      Returns:
      a builder for type T

    • builder

      public static DescribeReservedInstancesOfferingsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeReservedInstancesOfferingsRequest.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

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

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.