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

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface DescribeCapacityReservationBillingRequestsRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static DescribeCapacityReservationBillingRequestsRequest.Builder`	`builder()`
`List<String>`	`capacityReservationIds()`	The ID of the Capacity Reservation.
`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`	`hasCapacityReservationIds()`	For responses, this returns true if the service returned a value for the CapacityReservationIds property.
`boolean`	`hasFilters()`	For responses, this returns true if the service returned a value for the Filters property.
`int`	`hashCode()`
`Integer`	`maxResults()`	The maximum number of items to return for this request.
`String`	`nextToken()`	The token to use to retrieve the next page of results.
`CallerRole`	`role()`	Specify one of the following:
`String`	`roleAsString()`	Specify one of the following:
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeCapacityReservationBillingRequestsRequest.Builder>`	`serializableBuilderClass()`
`DescribeCapacityReservationBillingRequestsRequest.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
  - hasCapacityReservationIds
```
public final boolean hasCapacityReservationIds()
```
    For responses, this returns true if the service returned a value for the CapacityReservationIds 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.
  - capacityReservationIds
```
public final List<String> capacityReservationIds()
```
    The ID of the Capacity Reservation.
    
    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 hasCapacityReservationIds() method.
    
    Returns:
    
    The ID of the Capacity Reservation.
  - role
```
public final CallerRole role()
```
    Specify one of the following:
    
    odcr-owner - If you are the Capacity Reservation owner, specify this value to view requests that you have initiated. Not supported with the requested-by filter.
    
    unused-reservation-billing-owner - If you are the consumer account, specify this value to view requests that have been sent to you. Not supported with the unused-reservation-billing-owner filter.
    
    If the service returns an enum value that is not available in the current SDK version, role will return CallerRole.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from roleAsString().
    Returns:
    
    Specify one of the following:
    
    odcr-owner - If you are the Capacity Reservation owner, specify this value to view requests that you have initiated. Not supported with the requested-by filter.
    
    unused-reservation-billing-owner - If you are the consumer account, specify this value to view requests that have been sent to you. Not supported with the unused-reservation-billing-owner filter.
    
    See Also:
    
    CallerRole
  - roleAsString
```
public final String roleAsString()
```
    Specify one of the following:
    
    odcr-owner - If you are the Capacity Reservation owner, specify this value to view requests that you have initiated. Not supported with the requested-by filter.
    
    unused-reservation-billing-owner - If you are the consumer account, specify this value to view requests that have been sent to you. Not supported with the unused-reservation-billing-owner filter.
    
    If the service returns an enum value that is not available in the current SDK version, role will return CallerRole.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from roleAsString().
    Returns:
    
    Specify one of the following:
    
    odcr-owner - If you are the Capacity Reservation owner, specify this value to view requests that you have initiated. Not supported with the requested-by filter.
    
    unused-reservation-billing-owner - If you are the consumer account, specify this value to view requests that have been sent to you. Not supported with the unused-reservation-billing-owner filter.
    
    See Also:
    
    CallerRole
  - nextToken
```
public final String nextToken()
```
    The token to use to retrieve the next page of results.
    
    Returns:
    
    The token to use to retrieve the next page of results.
  - 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.
  - 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.
    
    status - The state of the request (pending | accepted | rejected | cancelled | revoked | expired).
    
    requested-by - The account ID of the Capacity Reservation owner that initiated the request. Not supported if you specify requested-by for Role.
    
    unused-reservation-billing-owner - The ID of the consumer account to which the request was sent. Not supported if you specify unused-reservation-billing-owner for Role.
    
    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.
    
    status - The state of the request (pending | accepted | rejected | cancelled | revoked | expired).
    
    requested-by - The account ID of the Capacity Reservation owner that initiated the request. Not supported if you specify requested-by for Role.
    
    unused-reservation-billing-owner - The ID of the consumer account to which the request was sent. Not supported if you specify unused-reservation-billing-owner for Role.
  - 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.
  - toBuilder
```
public DescribeCapacityReservationBillingRequestsRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeCapacityReservationBillingRequestsRequest.Builder,DescribeCapacityReservationBillingRequestsRequest>
    
    Specified by:
    
    toBuilder in class Ec2Request
  - builder
```
public static DescribeCapacityReservationBillingRequestsRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeCapacityReservationBillingRequestsRequest.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 DescribeCapacityReservationBillingRequestsRequest

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

hasCapacityReservationIds

capacityReservationIds

role

roleAsString

nextToken

maxResults

hasFilters

filters

dryRun

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields