Package software.amazon.awssdk.services.batch.model

Class QueueSnapshotUtilizationDetail

java.lang.Object

software.amazon.awssdk.services.batch.model.QueueSnapshotUtilizationDetail

All Implemented Interfaces:

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

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

The job queue utilization at a specific point in time, including total capacity usage, and quota share or fairshare utilization breakdown depending on the job queue scheduling policy.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	QueueSnapshotUtilizationDetail.Builder

Method Summary

Modifier and Type	Method	Description
static QueueSnapshotUtilizationDetail.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
FairshareUtilizationDetail	fairshareUtilization()	The utilization information for a fairshare scheduling job queues, including active share count and top capacity utilization by share.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTotalCapacityUsage()	For responses, this returns true if the service returned a value for the TotalCapacityUsage property.
Long	lastUpdatedAt()	The Unix timestamp (in milliseconds) for when the queue utilization information was last updated.
QuotaShareUtilizationDetail	quotaShareUtilization()	The utilization information for a job queue with a quota share scheduling policy.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends QueueSnapshotUtilizationDetail.Builder>	serializableBuilderClass()
QueueSnapshotUtilizationDetail.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<QueueSnapshotCapacityUsage>	totalCapacityUsage()	The total capacity usage for the entire job queue.

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

hasTotalCapacityUsage

public final boolean hasTotalCapacityUsage()

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

totalCapacityUsage

public final List<QueueSnapshotCapacityUsage> totalCapacityUsage()

The total capacity usage for the entire job queue.

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

Returns:

The total capacity usage for the entire job queue.

fairshareUtilization

public final FairshareUtilizationDetail fairshareUtilization()

The utilization information for a fairshare scheduling job queues, including active share count and top capacity utilization by share.

Returns:

The utilization information for a fairshare scheduling job queues, including active share count and top capacity utilization by share.

quotaShareUtilization

public final QuotaShareUtilizationDetail quotaShareUtilization()

The utilization information for a job queue with a quota share scheduling policy.

Returns:

The utilization information for a job queue with a quota share scheduling policy.

lastUpdatedAt

public final Long lastUpdatedAt()

The Unix timestamp (in milliseconds) for when the queue utilization information was last updated.

Returns:

The Unix timestamp (in milliseconds) for when the queue utilization information was last updated.

toBuilder

public QueueSnapshotUtilizationDetail.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<QueueSnapshotUtilizationDetail.Builder,QueueSnapshotUtilizationDetail>

builder

public static QueueSnapshotUtilizationDetail.Builder builder()

serializableBuilderClass

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