DescribeReservedInstancesRequest (AWS SDK for Java

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(value="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 and Description

static interface DescribeReservedInstancesRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DescribeReservedInstancesRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`List<Filter>`	`filters()` One or more filters.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`int`	`hashCode()`
`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()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

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

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

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

- Method Detail
  - filters
```
public 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 or Availability Zone).
    - product-description - The Reserved Instance product platform description. Instances that include (Amazon VPC) in the product platform description will only be displayed to EC2-Classic account holders and are for use with Amazon VPC (Linux/UNIX | Linux/UNIX (Amazon VPC) | SUSE Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise Linux | Red Hat Enterprise Linux (Amazon VPC) | Windows | Windows (Amazon VPC) | Windows with SQL Server Standard | Windows with SQL Server Standard (Amazon VPC) | Windows with SQL Server Web | Windows with SQL Server Web (Amazon VPC) | Windows with SQL Server Enterprise | Windows with SQL Server Enterprise (Amazon VPC)).
    - 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 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.
    - 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.
    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 or Availability Zone).
    
    product-description - The Reserved Instance product platform description. Instances that include (Amazon VPC) in the product platform description will only be displayed to EC2-Classic account holders and are for use with Amazon VPC (Linux/UNIX | Linux/UNIX (Amazon VPC) | SUSE Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise Linux | Red Hat Enterprise Linux (Amazon VPC) | Windows | Windows (Amazon VPC) | Windows with SQL Server Standard | Windows with SQL Server Standard (Amazon VPC) | Windows with SQL Server Web | Windows with SQL Server Web (Amazon VPC) | Windows with SQL Server Enterprise | Windows with SQL Server Enterprise (Amazon VPC)).
    
    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 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.
    
    usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).
  - offeringClass
```
public 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 return OfferingClassType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from offeringClassAsString().
    
    Returns:
    
    Describes whether the Reserved Instance is Standard or Convertible.
    
    See Also:
    
    OfferingClassType
  - offeringClassAsString
```
public 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 return OfferingClassType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from offeringClassAsString().
    
    Returns:
    
    Describes whether the Reserved Instance is Standard or Convertible.
    
    See Also:
    
    OfferingClassType
  - reservedInstancesIds
```
public 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.
    
    Returns:
    
    One or more Reserved Instance IDs.
    
    Default: Describes all your Reserved Instances, or only those otherwise specified.
  - offeringType
```
public 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:
    
    OfferingTypeValues
  - offeringTypeAsString
```
public 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:
    
    OfferingTypeValues
  - toBuilder
```
public DescribeReservedInstancesRequest.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<DescribeReservedInstancesRequest.Builder,DescribeReservedInstancesRequest>
    
    Specified by:
    
    toBuilder in class Ec2Request
    
    Returns:
    
    a builder for type T
  - builder
```
public static DescribeReservedInstancesRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeReservedInstancesRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <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 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.

Class DescribeReservedInstancesRequest

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

filters

offeringClass

offeringClassAsString

reservedInstancesIds

offeringType

offeringTypeAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields