flux.agent

Enum AgentStatus

java.lang.Object

java.lang.Enum<AgentStatus>

flux.agent.AgentStatus

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AgentStatus>

public enum AgentStatus
extends java.lang.Enum<AgentStatus>

Indicates the status of a Flux agent. An agent can be busy, free, or stopped.

Author:

Copyright 2000-2025 Flux Corporation. All rights reserved.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BUSY Indicates that a Flux agent is registered with a master Flux engine, is currently executing processes, and cannot be assigned any other processes to execute.
FREE Indicates that a Flux agent is registered with a master Flux engine and is free to be assigned a process to execute.
STOPPED Indicates that a Flux agent is registered with a master Flux engine, is not busy, and is not accepting processes to execute.
UNREACHABLE Indicates that a master Flux engine cannot contact a previously registered Flux agent.
UNREGISTERED Indicates that a Flux agent is not registered with a master Flux engine.

Method Summary

Modifier and Type	Method and Description
static AgentStatus	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static AgentStatus[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BUSY

public static final AgentStatus BUSY

Indicates that a Flux agent is registered with a master Flux engine, is currently executing processes, and cannot be assigned any other processes to execute.

FREE

public static final AgentStatus FREE

Indicates that a Flux agent is registered with a master Flux engine and is free to be assigned a process to execute.

STOPPED

public static final AgentStatus STOPPED

Indicates that a Flux agent is registered with a master Flux engine, is not busy, and is not accepting processes to execute.

UNREACHABLE

public static final AgentStatus UNREACHABLE

Indicates that a master Flux engine cannot contact a previously registered Flux agent.

UNREGISTERED

public static final AgentStatus UNREGISTERED

Indicates that a Flux agent is not registered with a master Flux engine.

Method Detail

values

public static AgentStatus[] 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 (AgentStatus c : AgentStatus.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AgentStatus valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null