Package software.amazon.awssdk.services.athena.model

Class CapacityReservation

java.lang.Object

software.amazon.awssdk.services.athena.model.CapacityReservation

All Implemented Interfaces:

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

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

A reservation for a specified number of data processing units (DPUs). When a reservation is initially created, it has no DPUs. Athena allocates DPUs until the allocated amount equals the requested amount.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CapacityReservation.Builder

Method Summary

Modifier and Type	Method	Description
Integer	allocatedDpus()	The number of data processing units currently allocated.
static CapacityReservation.Builder	builder()
Instant	creationTime()	The time in UTC epoch millis when the capacity reservation was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
CapacityAllocation	lastAllocation()	Returns the value of the LastAllocation property for this object.
Instant	lastSuccessfulAllocationTime()	The time of the most recent capacity allocation that succeeded.
String	name()	The name of the capacity reservation.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CapacityReservation.Builder>	serializableBuilderClass()
CapacityReservationStatus	status()	The status of the capacity reservation.
String	statusAsString()	The status of the capacity reservation.
Integer	targetDpus()	The number of data processing units requested.
CapacityReservation.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

name

public final String name()

The name of the capacity reservation.

Returns:

The name of the capacity reservation.

status

public final CapacityReservationStatus status()

The status of the capacity reservation.

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

Returns:

The status of the capacity reservation.

See Also:

CapacityReservationStatus

statusAsString

public final String statusAsString()

The status of the capacity reservation.

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

Returns:

The status of the capacity reservation.

See Also:

CapacityReservationStatus

targetDpus

public final Integer targetDpus()

The number of data processing units requested.

Returns:

The number of data processing units requested.

allocatedDpus

public final Integer allocatedDpus()

The number of data processing units currently allocated.

Returns:

The number of data processing units currently allocated.

lastAllocation

public final CapacityAllocation lastAllocation()

Returns the value of the LastAllocation property for this object.

Returns:

The value of the LastAllocation property for this object.

lastSuccessfulAllocationTime

public final Instant lastSuccessfulAllocationTime()

The time of the most recent capacity allocation that succeeded.

Returns:

The time of the most recent capacity allocation that succeeded.

creationTime

public final Instant creationTime()

The time in UTC epoch millis when the capacity reservation was created.

Returns:

The time in UTC epoch millis when the capacity reservation was created.

toBuilder

public CapacityReservation.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CapacityReservation.Builder,CapacityReservation>

builder

public static CapacityReservation.Builder builder()

serializableBuilderClass

public static Class<? extends CapacityReservation.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