Class ResponseOutputItemDoneEvent.Builder
-
- All Implemented Interfaces:
public final class ResponseOutputItemDoneEvent.Builder
A builder for ResponseOutputItemDoneEvent.
-
-
Method Summary
Modifier and Type Method Description final ResponseOutputItemDoneEvent.Builder
item(ResponseOutputItem item)
The output item that was marked done. final ResponseOutputItemDoneEvent.Builder
item(JsonField<ResponseOutputItem> item)
Sets Builder.item to an arbitrary JSON value. final ResponseOutputItemDoneEvent.Builder
item(ResponseOutputMessage message)
Alias for calling item with ResponseOutputItem.ofMessage(message)
.final ResponseOutputItemDoneEvent.Builder
item(ResponseFileSearchToolCall fileSearchCall)
Alias for calling item with ResponseOutputItem.ofFileSearchCall(fileSearchCall)
.final ResponseOutputItemDoneEvent.Builder
item(ResponseFunctionToolCall functionCall)
Alias for calling item with ResponseOutputItem.ofFunctionCall(functionCall)
.final ResponseOutputItemDoneEvent.Builder
item(ResponseFunctionWebSearch webSearchCall)
Alias for calling item with ResponseOutputItem.ofWebSearchCall(webSearchCall)
.final ResponseOutputItemDoneEvent.Builder
item(ResponseComputerToolCall computerCall)
Alias for calling item with ResponseOutputItem.ofComputerCall(computerCall)
.final ResponseOutputItemDoneEvent.Builder
item(ResponseReasoningItem reasoning)
Alias for calling item with ResponseOutputItem.ofReasoning(reasoning)
.final ResponseOutputItemDoneEvent.Builder
item(ResponseOutputItem.ImageGenerationCall imageGenerationCall)
Alias for calling item with ResponseOutputItem.ofImageGenerationCall(imageGenerationCall)
.final ResponseOutputItemDoneEvent.Builder
item(ResponseCodeInterpreterToolCall codeInterpreterCall)
Alias for calling item with ResponseOutputItem.ofCodeInterpreterCall(codeInterpreterCall)
.final ResponseOutputItemDoneEvent.Builder
item(ResponseOutputItem.LocalShellCall localShellCall)
Alias for calling item with ResponseOutputItem.ofLocalShellCall(localShellCall)
.final ResponseOutputItemDoneEvent.Builder
item(ResponseOutputItem.McpCall mcpCall)
Alias for calling item with ResponseOutputItem.ofMcpCall(mcpCall)
.final ResponseOutputItemDoneEvent.Builder
item(ResponseOutputItem.McpListTools mcpListTools)
Alias for calling item with ResponseOutputItem.ofMcpListTools(mcpListTools)
.final ResponseOutputItemDoneEvent.Builder
item(ResponseOutputItem.McpApprovalRequest mcpApprovalRequest)
Alias for calling item with ResponseOutputItem.ofMcpApprovalRequest(mcpApprovalRequest)
.final ResponseOutputItemDoneEvent.Builder
outputIndex(Long outputIndex)
The index of the output item that was marked done. final ResponseOutputItemDoneEvent.Builder
outputIndex(JsonField<Long> outputIndex)
Sets Builder.outputIndex to an arbitrary JSON value. final ResponseOutputItemDoneEvent.Builder
sequenceNumber(Long sequenceNumber)
The sequence number of this event. final ResponseOutputItemDoneEvent.Builder
sequenceNumber(JsonField<Long> sequenceNumber)
Sets Builder.sequenceNumber to an arbitrary JSON value. final ResponseOutputItemDoneEvent.Builder
type(JsonValue type)
Sets the field to an arbitrary JSON value. final ResponseOutputItemDoneEvent.Builder
additionalProperties(Map<String, JsonValue> additionalProperties)
final ResponseOutputItemDoneEvent.Builder
putAdditionalProperty(String key, JsonValue value)
final ResponseOutputItemDoneEvent.Builder
putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)
final ResponseOutputItemDoneEvent.Builder
removeAdditionalProperty(String key)
final ResponseOutputItemDoneEvent.Builder
removeAllAdditionalProperties(Set<String> keys)
final ResponseOutputItemDoneEvent
build()
Returns an immutable instance of ResponseOutputItemDoneEvent. -
-
Method Detail
-
item
final ResponseOutputItemDoneEvent.Builder item(ResponseOutputItem item)
The output item that was marked done.
-
item
final ResponseOutputItemDoneEvent.Builder item(JsonField<ResponseOutputItem> item)
Sets Builder.item to an arbitrary JSON value.
You should usually call Builder.item with a well-typed ResponseOutputItem value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
item
final ResponseOutputItemDoneEvent.Builder item(ResponseOutputMessage message)
Alias for calling item with
ResponseOutputItem.ofMessage(message)
.
-
item
final ResponseOutputItemDoneEvent.Builder item(ResponseFileSearchToolCall fileSearchCall)
Alias for calling item with
ResponseOutputItem.ofFileSearchCall(fileSearchCall)
.
-
item
final ResponseOutputItemDoneEvent.Builder item(ResponseFunctionToolCall functionCall)
Alias for calling item with
ResponseOutputItem.ofFunctionCall(functionCall)
.
-
item
final ResponseOutputItemDoneEvent.Builder item(ResponseFunctionWebSearch webSearchCall)
Alias for calling item with
ResponseOutputItem.ofWebSearchCall(webSearchCall)
.
-
item
final ResponseOutputItemDoneEvent.Builder item(ResponseComputerToolCall computerCall)
Alias for calling item with
ResponseOutputItem.ofComputerCall(computerCall)
.
-
item
final ResponseOutputItemDoneEvent.Builder item(ResponseReasoningItem reasoning)
Alias for calling item with
ResponseOutputItem.ofReasoning(reasoning)
.
-
item
final ResponseOutputItemDoneEvent.Builder item(ResponseOutputItem.ImageGenerationCall imageGenerationCall)
Alias for calling item with
ResponseOutputItem.ofImageGenerationCall(imageGenerationCall)
.
-
item
final ResponseOutputItemDoneEvent.Builder item(ResponseCodeInterpreterToolCall codeInterpreterCall)
Alias for calling item with
ResponseOutputItem.ofCodeInterpreterCall(codeInterpreterCall)
.
-
item
final ResponseOutputItemDoneEvent.Builder item(ResponseOutputItem.LocalShellCall localShellCall)
Alias for calling item with
ResponseOutputItem.ofLocalShellCall(localShellCall)
.
-
item
final ResponseOutputItemDoneEvent.Builder item(ResponseOutputItem.McpCall mcpCall)
Alias for calling item with
ResponseOutputItem.ofMcpCall(mcpCall)
.
-
item
final ResponseOutputItemDoneEvent.Builder item(ResponseOutputItem.McpListTools mcpListTools)
Alias for calling item with
ResponseOutputItem.ofMcpListTools(mcpListTools)
.
-
item
final ResponseOutputItemDoneEvent.Builder item(ResponseOutputItem.McpApprovalRequest mcpApprovalRequest)
Alias for calling item with
ResponseOutputItem.ofMcpApprovalRequest(mcpApprovalRequest)
.
-
outputIndex
final ResponseOutputItemDoneEvent.Builder outputIndex(Long outputIndex)
The index of the output item that was marked done.
-
outputIndex
final ResponseOutputItemDoneEvent.Builder outputIndex(JsonField<Long> outputIndex)
Sets Builder.outputIndex to an arbitrary JSON value.
You should usually call Builder.outputIndex with a well-typed Long value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
sequenceNumber
final ResponseOutputItemDoneEvent.Builder sequenceNumber(Long sequenceNumber)
The sequence number of this event.
-
sequenceNumber
final ResponseOutputItemDoneEvent.Builder sequenceNumber(JsonField<Long> sequenceNumber)
Sets Builder.sequenceNumber to an arbitrary JSON value.
You should usually call Builder.sequenceNumber with a well-typed Long value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
type
final ResponseOutputItemDoneEvent.Builder type(JsonValue type)
Sets the field to an arbitrary JSON value.
It is usually unnecessary to call this method because the field defaults to the following:
JsonValue.from("response.output_item.done")
This method is primarily for setting the field to an undocumented or not yet supported value.
-
additionalProperties
final ResponseOutputItemDoneEvent.Builder additionalProperties(Map<String, JsonValue> additionalProperties)
-
putAdditionalProperty
final ResponseOutputItemDoneEvent.Builder putAdditionalProperty(String key, JsonValue value)
-
putAllAdditionalProperties
final ResponseOutputItemDoneEvent.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)
-
removeAdditionalProperty
final ResponseOutputItemDoneEvent.Builder removeAdditionalProperty(String key)
-
removeAllAdditionalProperties
final ResponseOutputItemDoneEvent.Builder removeAllAdditionalProperties(Set<String> keys)
-
build
final ResponseOutputItemDoneEvent build()
Returns an immutable instance of ResponseOutputItemDoneEvent.
Further updates to this Builder will not mutate the returned instance.
The following fields are required:
.item() .outputIndex() .sequenceNumber()
-
-
-
-