All Implemented Interfaces:


public final class BetaResponseImageGenCallPartialImageEvent

Emitted when a partial image is available during image generation streaming.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`BetaResponseImageGenCallPartialImageEvent.Builder`	A builder for BetaResponseImageGenCallPartialImageEvent.
`public final class`	`BetaResponseImageGenCallPartialImageEvent.Agent`	The agent that owns this multi-agent streaming event.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`itemId()`	The unique identifier of the image generation item being processed.
`final Long`	`outputIndex()`	The index of the output item in the response's output array.
`final String`	`partialImageB64()`	Base64-encoded partial image data, suitable for rendering as an image.
`final Long`	`partialImageIndex()`	0-based index for the partial image (backend is 1-based, but this is 0-based for the user).
`final Long`	`sequenceNumber()`	The sequence number of the image generation item being processed.
`final JsonValue`	`_type()`	The type of the event.
`final Optional<BetaResponseImageGenCallPartialImageEvent.Agent>`	`agent()`	The agent that owns this multi-agent streaming 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<String>`	`_partialImageB64()`	Returns the raw JSON value of partialImageB64.
`final JsonField<Long>`	`_partialImageIndex()`	Returns the raw JSON value of partialImageIndex.
`final JsonField<Long>`	`_sequenceNumber()`	Returns the raw JSON value of sequenceNumber.
`final JsonField<BetaResponseImageGenCallPartialImageEvent.Agent>`	`_agent()`	Returns the raw JSON value of agent.
`final Map<String, JsonValue>`	`_additionalProperties()`
`final BetaResponseImageGenCallPartialImageEvent.Builder`	`toBuilder()`
`final BetaResponseImageGenCallPartialImageEvent`	`validate()`	Validates that the types of all values in this object match their expected types recursively.
`final Boolean`	`isValid()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static BetaResponseImageGenCallPartialImageEvent.Builder`	`builder()`	Returns a mutable builder for constructing an instance of BetaResponseImageGenCallPartialImageEvent.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - itemId
```
 final String itemId()
```
    The unique identifier of the image generation item being processed.
  - outputIndex
```
 final Long outputIndex()
```
    The index of the output item in the response's output array.
  - partialImageB64
```
 final String partialImageB64()
```
    Base64-encoded partial image data, suitable for rendering as an image.
  - partialImageIndex
```
 final Long partialImageIndex()
```
    0-based index for the partial image (backend is 1-based, but this is 0-based for the user).
  - sequenceNumber
```
 final Long sequenceNumber()
```
    The sequence number of the image generation item being processed.
  - _type
```
 final JsonValue _type()
```
    The type of the event. Always 'response.image_generation_call.partial_image'.
    Expected to always return the following:
    JsonValue.from("response.image_generation_call.partial_image")
    However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
  - agent
```
 final Optional<BetaResponseImageGenCallPartialImageEvent.Agent> agent()
```
    The agent that owns this multi-agent streaming event.
  - _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.
  - _partialImageB64
```
 final JsonField<String> _partialImageB64()
```
    Returns the raw JSON value of partialImageB64.
    Unlike partialImageB64, this method doesn't throw if the JSON field has an unexpected type.
  - _partialImageIndex
```
 final JsonField<Long> _partialImageIndex()
```
    Returns the raw JSON value of partialImageIndex.
    Unlike partialImageIndex, 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.
  - _agent
```
 final JsonField<BetaResponseImageGenCallPartialImageEvent.Agent> _agent()
```
    Returns the raw JSON value of agent.
    Unlike agent, this method doesn't throw if the JSON field has an unexpected type.
  - _additionalProperties
```
 final Map<String, JsonValue> _additionalProperties()
```
  - toBuilder
```
 final BetaResponseImageGenCallPartialImageEvent.Builder toBuilder()
```
  - validate
```
 final BetaResponseImageGenCallPartialImageEvent validate()
```
    Validates that the types of all values in this object match their expected types recursively.
    This method is not forwards compatible with new types from the API for existing fields.
  - isValid
```
 final Boolean isValid()
```
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static BetaResponseImageGenCallPartialImageEvent.Builder builder()
```
    Returns a mutable builder for constructing an instance of BetaResponseImageGenCallPartialImageEvent.
    The following fields are required:
    .itemId() .outputIndex() .partialImageB64() .partialImageIndex() .sequenceNumber()

Class BetaResponseImageGenCallPartialImageEvent

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

itemId

outputIndex

partialImageB64

partialImageIndex

sequenceNumber

_type

agent

_itemId

_outputIndex

_partialImageB64

_partialImageIndex

_sequenceNumber

_agent

_additionalProperties

toBuilder

validate

isValid

equals

hashCode

toString

builder