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

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface DescribeCapacityBlocksRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static DescribeCapacityBlocksRequest.Builder`	`builder()`
`List<String>`	`capacityBlockIds()`	The IDs of the Capacity Blocks.
`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`	`hasCapacityBlockIds()`	For responses, this returns true if the service returned a value for the CapacityBlockIds 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.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeCapacityBlocksRequest.Builder>`	`serializableBuilderClass()`
`DescribeCapacityBlocksRequest.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
  - hasCapacityBlockIds
```
public final boolean hasCapacityBlockIds()
```
    For responses, this returns true if the service returned a value for the CapacityBlockIds 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.
  - capacityBlockIds
```
public final List<String> capacityBlockIds()
```
    The IDs of the Capacity Blocks.
    
    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 hasCapacityBlockIds() method.
    
    Returns:
    
    The IDs of the Capacity Blocks.
  - 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.
    
    capacity-block-id - The ID of the Capacity Block.
    
    ultraserver-type - The Capacity Block type. The type can be instances or ultraservers.
    
    availability-zone - The Availability Zone of the Capacity Block.
    
    start-date - The date and time at which the Capacity Block was started.
    
    end-date - The date and time at which the Capacity Block expires. When a Capacity Block expires, all instances in the Capacity Block are terminated.
    
    create-date - The date and time at which the Capacity Block was created.
    
    state - The state of the Capacity Block (active | expired | unavailable | cancelled | failed | scheduled | payment-pending | payment-failed).
    
    tags - The tags assigned to the Capacity Block.
    
    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.
    
    capacity-block-id - The ID of the Capacity Block.
    
    ultraserver-type - The Capacity Block type. The type can be instances or ultraservers.
    
    availability-zone - The Availability Zone of the Capacity Block.
    
    start-date - The date and time at which the Capacity Block was started.
    
    end-date - The date and time at which the Capacity Block expires. When a Capacity Block expires, all instances in the Capacity Block are terminated.
    
    create-date - The date and time at which the Capacity Block was created.
    
    state - The state of the Capacity Block (active | expired | unavailable | cancelled | failed | scheduled | payment-pending | payment-failed).
    
    tags - The tags assigned to the Capacity Block.
  - 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 DescribeCapacityBlocksRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeCapacityBlocksRequest.Builder,DescribeCapacityBlocksRequest>
    
    Specified by:
    
    toBuilder in class Ec2Request
  - builder
```
public static DescribeCapacityBlocksRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeCapacityBlocksRequest.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

Class DescribeCapacityBlocksRequest

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

hasCapacityBlockIds

capacityBlockIds

nextToken

maxResults

hasFilters

filters

dryRun

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField