Class ResponseWebSearchCallInProgressEvent
-
- All Implemented Interfaces:
public final class ResponseWebSearchCallInProgressEvent
Emitted when a web search call is initiated.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
ResponseWebSearchCallInProgressEvent.Builder
A builder for ResponseWebSearchCallInProgressEvent.
-
Method Summary
Modifier and Type Method Description final String
itemId()
Unique ID for the output item associated with the web search call. final Long
outputIndex()
The index of the output item that the web search call is associated with. 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 Map<String, JsonValue>
_additionalProperties()
final ResponseWebSearchCallInProgressEvent.Builder
toBuilder()
final ResponseWebSearchCallInProgressEvent
validate()
final Boolean
isValid()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static ResponseWebSearchCallInProgressEvent.Builder
builder()
Returns a mutable builder for constructing an instance of ResponseWebSearchCallInProgressEvent. -
-
Method Detail
-
outputIndex
final Long outputIndex()
The index of the output item that the web search call is associated with.
-
_type
final JsonValue _type()
The type of the event. Always
response.web_search_call.in_progress
.Expected to always return the following:
JsonValue.from("response.web_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.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final ResponseWebSearchCallInProgressEvent.Builder toBuilder()
-
validate
final ResponseWebSearchCallInProgressEvent validate()
-
builder
final static ResponseWebSearchCallInProgressEvent.Builder builder()
Returns a mutable builder for constructing an instance of ResponseWebSearchCallInProgressEvent.
The following fields are required:
.itemId() .outputIndex()
-
-
-
-