Class ResponseOutputItemDoneEvent
-
- All Implemented Interfaces:
public final class ResponseOutputItemDoneEventEmitted when an output item is marked done.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classResponseOutputItemDoneEvent.BuilderA builder for ResponseOutputItemDoneEvent.
-
Method Summary
Modifier and Type Method Description final ResponseOutputItemitem()The output item that was marked done. final LongoutputIndex()The index of the output item that was marked done. final LongsequenceNumber()The sequence number of this event. final JsonValue_type()The type of the event. final JsonField<ResponseOutputItem>_item()Returns the raw JSON value of item. 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 ResponseOutputItemDoneEvent.BuildertoBuilder()final ResponseOutputItemDoneEventvalidate()final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static ResponseOutputItemDoneEvent.Builderbuilder()Returns a mutable builder for constructing an instance of ResponseOutputItemDoneEvent. -
-
Method Detail
-
item
final ResponseOutputItem item()
The output item that was marked done.
-
outputIndex
final Long outputIndex()
The index of the output item that was marked done.
-
sequenceNumber
final Long sequenceNumber()
The sequence number of this event.
-
_type
final JsonValue _type()
The type of the event. Always
response.output_item.done.Expected to always return the following:
JsonValue.from("response.output_item.done")However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
_item
final JsonField<ResponseOutputItem> _item()
Returns the raw JSON value of item.
Unlike item, 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 ResponseOutputItemDoneEvent.Builder toBuilder()
-
validate
final ResponseOutputItemDoneEvent validate()
-
builder
final static ResponseOutputItemDoneEvent.Builder builder()
Returns a mutable builder for constructing an instance of ResponseOutputItemDoneEvent.
The following fields are required:
.item() .outputIndex() .sequenceNumber()
-
-
-
-