Class ResponseFileSearchToolCall.Status
-
- All Implemented Interfaces:
-
com.openai.core.Enum
public final class ResponseFileSearchToolCall.Status implements EnumThe status of the file search tool call. One of
in_progress,searching,incompleteorfailed,
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public enumResponseFileSearchToolCall.Status.KnownAn enum containing Status's known values.
public enumResponseFileSearchToolCall.Status.ValueAn 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.
-
Field Summary
Fields Modifier and Type Field Description public final static ResponseFileSearchToolCall.StatusIN_PROGRESSpublic final static ResponseFileSearchToolCall.StatusSEARCHINGpublic final static ResponseFileSearchToolCall.StatusCOMPLETEDpublic final static ResponseFileSearchToolCall.StatusINCOMPLETEpublic final static ResponseFileSearchToolCall.StatusFAILED
-
Method Summary
Modifier and Type Method Description final JsonField<String>_value()Returns this class instance's raw value. final ResponseFileSearchToolCall.Status.Valuevalue()Returns an enum member corresponding to this class instance's value, or Value._UNKNOWN if the class was instantiated with an unknown value. final ResponseFileSearchToolCall.Status.Knownknown()Returns an enum member corresponding to this class instance's value. final StringasString()Returns this class instance's primitive wire representation. final ResponseFileSearchToolCall.Statusvalidate()final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static ResponseFileSearchToolCall.Statusof(String value)-
-
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 ResponseFileSearchToolCall.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 ResponseFileSearchToolCall.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.
-
validate
final ResponseFileSearchToolCall.Status validate()
-
of
final static ResponseFileSearchToolCall.Status of(String value)
-
-
-
-