Class SchedulingConfiguration

java.lang.Object
software.amazon.awssdk.services.deadline.model.SchedulingConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<SchedulingConfiguration.Builder,SchedulingConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class SchedulingConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SchedulingConfiguration.Builder,SchedulingConfiguration>

The scheduling configuration for a queue. Defines the strategy used to assign workers to jobs.

See Also:

  • Method Details

    • priorityFifo

      public final PriorityFifoSchedulingConfiguration priorityFifo()

      Workers are assigned to the highest-priority job first. When multiple jobs share the same priority, the job submitted earliest receives workers first. This is the default scheduling configuration for new queues.

      Returns:
      Workers are assigned to the highest-priority job first. When multiple jobs share the same priority, the job submitted earliest receives workers first. This is the default scheduling configuration for new queues.

    • priorityBalanced

      public final PriorityBalancedSchedulingConfiguration priorityBalanced()

      Workers are distributed evenly across all jobs at the highest priority level. When workers cannot be evenly divided, the extra workers are assigned to the jobs submitted earliest. If a job has fewer remaining tasks than its share of workers, the surplus workers are redistributed to other jobs at the same priority level.

      Returns:
      Workers are distributed evenly across all jobs at the highest priority level. When workers cannot be evenly divided, the extra workers are assigned to the jobs submitted earliest. If a job has fewer remaining tasks than its share of workers, the surplus workers are redistributed to other jobs at the same priority level.

    • weightedBalanced

      public final WeightedBalancedSchedulingConfiguration weightedBalanced()

      Workers are assigned to jobs based on a weighted formula that considers job priority, error count, submission time, and the number of tasks currently rendering. Each factor has a configurable weight that determines its influence on scheduling decisions.

      Returns:
      Workers are assigned to jobs based on a weighted formula that considers job priority, error count, submission time, and the number of tasks currently rendering. Each factor has a configurable weight that determines its influence on scheduling decisions.

    • toBuilder

      public SchedulingConfiguration.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<SchedulingConfiguration.Builder,SchedulingConfiguration>
      Returns:
      a builder for type T

    • builder

      public static SchedulingConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SchedulingConfiguration.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)

    • fromPriorityFifo

      public static SchedulingConfiguration fromPriorityFifo(PriorityFifoSchedulingConfiguration priorityFifo)
      Create an instance of this class with priorityFifo() initialized to the given value.

      Workers are assigned to the highest-priority job first. When multiple jobs share the same priority, the job submitted earliest receives workers first. This is the default scheduling configuration for new queues.

      Parameters:
      priorityFifo - Workers are assigned to the highest-priority job first. When multiple jobs share the same priority, the job submitted earliest receives workers first. This is the default scheduling configuration for new queues.

    • fromPriorityFifo

      public static SchedulingConfiguration fromPriorityFifo(Consumer<PriorityFifoSchedulingConfiguration.Builder> priorityFifo)
      Create an instance of this class with priorityFifo() initialized to the given value.

      Workers are assigned to the highest-priority job first. When multiple jobs share the same priority, the job submitted earliest receives workers first. This is the default scheduling configuration for new queues.

      Parameters:
      priorityFifo - Workers are assigned to the highest-priority job first. When multiple jobs share the same priority, the job submitted earliest receives workers first. This is the default scheduling configuration for new queues.

    • fromPriorityBalanced

      public static SchedulingConfiguration fromPriorityBalanced(PriorityBalancedSchedulingConfiguration priorityBalanced)
      Create an instance of this class with priorityBalanced() initialized to the given value.

      Workers are distributed evenly across all jobs at the highest priority level. When workers cannot be evenly divided, the extra workers are assigned to the jobs submitted earliest. If a job has fewer remaining tasks than its share of workers, the surplus workers are redistributed to other jobs at the same priority level.

      Parameters:
      priorityBalanced - Workers are distributed evenly across all jobs at the highest priority level. When workers cannot be evenly divided, the extra workers are assigned to the jobs submitted earliest. If a job has fewer remaining tasks than its share of workers, the surplus workers are redistributed to other jobs at the same priority level.

    • fromPriorityBalanced

      public static SchedulingConfiguration fromPriorityBalanced(Consumer<PriorityBalancedSchedulingConfiguration.Builder> priorityBalanced)
      Create an instance of this class with priorityBalanced() initialized to the given value.

      Workers are distributed evenly across all jobs at the highest priority level. When workers cannot be evenly divided, the extra workers are assigned to the jobs submitted earliest. If a job has fewer remaining tasks than its share of workers, the surplus workers are redistributed to other jobs at the same priority level.

      Parameters:
      priorityBalanced - Workers are distributed evenly across all jobs at the highest priority level. When workers cannot be evenly divided, the extra workers are assigned to the jobs submitted earliest. If a job has fewer remaining tasks than its share of workers, the surplus workers are redistributed to other jobs at the same priority level.

    • fromWeightedBalanced

      public static SchedulingConfiguration fromWeightedBalanced(WeightedBalancedSchedulingConfiguration weightedBalanced)
      Create an instance of this class with weightedBalanced() initialized to the given value.

      Workers are assigned to jobs based on a weighted formula that considers job priority, error count, submission time, and the number of tasks currently rendering. Each factor has a configurable weight that determines its influence on scheduling decisions.

      Parameters:
      weightedBalanced - Workers are assigned to jobs based on a weighted formula that considers job priority, error count, submission time, and the number of tasks currently rendering. Each factor has a configurable weight that determines its influence on scheduling decisions.

    • fromWeightedBalanced

      public static SchedulingConfiguration fromWeightedBalanced(Consumer<WeightedBalancedSchedulingConfiguration.Builder> weightedBalanced)
      Create an instance of this class with weightedBalanced() initialized to the given value.

      Workers are assigned to jobs based on a weighted formula that considers job priority, error count, submission time, and the number of tasks currently rendering. Each factor has a configurable weight that determines its influence on scheduling decisions.

      Parameters:
      weightedBalanced - Workers are assigned to jobs based on a weighted formula that considers job priority, error count, submission time, and the number of tasks currently rendering. Each factor has a configurable weight that determines its influence on scheduling decisions.

    • type

      public SchedulingConfiguration.Type type()
      Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be SchedulingConfiguration.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be SchedulingConfiguration.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.