Enum Class BatchState

java.lang.Object

java.lang.Enum<BatchState>

dev.langchain4j.model.batch.BatchState

All Implemented Interfaces:

Serializable, Comparable<BatchState>, Constable

@Experimental
public enum BatchState
extends Enum<BatchState>

Represents the possible states of a batch job.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CANCELLED
EXPIRED
FAILED
PENDING
RUNNING
SUCCEEDED
UNSPECIFIED

Method Summary

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

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PENDING

public static final BatchState PENDING

RUNNING

public static final BatchState RUNNING

SUCCEEDED

public static final BatchState SUCCEEDED

FAILED

public static final BatchState FAILED

CANCELLED

public static final BatchState CANCELLED

EXPIRED

public static final BatchState EXPIRED

UNSPECIFIED

public static final BatchState UNSPECIFIED

Method Details

values

public static BatchState[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static BatchState valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

isTerminal

public boolean isTerminal()