Package com.google.genai.types

Class SubjectReferenceImage

java.lang.Object

com.google.genai.JsonSerializable

com.google.genai.types.SubjectReferenceImage

All Implemented Interfaces:

ReferenceImage

public abstract class SubjectReferenceImage
extends JsonSerializable
implements ReferenceImage

A subject reference image.

This encapsulates a subject reference image provided by the user, and additionally optional config parameters for the subject reference image.

A raw reference image can also be provided as a destination for the subject to be applied to.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
SubjectReferenceImage()

Method Summary

Modifier and Type	Method	Description
static SubjectReferenceImage.Builder	builder()	Instantiates a builder for SubjectReferenceImage.
abstract Optional<SubjectReferenceConfig>	config()	Configuration for the subject reference image.
static SubjectReferenceImage	fromJson(String jsonString)	Deserializes a JSON string to a SubjectReferenceImage 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 SubjectReferenceImage.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

SubjectReferenceImage

public SubjectReferenceImage()

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.

config

public abstract Optional<SubjectReferenceConfig> config()

Configuration for the subject reference image.

builder

public static SubjectReferenceImage.Builder builder()

Instantiates a builder for SubjectReferenceImage.

toBuilder

public abstract SubjectReferenceImage.Builder toBuilder()

Creates a builder with the same values as this instance.

fromJson

public static SubjectReferenceImage fromJson(String jsonString)

Deserializes a JSON string to a SubjectReferenceImage object.

toReferenceImageAPI

public ReferenceImageAPI toReferenceImageAPI()

Specified by:

toReferenceImageAPI in interface ReferenceImage