Class DescribeReservedInstancesRequest
- 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.DescribeReservedInstancesRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeReservedInstancesRequest.Builder,DescribeReservedInstancesRequest>
@Generated("software.amazon.awssdk:codegen") public final class DescribeReservedInstancesRequest extends Ec2Request implements ToCopyableBuilder<DescribeReservedInstancesRequest.Builder,DescribeReservedInstancesRequest>
Contains the parameters for DescribeReservedInstances.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
DescribeReservedInstancesRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DescribeReservedInstancesRequest.Builder
builder()
Boolean
dryRun()
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.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
hasReservedInstancesIds()
For responses, this returns true if the service returned a value for the ReservedInstancesIds property.OfferingClassType
offeringClass()
Describes whether the Reserved Instance is Standard or Convertible.String
offeringClassAsString()
Describes whether the Reserved Instance is Standard or Convertible.OfferingTypeValues
offeringType()
The Reserved Instance offering type.String
offeringTypeAsString()
The Reserved Instance offering type.List<String>
reservedInstancesIds()
One or more Reserved Instance IDs.List<SdkField<?>>
sdkFields()
static Class<? extends DescribeReservedInstancesRequest.Builder>
serializableBuilderClass()
DescribeReservedInstancesRequest.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 theisEmpty()
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 (one year or three years), in seconds (31536000
|94608000
). -
end
- The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z). -
fixed-price
- The purchase price of the Reserved Instance (for example, 9800.0). -
instance-type
- The instance type that is covered by the reservation. -
scope
- The scope of the Reserved Instance (Region
orAvailability Zone
). -
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-id
- The ID of the Reserved Instance. -
start
- The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z). -
state
- The state of the Reserved Instance (payment-pending
|active
|payment-failed
|retired
). -
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 keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
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. -
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 (one year or three years), in seconds (31536000
|94608000
). -
end
- The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z). -
fixed-price
- The purchase price of the Reserved Instance (for example, 9800.0). -
instance-type
- The instance type that is covered by the reservation. -
scope
- The scope of the Reserved Instance (Region
orAvailability Zone
). -
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-id
- The ID of the Reserved Instance. -
start
- The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z). -
state
- The state of the Reserved Instance (payment-pending
|active
|payment-failed
|retired
). -
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 keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
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. -
usage-price
- The usage price of the Reserved Instance, per hour (for example, 0.84).
-
-
-
offeringClass
public final OfferingClassType offeringClass()
Describes whether the Reserved Instance is Standard or Convertible.
If the service returns an enum value that is not available in the current SDK version,
offeringClass
will returnOfferingClassType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromofferingClassAsString()
.- Returns:
- Describes whether the Reserved Instance is Standard or Convertible.
- See Also:
OfferingClassType
-
offeringClassAsString
public final String offeringClassAsString()
Describes whether the Reserved Instance is Standard or Convertible.
If the service returns an enum value that is not available in the current SDK version,
offeringClass
will returnOfferingClassType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromofferingClassAsString()
.- Returns:
- Describes whether the Reserved Instance is Standard or Convertible.
- See Also:
OfferingClassType
-
hasReservedInstancesIds
public final boolean hasReservedInstancesIds()
For responses, this returns true if the service returned a value for the ReservedInstancesIds property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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.
-
reservedInstancesIds
public final List<String> reservedInstancesIds()
One or more Reserved Instance IDs.
Default: Describes all your Reserved Instances, or only those otherwise specified.
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
hasReservedInstancesIds()
method.- Returns:
- One or more Reserved Instance IDs.
Default: Describes all your Reserved Instances, or only those otherwise specified.
-
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 isUnauthorizedOperation
.- 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 isUnauthorizedOperation
.
-
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 returnOfferingTypeValues.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromofferingTypeAsString()
.- 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:
OfferingTypeValues
-
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 returnOfferingTypeValues.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromofferingTypeAsString()
.- 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:
OfferingTypeValues
-
toBuilder
public DescribeReservedInstancesRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<DescribeReservedInstancesRequest.Builder,DescribeReservedInstancesRequest>
- Specified by:
toBuilder
in classEc2Request
-
builder
public static DescribeReservedInstancesRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends DescribeReservedInstancesRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-