Enum WorkerPoolStatus

java.lang.Object
java.lang.Enum<WorkerPoolStatus>
co.yellowdog.platform.model.WorkerPoolStatus
All Implemented Interfaces:
Serializable, Comparable<WorkerPoolStatus>, java.lang.constant.Constable
public enum WorkerPoolStatus extends Enum<WorkerPoolStatus>
Indicates the status of a worker pool

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    CONFIGURING
    The nodes in the worker pool are being identified and their node types are being set.
    EMPTY
    The worker pool has no registered workers.
    IDLE
    The worker pool has registered workers but none are currently claimed.
    PENDING
    The worker pool has been started but no workers have yet registered.
    RUNNING
    One or more workers are claimed.
    SHUTDOWN
    The worker pool is shutdown and any workers are instructed to shutdown.
    TERMINATED
    The worker pool is terminated and the associated compute requirement is terminated (provisioned worker pool) or all nodes have shutdown (configured worker pool).

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    isAvailable()
    Returns true, if the status indicates the pool is currently available (i.e.
    boolean
    isFinished()
    Returns true, if the status indicates the pool has finished and will do no further work; otherwise, false.
    static WorkerPoolStatus
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static WorkerPoolStatus[]
    values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • PENDING

      public static final WorkerPoolStatus PENDING
      The worker pool has been started but no workers have yet registered.

    • CONFIGURING

      public static final WorkerPoolStatus CONFIGURING
      The nodes in the worker pool are being identified and their node types are being set.

    • EMPTY

      public static final WorkerPoolStatus EMPTY
      The worker pool has no registered workers.

    • IDLE

      public static final WorkerPoolStatus IDLE
      The worker pool has registered workers but none are currently claimed.

    • RUNNING

      public static final WorkerPoolStatus RUNNING
      One or more workers are claimed.

    • SHUTDOWN

      public static final WorkerPoolStatus SHUTDOWN
      The worker pool is shutdown and any workers are instructed to shutdown.

    • TERMINATED

      public static final WorkerPoolStatus TERMINATED
      The worker pool is terminated and the associated compute requirement is terminated (provisioned worker pool) or all nodes have shutdown (configured worker pool).

  • Method Details

    • values

      public static WorkerPoolStatus[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static WorkerPoolStatus valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • isAvailable

      public boolean isAvailable()
      Returns true, if the status indicates the pool is currently available (i.e. workers can register, be claimed and do work); otherwise, false.
      Returns:
      true, if the status indicates the pool is currently available; otherwise, false

    • isFinished

      public boolean isFinished()
      Returns true, if the status indicates the pool has finished and will do no further work; otherwise, false.
      Returns:
      true, if the status indicates the pool has finished and will do no further work; otherwise, false