Package com.azure.ai.openai.assistants.models

Class RunStatus

java.lang.Object

com.azure.core.util.ExpandableStringEnum<RunStatus>

com.azure.ai.openai.assistants.models.RunStatus

All Implemented Interfaces:

com.azure.core.util.ExpandableEnum<String>

public final class RunStatus
extends com.azure.core.util.ExpandableStringEnum<RunStatus>

Possible values for the status of an assistant thread run.

Field Summary

Fields

Modifier and Type	Field	Description
static final RunStatus	CANCELLED	Represents a run that has been cancelled.
static final RunStatus	CANCELLING	Represents a run that is in the process of cancellation.
static final RunStatus	COMPLETED	Represents a run that successfully completed.
static final RunStatus	EXPIRED	Represents a run that expired before it could otherwise finish.
static final RunStatus	FAILED	Represents a run that failed.
static final RunStatus	IN_PROGRESS	Represents a run that is in progress.
static final RunStatus	QUEUED	Represents a run that is queued to start.
static final RunStatus	REQUIRES_ACTION	Represents a run that needs another operation, such as tool output submission, to continue.

Constructor Summary

Constructors

Constructor	Description
RunStatus()	Deprecated. Use the fromString(String) factory method.

Method Summary

Modifier and Type	Method	Description
static RunStatus	fromString(String name)	Creates or finds a RunStatus from its string representation.
static Collection<RunStatus>	values()	Gets known RunStatus values.

Methods inherited from class com.azure.core.util.ExpandableStringEnum

equals, fromString, getValue, hashCode, toString, values

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

QUEUED

public static final RunStatus QUEUED

Represents a run that is queued to start.

IN_PROGRESS

public static final RunStatus IN_PROGRESS

Represents a run that is in progress.

REQUIRES_ACTION

public static final RunStatus REQUIRES_ACTION

Represents a run that needs another operation, such as tool output submission, to continue.

CANCELLING

public static final RunStatus CANCELLING

Represents a run that is in the process of cancellation.

CANCELLED

public static final RunStatus CANCELLED

Represents a run that has been cancelled.

FAILED

public static final RunStatus FAILED

Represents a run that failed.

COMPLETED

public static final RunStatus COMPLETED

Represents a run that successfully completed.

EXPIRED

public static final RunStatus EXPIRED

Represents a run that expired before it could otherwise finish.

Constructor Details

RunStatus

@Deprecated
public RunStatus()

Deprecated.

Use the fromString(String) factory method.

Creates a new instance of RunStatus value.

Method Details

fromString

public static RunStatus fromString(String name)

Creates or finds a RunStatus from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding RunStatus.

values

public static Collection<RunStatus> values()

Gets known RunStatus values.

Returns:

known RunStatus values.