Enum ComputeNodeState

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      CREATING
      The Batch service has obtained the underlying virtual machine from Azure Compute, but it has not yet started to join the Pool.
      IDLE
      The Compute Node is not currently running a Task.
      LEAVING_POOL
      The Compute Node is leaving the Pool, either because the user explicitly removed it or because the Pool is resizing or autoscaling down.
      OFFLINE
      The Compute Node is not currently running a Task, and scheduling of new Tasks to the Compute Node is disabled.
      PREEMPTED
      The low-priority Compute Node has been preempted.
      REBOOTING
      The Compute Node is rebooting.
      REIMAGING
      The Compute Node is reimaging.
      RUNNING
      The Compute Node is running one or more Tasks (other than a StartTask).
      START_TASK_FAILED
      The StartTask has failed on the Compute Node (and exhausted all retries), and waitForSuccess is set.
      STARTING
      The Batch service is starting on the underlying virtual machine.
      UNKNOWN
      The Batch service has lost contact with the Compute Node, and does not know its true state.
      UNUSABLE
      The Compute Node cannot be used for Task execution due to errors.
      WAITING_FOR_START_TASK
      The StartTask has started running on the Compute Node, but waitForSuccess is set and the StartTask has not yet completed.
    • Enum Constant Detail

      • IDLE

        public static final ComputeNodeState IDLE
        The Compute Node is not currently running a Task.
      • REBOOTING

        public static final ComputeNodeState REBOOTING
        The Compute Node is rebooting.
      • REIMAGING

        public static final ComputeNodeState REIMAGING
        The Compute Node is reimaging.
      • RUNNING

        public static final ComputeNodeState RUNNING
        The Compute Node is running one or more Tasks (other than a StartTask).
      • UNUSABLE

        public static final ComputeNodeState UNUSABLE
        The Compute Node cannot be used for Task execution due to errors.
      • CREATING

        public static final ComputeNodeState CREATING
        The Batch service has obtained the underlying virtual machine from Azure Compute, but it has not yet started to join the Pool.
      • STARTING

        public static final ComputeNodeState STARTING
        The Batch service is starting on the underlying virtual machine.
      • WAITING_FOR_START_TASK

        public static final ComputeNodeState WAITING_FOR_START_TASK
        The StartTask has started running on the Compute Node, but waitForSuccess is set and the StartTask has not yet completed.
      • START_TASK_FAILED

        public static final ComputeNodeState START_TASK_FAILED
        The StartTask has failed on the Compute Node (and exhausted all retries), and waitForSuccess is set. The Compute Node is not usable for running Tasks.
      • UNKNOWN

        public static final ComputeNodeState UNKNOWN
        The Batch service has lost contact with the Compute Node, and does not know its true state.
      • LEAVING_POOL

        public static final ComputeNodeState LEAVING_POOL
        The Compute Node is leaving the Pool, either because the user explicitly removed it or because the Pool is resizing or autoscaling down.
      • OFFLINE

        public static final ComputeNodeState OFFLINE
        The Compute Node is not currently running a Task, and scheduling of new Tasks to the Compute Node is disabled.
      • PREEMPTED

        public static final ComputeNodeState PREEMPTED
        The low-priority Compute Node has been preempted. Tasks which were running on the Compute Node when it was preempted will be rescheduled when another Compute Node becomes available.
    • Method Detail

      • values

        public static ComputeNodeState[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (ComputeNodeState c : ComputeNodeState.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static ComputeNodeState 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
      • fromString

        public static ComputeNodeState fromString​(String value)
        Parses a serialized value to a ComputeNodeState instance.
        Parameters:
        value - the serialized value to parse.
        Returns:
        the parsed ComputeNodeState object, or null if unable to parse.