BatchStatus Class

Reference

Package:: com.azure.ai.openai.models

Maven Artifact:: com.azure:azure-ai-openai:1.0.0-beta.12

java.lang.Object
- com.azure.core.util.ExpandableStringEnum<T>
- - com.azure.ai.openai.models.BatchStatus

public final class BatchStatus
extends ExpandableStringEnum<BatchStatus>

The status of a batch.

Field Summary

Modifier and Type	Field and Description
static final BatchStatus	CANCELLED The batch was cancelled.
static final BatchStatus	CANCELLING Cancellation of the batch has been initiated.
static final BatchStatus	COMPLETED The batch has been completed and the results are ready.
static final BatchStatus	EXPIRED The batch was not able to complete within the 24-hour time window.
static final BatchStatus	FAILED The input file has failed the validation process.
static final BatchStatus	FINALIZING The batch has completed and the results are being prepared.
static final BatchStatus	IN_PROGRESS The input file was successfully validated and the batch is currently being executed.
static final BatchStatus	VALIDATING The input file is being validated before the batch can begin.

Constructor Summary

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

Constructor

Description

BatchStatus()

Deprecated

Use the fromString(String name) factory method.

Creates a new instance of BatchStatus value.

Method Summary

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

The batch was cancelled.

CANCELLING

public static final BatchStatus CANCELLING

Cancellation of the batch has been initiated.

COMPLETED

public static final BatchStatus COMPLETED

The batch has been completed and the results are ready.

EXPIRED

public static final BatchStatus EXPIRED

The batch was not able to complete within the 24-hour time window.

FAILED

public static final BatchStatus FAILED

The input file has failed the validation process.

FINALIZING

public static final BatchStatus FINALIZING

The batch has completed and the results are being prepared.

IN_PROGRESS

public static final BatchStatus IN_PROGRESS

The input file was successfully validated and the batch is currently being executed.

VALIDATING

public static final BatchStatus VALIDATING

The input file is being validated before the batch can begin.

Constructor Details

BatchStatus

@Deprecated
public BatchStatus()

Deprecated

Use the fromString(String name) factory method.

Creates a new instance of BatchStatus value.

Method Details

fromString

public static BatchStatus fromString(String name)

Creates or finds a BatchStatus from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding BatchStatus.

values

public static Collection values()

Gets known BatchStatus values.