software.amazon.awssdk.services.batch.model

Class FairsharePolicy

java.lang.Object

software.amazon.awssdk.services.batch.model.FairsharePolicy

All Implemented Interfaces:

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

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

The fair share policy for a scheduling policy.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FairsharePolicy.Builder

Method Summary

Modifier and Type	Method and Description
static FairsharePolicy.Builder	builder()
Integer	computeReservation() A value used to reserve some of the available maximum vCPU for fair share identifiers that aren't already used.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasShareDistribution() For responses, this returns true if the service returned a value for the ShareDistribution property.
List<SdkField<?>>	sdkFields()
static Class<? extends FairsharePolicy.Builder>	serializableBuilderClass()
Integer	shareDecaySeconds() The amount of time (in seconds) to use to calculate a fair share percentage for each fair share identifier in use.
List<ShareAttributes>	shareDistribution() An array of SharedIdentifier objects that contain the weights for the fair share identifiers for the fair share policy.
FairsharePolicy.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

shareDecaySeconds

public final Integer shareDecaySeconds()

The amount of time (in seconds) to use to calculate a fair share percentage for each fair share identifier in use. A value of zero (0) indicates that only current usage is measured. The decay allows for more recently run jobs to have more weight than jobs that ran earlier. The maximum supported value is 604800 (1 week).

Returns:

The amount of time (in seconds) to use to calculate a fair share percentage for each fair share identifier in use. A value of zero (0) indicates that only current usage is measured. The decay allows for more recently run jobs to have more weight than jobs that ran earlier. The maximum supported value is 604800 (1 week).

computeReservation

public final Integer computeReservation()

A value used to reserve some of the available maximum vCPU for fair share identifiers that aren't already used.

The reserved ratio is (computeReservation/100)^ActiveFairShares where ActiveFairShares is the number of active fair share identifiers.

For example, a computeReservation value of 50 indicates that Batchreserves 50% of the maximum available vCPU if there's only one fair share identifier. It reserves 25% if there are two fair share identifiers. It reserves 12.5% if there are three fair share identifiers. A computeReservation value of 25 indicates that Batch should reserve 25% of the maximum available vCPU if there's only one fair share identifier, 6.25% if there are two fair share identifiers, and 1.56% if there are three fair share identifiers.

The minimum value is 0 and the maximum value is 99.

Returns:

A value used to reserve some of the available maximum vCPU for fair share identifiers that aren't already used.

The reserved ratio is (computeReservation/100)^ActiveFairShares where ActiveFairShares is the number of active fair share identifiers.

For example, a computeReservation value of 50 indicates that Batchreserves 50% of the maximum available vCPU if there's only one fair share identifier. It reserves 25% if there are two fair share identifiers. It reserves 12.5% if there are three fair share identifiers. A computeReservation value of 25 indicates that Batch should reserve 25% of the maximum available vCPU if there's only one fair share identifier, 6.25% if there are two fair share identifiers, and 1.56% if there are three fair share identifiers.

The minimum value is 0 and the maximum value is 99.

hasShareDistribution

public final boolean hasShareDistribution()

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

shareDistribution

public final List<ShareAttributes> shareDistribution()

An array of SharedIdentifier objects that contain the weights for the fair share identifiers for the fair share policy. Fair share identifiers that aren't included have a default weight of 1.0.

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

Returns:

An array of SharedIdentifier objects that contain the weights for the fair share identifiers for the fair share policy. Fair share identifiers that aren't included have a default weight of 1.0.

toBuilder

public FairsharePolicy.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<FairsharePolicy.Builder,FairsharePolicy>

builder

public static FairsharePolicy.Builder builder()

serializableBuilderClass

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