Package com.google.genai.types

Class ImageResponseFormat

java.lang.Object

com.google.genai.JsonSerializable

com.google.genai.types.ImageResponseFormat

public abstract class ImageResponseFormat
extends JsonSerializable

Configuration for image-specific output formatting.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ImageResponseFormat.Builder	Builder for ImageResponseFormat.

Field Summary

Fields inherited from class com.google.genai.JsonSerializable

MAX_READ_LENGTH_PROPERTY

Constructor Summary

Constructors

Constructor	Description
ImageResponseFormat()

Method Summary

Modifier and Type	Method	Description
abstract Optional<AspectRatio>	aspectRatio()	Optional.
static ImageResponseFormat.Builder	builder()	Instantiates a builder for ImageResponseFormat.
abstract Optional<Delivery>	delivery()	Optional.
static ImageResponseFormat	fromJson(String jsonString)	Deserializes a JSON string to a ImageResponseFormat object.
abstract Optional<ImageSize>	imageSize()	Optional.
abstract Optional<String>	mimeType()	Optional.
abstract ImageResponseFormat.Builder	toBuilder()	Creates a builder with the same values as this instance.

Methods inherited from class com.google.genai.JsonSerializable

fromJsonNode, fromJsonString, objectMapper, setMaxReadLength, stringToJsonNode, toJson, toJsonNode, toJsonString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ImageResponseFormat

public ImageResponseFormat()

Method Details

aspectRatio

public abstract Optional<AspectRatio> aspectRatio()

Optional. The aspect ratio for the image output.

delivery

public abstract Optional<Delivery> delivery()

Optional. Delivery mode for the generated content.

imageSize

public abstract Optional<ImageSize> imageSize()

Optional. The size of the image output.

mimeType

public abstract Optional<String> mimeType()

Optional. The MIME type of the image output.

builder

public static ImageResponseFormat.Builder builder()

Instantiates a builder for ImageResponseFormat.

toBuilder

public abstract ImageResponseFormat.Builder toBuilder()

Creates a builder with the same values as this instance.

fromJson

public static ImageResponseFormat fromJson(String jsonString)

Deserializes a JSON string to a ImageResponseFormat object.