Class ResponseFileSearchCallInProgressEvent
-
- All Implemented Interfaces:
public final class ResponseFileSearchCallInProgressEvent
Emitted when a file search call is initiated.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
ResponseFileSearchCallInProgressEvent.Builder
A builder for ResponseFileSearchCallInProgressEvent.
-
Method Summary
Modifier and Type Method Description final String
itemId()
The ID of the output item that the file search call is initiated. final Long
outputIndex()
The index of the output item that the file search call is initiated. final Long
sequenceNumber()
The sequence number of this event. final JsonValue
_type()
The type of the event. final JsonField<String>
_itemId()
Returns the raw JSON value of itemId. final JsonField<Long>
_outputIndex()
Returns the raw JSON value of outputIndex. final JsonField<Long>
_sequenceNumber()
Returns the raw JSON value of sequenceNumber. final Map<String, JsonValue>
_additionalProperties()
final ResponseFileSearchCallInProgressEvent.Builder
toBuilder()
final ResponseFileSearchCallInProgressEvent
validate()
final Boolean
isValid()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static ResponseFileSearchCallInProgressEvent.Builder
builder()
Returns a mutable builder for constructing an instance of ResponseFileSearchCallInProgressEvent. -
-
Method Detail
-
outputIndex
final Long outputIndex()
The index of the output item that the file search call is initiated.
-
sequenceNumber
final Long sequenceNumber()
The sequence number of this event.
-
_type
final JsonValue _type()
The type of the event. Always
response.file_search_call.in_progress
.Expected to always return the following:
JsonValue.from("response.file_search_call.in_progress")
However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
_itemId
final JsonField<String> _itemId()
Returns the raw JSON value of itemId.
Unlike itemId, this method doesn't throw if the JSON field has an unexpected type.
-
_outputIndex
final JsonField<Long> _outputIndex()
Returns the raw JSON value of outputIndex.
Unlike outputIndex, this method doesn't throw if the JSON field has an unexpected type.
-
_sequenceNumber
final JsonField<Long> _sequenceNumber()
Returns the raw JSON value of sequenceNumber.
Unlike sequenceNumber, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final ResponseFileSearchCallInProgressEvent.Builder toBuilder()
-
validate
final ResponseFileSearchCallInProgressEvent validate()
-
builder
final static ResponseFileSearchCallInProgressEvent.Builder builder()
Returns a mutable builder for constructing an instance of ResponseFileSearchCallInProgressEvent.
The following fields are required:
.itemId() .outputIndex() .sequenceNumber()
-
-
-
-