Package com.openai.models.files

Class FileObject.Status

  • All Implemented Interfaces:
    com.openai.core.Enum 
    @Deprecated(message = "deprecated") 
public final class FileObject.Status
 implements Enum

    Deprecated. The current status of the file, which can be either uploaded, processed, or error.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      public enum FileObject.Status.Known

      An enum containing Status's known values.
      public enum FileObject.Status.Value

      An enum containing Status's known values, as well as an _UNKNOWN member.

      An instance of Status can contain an unknown value in a couple of cases:

      • It was deserialized from data that doesn't match any known member. For example, if the SDK is on an older version than the API, then the API may respond with new members that the SDK is unaware of.

      • It was constructed with an arbitrary value using the of method.

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Constructor Detail

    • Method Detail

      • _value

         final JsonField<String> _value()

        Returns this class instance's raw value.

        This is usually only useful if this instance was deserialized from data that doesn't match any known member, and you want to know that value. For example, if the SDK is on an older version than the API, then the API may respond with new members that the SDK is unaware of.

      • value

         final FileObject.Status.Value value()

        Returns an enum member corresponding to this class instance's value, or Value._UNKNOWN if the class was instantiated with an unknown value.

        Use the known method instead if you're certain the value is always known or if you want to throw for the unknown case.

      • known

         final FileObject.Status.Known known()

        Returns an enum member corresponding to this class instance's value.

        Use the value method instead if you're uncertain the value is always known and don't want to throw for the unknown case.

      • asString

         final String asString()

        Returns this class instance's primitive wire representation.

        This differs from the toString method because that method is primarily for debugging and generally doesn't throw.