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) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkResponse.
int	hashCode()
boolean	hasInstanceUsages() Returns true if the InstanceUsages property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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() Take this object and create a builder that contains all of the current property values of this object.
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

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

nextToken

public 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 String capacityReservationId()

The ID of the Capacity Reservation.

Returns:

The ID of the Capacity Reservation.

instanceType

public 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 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 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 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 manually 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 manually 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 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 manually 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 manually 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 boolean hasInstanceUsages()

Returns true if the InstanceUsages property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

instanceUsages

public List<InstanceUsage> instanceUsages()

Information about the Capacity Reservation usage.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasInstanceUsages() to see if a value was sent in this field.

Returns:

Information about the Capacity Reservation usage.

toBuilder

public GetCapacityReservationUsageResponse.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<GetCapacityReservationUsageResponse.Builder,GetCapacityReservationUsageResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static GetCapacityReservationUsageResponse.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkResponse

Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkResponse

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.