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

Class FairshareUtilizationDetail

java.lang.Object

software.amazon.awssdk.services.batch.model.FairshareUtilizationDetail

All Implemented Interfaces:

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

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

The fairshare utilization for a job queue, including the number of active shares and top capacity utilization.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FairshareUtilizationDetail.Builder

Method Summary

Modifier and Type	Method	Description
Long	activeShareCount()	The total number of active shares in the fairshare scheduling job queue that are currently utilizing capacity.
static FairshareUtilizationDetail.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTopCapacityUtilization()	For responses, this returns true if the service returned a value for the TopCapacityUtilization property.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends FairshareUtilizationDetail.Builder>	serializableBuilderClass()
FairshareUtilizationDetail.Builder	toBuilder()
List<FairshareCapacityUtilization>	topCapacityUtilization()	A list of the top 20 shares with the highest capacity utilization, ordered by usage amount.
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

activeShareCount

public final Long activeShareCount()

The total number of active shares in the fairshare scheduling job queue that are currently utilizing capacity.

Returns:

The total number of active shares in the fairshare scheduling job queue that are currently utilizing capacity.

hasTopCapacityUtilization

public final boolean hasTopCapacityUtilization()

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

topCapacityUtilization

public final List<FairshareCapacityUtilization> topCapacityUtilization()

A list of the top 20 shares with the highest capacity utilization, ordered by usage amount.

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

Returns:

A list of the top 20 shares with the highest capacity utilization, ordered by usage amount.

toBuilder

public FairshareUtilizationDetail.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<FairshareUtilizationDetail.Builder,FairshareUtilizationDetail>

builder

public static FairshareUtilizationDetail.Builder builder()

serializableBuilderClass

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