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