Class GetCapacityReservationUsageResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetCapacityReservationUsageResponse.Builder,
GetCapacityReservationUsageResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Integer
The remaining capacity.builder()
final String
The ID of the Capacity Reservation.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the InstanceUsages property.final String
The type of instance for which the Capacity Reservation reserves capacity.final List
<InstanceUsage> Information about the Capacity Reservation usage.final String
The token to use to retrieve the next page of results.static Class
<? extends GetCapacityReservationUsageResponse.Builder> final CapacityReservationState
state()
The current state of the Capacity Reservation.final String
The current state of the Capacity Reservation.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Integer
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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
The ID of the Capacity Reservation.
- Returns:
- The ID of the Capacity Reservation.
-
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
The number of instances for which the Capacity Reservation reserves capacity.
- Returns:
- The number of instances for which the Capacity Reservation reserves capacity.
-
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
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 returnCapacityReservationState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- 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:
-
-
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 returnCapacityReservationState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- 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:
-
-
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 theisEmpty()
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
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
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 interfaceToCopyableBuilder<GetCapacityReservationUsageResponse.Builder,
GetCapacityReservationUsageResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends GetCapacityReservationUsageResponse.Builder> serializableBuilderClass() -
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. 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, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- 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
-