RunStatus Class

Package:

com.azure.ai.agents.persistent.models

Maven Artifact:

com.azure:azure-ai-agents-persistent:1.0.0-beta.2

• java.lang.Object
• • com.azure.core.util.ExpandableStringEnum<T>
  • • com.azure.ai.agents.persistent.models.RunStatus

public final class RunStatus
extends ExpandableStringEnum<RunStatus>

Possible values for the status of an agent thread run.

Field Summary

Modifier and Type	Field and 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

Constructor	Description
RunStatus()	Deprecated Use the fromString(String name) factory method. Creates a new instance of RunStatus value.

Method Summary

Modifier and Type	Method and 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 ExpandableStringEnum

<T>fromString <T>values equals getValue hashCode toString

Methods inherited from java.lang.Object

clone finalize getClass notify notifyAll wait wait wait

Field Details

CANCELLED

public static final RunStatus CANCELLED

Represents a run that has been cancelled.

CANCELLING

public static final RunStatus CANCELLING

Represents a run that is in the process of cancellation.

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.

FAILED

public static final RunStatus FAILED

Represents a run that failed.

IN_PROGRESS

public static final RunStatus IN_PROGRESS

Represents a run that is in progress.

QUEUED

public static final RunStatus QUEUED

Represents a run that is queued to start.

REQUIRES_ACTION

public static final RunStatus REQUIRES_ACTION

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

Constructor Details

RunStatus

@Deprecated
public RunStatus()

Deprecated

Use the fromString(String name) 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.