software.amazon.awssdk.services.ec2.model

Class GetCapacityReservationUsageResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.ec2.model.Ec2Response

software.amazon.awssdk.services.ec2.model.GetCapacityReservationUsageResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetCapacityReservationUsageResponse.Builder,GetCapacityReservationUsageResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetCapacityReservationUsageResponse
extends Ec2Response
implements ToCopyableBuilder<GetCapacityReservationUsageResponse.Builder,GetCapacityReservationUsageResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetCapacityReservationUsageResponse.Builder

Method Summary

Modifier and Type	Method and Description
Integer	availableInstanceCount() The remaining capacity.
static GetCapacityReservationUsageResponse.Builder	builder()
String	capacityReservationId() The ID of the Capacity Reservation.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasInstanceUsages() For responses, this returns true if the service returned a value for the InstanceUsages property.
String	instanceType() The type of instance for which the Capacity Reservation reserves capacity.
List<InstanceUsage>	instanceUsages() Information about the Capacity Reservation usage.
String	nextToken() The token to use to retrieve the next page of results.
List<SdkField<?>>	sdkFields()
static Class<? extends GetCapacityReservationUsageResponse.Builder>	serializableBuilderClass()
CapacityReservationState	state() The current state of the Capacity Reservation.
String	stateAsString() The current state of the Capacity Reservation.
GetCapacityReservationUsageResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Integer	totalInstanceCount() The number of instances for which the Capacity Reservation reserves capacity.

Methods inherited from class software.amazon.awssdk.services.ec2.model.Ec2Response

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

nextToken

public final String nextToken()

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Returns:

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

capacityReservationId

public final String capacityReservationId()

The ID of the Capacity Reservation.

Returns:

The ID of the Capacity Reservation.

instanceType

public final String instanceType()

The type of instance for which the Capacity Reservation reserves capacity.

Returns:

The type of instance for which the Capacity Reservation reserves capacity.

totalInstanceCount

public final Integer totalInstanceCount()

The number of instances for which the Capacity Reservation reserves capacity.

Returns:

The number of instances for which the Capacity Reservation reserves capacity.

availableInstanceCount

public final Integer availableInstanceCount()

The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation.

Returns:

The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation.

state

public final CapacityReservationState state()

The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

• active - The Capacity Reservation is active and the capacity is available for your use.

• expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.

• cancelled - The Capacity Reservation was cancelled. The reserved capacity is no longer available for your use.

• pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.

• failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.

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

Returns:

The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

• active - The Capacity Reservation is active and the capacity is available for your use.

• expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.

• cancelled - The Capacity Reservation was cancelled. The reserved capacity is no longer available for your use.

• pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.

• failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.

See Also:

CapacityReservationState

stateAsString

public final String stateAsString()

The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

• active - The Capacity Reservation is active and the capacity is available for your use.

• expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.

• cancelled - The Capacity Reservation was cancelled. The reserved capacity is no longer available for your use.

• pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.

• failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.

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

Returns:

The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

• active - The Capacity Reservation is active and the capacity is available for your use.

• expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.

• cancelled - The Capacity Reservation was cancelled. The reserved capacity is no longer available for your use.

• pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.

• failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.

See Also:

CapacityReservationState

hasInstanceUsages

public final boolean hasInstanceUsages()

For responses, this returns true if the service returned a value for the InstanceUsages 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.

instanceUsages

public final List<InstanceUsage> instanceUsages()

Information about the Capacity Reservation usage.

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 hasInstanceUsages() method.

Returns:

Information about the Capacity Reservation usage.

toBuilder

public GetCapacityReservationUsageResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetCapacityReservationUsageResponse.Builder,GetCapacityReservationUsageResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static GetCapacityReservationUsageResponse.Builder builder()

serializableBuilderClass

public static Class<? extends GetCapacityReservationUsageResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo