Package com.google.genai.types

Class ControlReferenceImage

java.lang.Object

com.google.genai.JsonSerializable

com.google.genai.types.ControlReferenceImage

All Implemented Interfaces:

ReferenceImage

public abstract class ControlReferenceImage
extends JsonSerializable
implements ReferenceImage

A control reference image.

The image of the control reference image is either a control image provided by the user, or a regular image which the backend will use to generate a control image of. In the case of the latter, the enable_control_image_computation field in the config should be set to True.

A control image is an image that represents a sketch image of areas for the model to fill in based on the prompt.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
ControlReferenceImage()

Method Summary

Modifier and Type	Method	Description
static ControlReferenceImage.Builder	builder()	Instantiates a builder for ControlReferenceImage.
abstract Optional<ControlReferenceConfig>	config()	Configuration for the control reference image.
static ControlReferenceImage	fromJson(String jsonString)	Deserializes a JSON string to a ControlReferenceImage 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 ControlReferenceImage.Builder	toBuilder()	Creates a builder with the same values as this instance.
ReferenceImageAPI	toReferenceImageAPI()

Methods inherited from class com.google.genai.JsonSerializable

toJson

Methods inherited from class java.lang.Object

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

Constructor Details

ControlReferenceImage

public ControlReferenceImage()

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<ControlReferenceConfig> config()

Configuration for the control reference image.

builder

public static ControlReferenceImage.Builder builder()

Instantiates a builder for ControlReferenceImage.

toBuilder

public abstract ControlReferenceImage.Builder toBuilder()

Creates a builder with the same values as this instance.

fromJson

public static ControlReferenceImage fromJson(String jsonString)

Deserializes a JSON string to a ControlReferenceImage object.

toReferenceImageAPI

public ReferenceImageAPI toReferenceImageAPI()

Specified by:

toReferenceImageAPI in interface ReferenceImage