Package com.google.genai.types

Class GenerateImagesResponse

java.lang.Object

com.google.genai.JsonSerializable

com.google.genai.types.GenerateImagesResponse

public abstract class GenerateImagesResponse
extends JsonSerializable

The output images response.

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class com.google.genai.JsonSerializable

MAX_READ_LENGTH_PROPERTY

Constructor Summary

Constructors

Constructor	Description
GenerateImagesResponse()

Method Summary

Modifier and Type	Method	Description
static GenerateImagesResponse.Builder	builder()	Instantiates a builder for GenerateImagesResponse.
static GenerateImagesResponse	fromJson(String jsonString)	Deserializes a JSON string to a GenerateImagesResponse object.
abstract Optional<List<GeneratedImage>>	generatedImages()	List of generated images.
@Nullable com.google.common.collect.ImmutableList<Image>	images()	Returns the list of images from the response.
abstract Optional<SafetyAttributes>	positivePromptSafetyAttributes()	Safety attributes of the positive prompt.
abstract Optional<HttpResponse>	sdkHttpResponse()	Used to retain the full HTTP response.
abstract GenerateImagesResponse.Builder	toBuilder()	Creates a builder with the same values as this instance.

Methods inherited from class com.google.genai.JsonSerializable

setMaxReadLength, stringToJsonNode, toJson

Methods inherited from class java.lang.Object

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

Constructor Details

GenerateImagesResponse

public GenerateImagesResponse()

Method Details

sdkHttpResponse

public abstract Optional<HttpResponse> sdkHttpResponse()

Used to retain the full HTTP response.

generatedImages

public abstract Optional<List<GeneratedImage>> generatedImages()

List of generated images.

positivePromptSafetyAttributes

public abstract Optional<SafetyAttributes> positivePromptSafetyAttributes()

Safety attributes of the positive prompt. Only populated if ``include_safety_attributes`` is set to True.

builder

public static GenerateImagesResponse.Builder builder()

Instantiates a builder for GenerateImagesResponse.

toBuilder

public abstract GenerateImagesResponse.Builder toBuilder()

Creates a builder with the same values as this instance.

fromJson

public static GenerateImagesResponse fromJson(String jsonString)

Deserializes a JSON string to a GenerateImagesResponse object.

images

public @Nullable com.google.common.collect.ImmutableList<Image> images()

Returns the list of images from the response.

Returns null if there are no generated images in the response.