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

Class RunStreamEvent

java.lang.Object

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

com.azure.ai.openai.assistants.models.RunStreamEvent

All Implemented Interfaces:

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

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

Run operation related streaming events.

Field Summary

Fields

Modifier and Type	Field	Description
static final RunStreamEvent	THREAD_RUN_CANCELLED	Event sent when a run is cancelled.
static final RunStreamEvent	THREAD_RUN_CANCELLING	Event sent when a run moves to `cancelling` status.
static final RunStreamEvent	THREAD_RUN_COMPLETED	Event sent when a run is completed.
static final RunStreamEvent	THREAD_RUN_CREATED	Event sent when a new run is created.
static final RunStreamEvent	THREAD_RUN_EXPIRED	Event sent when a run is expired.
static final RunStreamEvent	THREAD_RUN_FAILED	Event sent when a run fails.
static final RunStreamEvent	THREAD_RUN_IN_PROGRESS	Event sent when a run moves to `in_progress` status.
static final RunStreamEvent	THREAD_RUN_QUEUED	Event sent when a run moves to `queued` status.
static final RunStreamEvent	THREAD_RUN_REQUIRES_ACTION	Event sent when a run moves to `requires_action` status.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static RunStreamEvent	fromString(String name)	Creates or finds a RunStreamEvent from its string representation.
static Collection<RunStreamEvent>	values()	Gets known RunStreamEvent 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

THREAD_RUN_CREATED

public static final RunStreamEvent THREAD_RUN_CREATED

Event sent when a new run is created. The data of this event is of type ThreadRun.

THREAD_RUN_QUEUED

public static final RunStreamEvent THREAD_RUN_QUEUED

Event sent when a run moves to `queued` status. The data of this event is of type ThreadRun.

THREAD_RUN_IN_PROGRESS

public static final RunStreamEvent THREAD_RUN_IN_PROGRESS

Event sent when a run moves to `in_progress` status. The data of this event is of type ThreadRun.

THREAD_RUN_REQUIRES_ACTION

public static final RunStreamEvent THREAD_RUN_REQUIRES_ACTION

Event sent when a run moves to `requires_action` status. The data of this event is of type ThreadRun.

THREAD_RUN_COMPLETED

public static final RunStreamEvent THREAD_RUN_COMPLETED

Event sent when a run is completed. The data of this event is of type ThreadRun.

THREAD_RUN_FAILED

public static final RunStreamEvent THREAD_RUN_FAILED

Event sent when a run fails. The data of this event is of type ThreadRun.

THREAD_RUN_CANCELLING

public static final RunStreamEvent THREAD_RUN_CANCELLING

Event sent when a run moves to `cancelling` status. The data of this event is of type ThreadRun.

THREAD_RUN_CANCELLED

public static final RunStreamEvent THREAD_RUN_CANCELLED

Event sent when a run is cancelled. The data of this event is of type ThreadRun.

THREAD_RUN_EXPIRED

public static final RunStreamEvent THREAD_RUN_EXPIRED

Event sent when a run is expired. The data of this event is of type ThreadRun.

Constructor Details

RunStreamEvent

@Deprecated
public RunStreamEvent()

Deprecated.

Use the fromString(String) factory method.

Creates a new instance of RunStreamEvent value.

Method Details

fromString

public static RunStreamEvent fromString(String name)

Creates or finds a RunStreamEvent from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding RunStreamEvent.

values

public static Collection<RunStreamEvent> values()

Gets known RunStreamEvent values.

Returns:

known RunStreamEvent values.