Package com.google.genai.types

Class ReferenceImageAPI

java.lang.Object

com.google.genai.JsonSerializable

com.google.genai.types.ReferenceImageAPI

@InternalApi
public abstract class ReferenceImageAPI
extends JsonSerializable

Private class that represents a Reference image that is sent to API.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
ReferenceImageAPI()

Method Summary

Modifier and Type	Method	Description
static ReferenceImageAPI.Builder	builder()	Instantiates a builder for ReferenceImageAPI.
abstract Optional<ControlReferenceConfig>	controlImageConfig()	Configuration for the control reference image.
static ReferenceImageAPI	fromJson(String jsonString)	Deserializes a JSON string to a ReferenceImageAPI object.
abstract Optional<MaskReferenceConfig>	maskImageConfig()	Configuration for the mask reference image.
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 Optional<StyleReferenceConfig>	styleImageConfig()	Configuration for the style reference image.
abstract Optional<SubjectReferenceConfig>	subjectImageConfig()	Configuration for the subject reference image.
abstract ReferenceImageAPI.Builder	toBuilder()	Creates a builder with the same values as this instance.

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

ReferenceImageAPI

public ReferenceImageAPI()

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.

maskImageConfig

public abstract Optional<MaskReferenceConfig> maskImageConfig()

Configuration for the mask reference image.

controlImageConfig

public abstract Optional<ControlReferenceConfig> controlImageConfig()

Configuration for the control reference image.

styleImageConfig

public abstract Optional<StyleReferenceConfig> styleImageConfig()

Configuration for the style reference image.

subjectImageConfig

public abstract Optional<SubjectReferenceConfig> subjectImageConfig()

Configuration for the subject reference image.

builder

public static ReferenceImageAPI.Builder builder()

Instantiates a builder for ReferenceImageAPI.

toBuilder

public abstract ReferenceImageAPI.Builder toBuilder()

Creates a builder with the same values as this instance.

fromJson

public static ReferenceImageAPI fromJson(String jsonString)

Deserializes a JSON string to a ReferenceImageAPI object.