Package software.amazon.awssdk.services.ec2.model

Class CapacityAllocation

java.lang.Object

software.amazon.awssdk.services.ec2.model.CapacityAllocation

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CapacityAllocation.Builder,CapacityAllocation>

@Generated("software.amazon.awssdk:codegen")
public final class CapacityAllocation
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CapacityAllocation.Builder,CapacityAllocation>

Information about instance capacity usage for a Capacity Reservation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CapacityAllocation.Builder

Method Summary

Modifier and Type	Method	Description
List<CapacityAllocationMetadataEntry>	allocationMetadata()	Additional metadata associated with the capacity allocation.
AllocationType	allocationType()	The usage type.
String	allocationTypeAsString()	The usage type.
static CapacityAllocation.Builder	builder()
Integer	count()	The amount of instance capacity associated with the usage.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAllocationMetadata()	For responses, this returns true if the service returned a value for the AllocationMetadata property.
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CapacityAllocation.Builder>	serializableBuilderClass()
CapacityAllocation.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

allocationType

public final AllocationType allocationType()

The usage type. used indicates that the instance capacity is in use by instances that are running in the Capacity Reservation.

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

Returns:

The usage type. used indicates that the instance capacity is in use by instances that are running in the Capacity Reservation.

See Also:

AllocationType

allocationTypeAsString

public final String allocationTypeAsString()

The usage type. used indicates that the instance capacity is in use by instances that are running in the Capacity Reservation.

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

Returns:

The usage type. used indicates that the instance capacity is in use by instances that are running in the Capacity Reservation.

See Also:

AllocationType

count

public final Integer count()

The amount of instance capacity associated with the usage. For example a value of 4 indicates that instance capacity for 4 instances is currently in use.

Returns:

The amount of instance capacity associated with the usage. For example a value of 4 indicates that instance capacity for 4 instances is currently in use.

hasAllocationMetadata

public final boolean hasAllocationMetadata()

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

allocationMetadata

public final List<CapacityAllocationMetadataEntry> allocationMetadata()

Additional metadata associated with the capacity allocation. Each entry contains a key-value pair providing context about the allocation.

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

Returns:

Additional metadata associated with the capacity allocation. Each entry contains a key-value pair providing context about the allocation.

toBuilder

public CapacityAllocation.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CapacityAllocation.Builder,CapacityAllocation>

builder

public static CapacityAllocation.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

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