Package com.google.genai.types

Class ContentReferenceImage

java.lang.Object

com.google.genai.JsonSerializable

com.google.genai.types.ContentReferenceImage

All Implemented Interfaces:

ReferenceImage

public abstract class ContentReferenceImage
extends JsonSerializable
implements ReferenceImage

A content reference image.

A content reference image represents a subject to reference (ex. person, product, animal) provided by the user. It can optionally be provided in addition to a style reference image (ex. background, style reference).

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
ContentReferenceImage()

Method Summary

Modifier and Type	Method	Description
static ContentReferenceImage.Builder	builder()	Instantiates a builder for ContentReferenceImage.
static ContentReferenceImage	fromJson(String jsonString)	Deserializes a JSON string to a ContentReferenceImage object.
abstract Optional<Integer>	referenceId()	The id of the reference image.
abstract Optional<Image>	referenceImage()	The reference image for the editing operation.
abstract Optional<String>	referenceType()	The type of the reference image.
abstract ContentReferenceImage.Builder	toBuilder()	Creates a builder with the same values as this instance.
ReferenceImageAPI	toReferenceImageAPI()

Methods inherited from class com.google.genai.JsonSerializable

stringToJsonNode, toJson

Methods inherited from class java.lang.Object

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

Constructor Details

ContentReferenceImage

public ContentReferenceImage()

Method Details

referenceImage

public abstract Optional<Image> referenceImage()

The reference image for the editing operation.

referenceId

public abstract Optional<Integer> referenceId()

The id of the reference image.

referenceType

public abstract Optional<String> referenceType()

The type of the reference image. Only set by the SDK.

builder

public static ContentReferenceImage.Builder builder()

Instantiates a builder for ContentReferenceImage.

toBuilder

public abstract ContentReferenceImage.Builder toBuilder()

Creates a builder with the same values as this instance.

fromJson

public static ContentReferenceImage fromJson(String jsonString)

Deserializes a JSON string to a ContentReferenceImage object.

toReferenceImageAPI

public ReferenceImageAPI toReferenceImageAPI()

Specified by:

toReferenceImageAPI in interface ReferenceImage