Package software.amazon.awssdk.services.sagemaker.model

Class SchedulerConfig

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.SchedulerConfig

All Implemented Interfaces:

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

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

Cluster policy configuration. This policy is used for task prioritization and fair-share allocation. This helps prioritize critical workloads and distributes idle compute across entities.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SchedulerConfig.Builder

Method Summary

Modifier and Type	Method	Description
static SchedulerConfig.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
FairShare	fairShare()	When enabled, entities borrow idle compute based on their assigned FairShareWeight.
String	fairShareAsString()	When enabled, entities borrow idle compute based on their assigned FairShareWeight.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPriorityClasses()	For responses, this returns true if the service returned a value for the PriorityClasses property.
List<PriorityClass>	priorityClasses()	List of the priority classes, PriorityClass, of the cluster policy.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends SchedulerConfig.Builder>	serializableBuilderClass()
SchedulerConfig.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

hasPriorityClasses

public final boolean hasPriorityClasses()

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

priorityClasses

public final List<PriorityClass> priorityClasses()

List of the priority classes, PriorityClass, of the cluster policy. When specified, these class configurations define how tasks are queued.

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

Returns:

List of the priority classes, PriorityClass, of the cluster policy. When specified, these class configurations define how tasks are queued.

fairShare

public final FairShare fairShare()

When enabled, entities borrow idle compute based on their assigned FairShareWeight.

When disabled, entities borrow idle compute based on a first-come first-serve basis.

Default is Enabled.

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

Returns:

When enabled, entities borrow idle compute based on their assigned FairShareWeight.

When disabled, entities borrow idle compute based on a first-come first-serve basis.

Default is Enabled.

See Also:

FairShare

fairShareAsString

public final String fairShareAsString()

When enabled, entities borrow idle compute based on their assigned FairShareWeight.

When disabled, entities borrow idle compute based on a first-come first-serve basis.

Default is Enabled.

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

Returns:

When enabled, entities borrow idle compute based on their assigned FairShareWeight.

When disabled, entities borrow idle compute based on a first-come first-serve basis.

Default is Enabled.

See Also:

FairShare

toBuilder

public SchedulerConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SchedulerConfig.Builder,SchedulerConfig>

builder

public static SchedulerConfig.Builder builder()

serializableBuilderClass

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