Class ImageEditCompletedEvent
-
- All Implemented Interfaces:
public final class ImageEditCompletedEvent
Emitted when image editing has completed and the final image is available.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
ImageEditCompletedEvent.Builder
A builder for ImageEditCompletedEvent.
public final class
ImageEditCompletedEvent.Background
The background setting for the edited image.
public final class
ImageEditCompletedEvent.OutputFormat
The output format for the edited image.
public final class
ImageEditCompletedEvent.Quality
The quality setting for the edited image.
public final class
ImageEditCompletedEvent.Size
The size of the edited image.
public final class
ImageEditCompletedEvent.Usage
For
gpt-image-1
only, the token usage information for the image generation.
-
Method Summary
Modifier and Type Method Description final String
b64Json()
Base64-encoded final edited image data, suitable for rendering as an image. final ImageEditCompletedEvent.Background
background()
The background setting for the edited image. final Long
createdAt()
The Unix timestamp when the event was created. final ImageEditCompletedEvent.OutputFormat
outputFormat()
The output format for the edited image. final ImageEditCompletedEvent.Quality
quality()
The quality setting for the edited image. final ImageEditCompletedEvent.Size
size()
The size of the edited image. final JsonValue
_type()
The type of the event. final ImageEditCompletedEvent.Usage
usage()
For gpt-image-1
only, the token usage information for the image generation.final JsonField<String>
_b64Json()
Returns the raw JSON value of b64Json. final JsonField<ImageEditCompletedEvent.Background>
_background()
Returns the raw JSON value of background. final JsonField<Long>
_createdAt()
Returns the raw JSON value of createdAt. final JsonField<ImageEditCompletedEvent.OutputFormat>
_outputFormat()
Returns the raw JSON value of outputFormat. final JsonField<ImageEditCompletedEvent.Quality>
_quality()
Returns the raw JSON value of quality. final JsonField<ImageEditCompletedEvent.Size>
_size()
Returns the raw JSON value of size. final JsonField<ImageEditCompletedEvent.Usage>
_usage()
Returns the raw JSON value of usage. final Map<String, JsonValue>
_additionalProperties()
final ImageEditCompletedEvent.Builder
toBuilder()
final ImageEditCompletedEvent
validate()
final Boolean
isValid()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static ImageEditCompletedEvent.Builder
builder()
Returns a mutable builder for constructing an instance of ImageEditCompletedEvent. -
-
Method Detail
-
b64Json
final String b64Json()
Base64-encoded final edited image data, suitable for rendering as an image.
-
background
final ImageEditCompletedEvent.Background background()
The background setting for the edited image.
-
outputFormat
final ImageEditCompletedEvent.OutputFormat outputFormat()
The output format for the edited image.
-
quality
final ImageEditCompletedEvent.Quality quality()
The quality setting for the edited image.
-
size
final ImageEditCompletedEvent.Size size()
The size of the edited image.
-
_type
final JsonValue _type()
The type of the event. Always
image_edit.completed
.Expected to always return the following:
JsonValue.from("image_edit.completed")
However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
usage
final ImageEditCompletedEvent.Usage usage()
For
gpt-image-1
only, the token usage information for the image generation.
-
_b64Json
final JsonField<String> _b64Json()
Returns the raw JSON value of b64Json.
Unlike b64Json, this method doesn't throw if the JSON field has an unexpected type.
-
_background
final JsonField<ImageEditCompletedEvent.Background> _background()
Returns the raw JSON value of background.
Unlike background, this method doesn't throw if the JSON field has an unexpected type.
-
_createdAt
final JsonField<Long> _createdAt()
Returns the raw JSON value of createdAt.
Unlike createdAt, this method doesn't throw if the JSON field has an unexpected type.
-
_outputFormat
final JsonField<ImageEditCompletedEvent.OutputFormat> _outputFormat()
Returns the raw JSON value of outputFormat.
Unlike outputFormat, this method doesn't throw if the JSON field has an unexpected type.
-
_quality
final JsonField<ImageEditCompletedEvent.Quality> _quality()
Returns the raw JSON value of quality.
Unlike quality, this method doesn't throw if the JSON field has an unexpected type.
-
_size
final JsonField<ImageEditCompletedEvent.Size> _size()
Returns the raw JSON value of size.
Unlike size, this method doesn't throw if the JSON field has an unexpected type.
-
_usage
final JsonField<ImageEditCompletedEvent.Usage> _usage()
Returns the raw JSON value of usage.
Unlike usage, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final ImageEditCompletedEvent.Builder toBuilder()
-
validate
final ImageEditCompletedEvent validate()
-
builder
final static ImageEditCompletedEvent.Builder builder()
Returns a mutable builder for constructing an instance of ImageEditCompletedEvent.
The following fields are required:
.b64Json() .background() .createdAt() .outputFormat() .quality() .size() .usage()
-
-
-
-