Package com.azure.ai.openai.models

Class State

java.lang.Object
com.azure.core.util.ExpandableStringEnum<State>
com.azure.ai.openai.models.State
public final class State extends com.azure.core.util.ExpandableStringEnum<State>
The state of a job or item.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final State
    CANCELED
    The operation has been canceled and is incomplete.
    static final State
    DELETED
    The entity has been deleted but may still be referenced by other entities predating the deletion.
    static final State
    FAILED
    The operation has completed processing with a failure and cannot be further consumed.
    static final State
    NOT_RUNNING
    The operation was created and is queued to be processed in the future.
    static final State
    RUNNING
    The operation has started to be processed.
    static final State
    SUCCEEDED
    The operation has successfully be processed and is ready for consumption.

  • Constructor Summary

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

  • Method Summary

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

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

    equals, fromString, hashCode, toString, values

    Methods inherited from class java.lang.Object

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

  • Field Details

    • NOT_RUNNING

      public static final State NOT_RUNNING
      The operation was created and is queued to be processed in the future.

    • RUNNING

      public static final State RUNNING
      The operation has started to be processed.

    • SUCCEEDED

      public static final State SUCCEEDED
      The operation has successfully be processed and is ready for consumption.

    • CANCELED

      public static final State CANCELED
      The operation has been canceled and is incomplete.

    • FAILED

      public static final State FAILED
      The operation has completed processing with a failure and cannot be further consumed.

    • DELETED

      public static final State DELETED
      The entity has been deleted but may still be referenced by other entities predating the deletion.

  • Constructor Details

  • Method Details

    • fromString

      public static State fromString(String name)
      Creates or finds a State from its string representation.
      Parameters:
      name - a name to look for.
      Returns:
      the corresponding State.

    • values

      public static Collection<State> values()
      Gets known State values.
      Returns:
      known State values.