Package com.google.genai.types

Class RawReferenceImage

java.lang.Object

com.google.genai.JsonSerializable

com.google.genai.types.RawReferenceImage

All Implemented Interfaces:

ReferenceImage

public abstract class RawReferenceImage
extends JsonSerializable
implements ReferenceImage

A raw reference image.

A raw reference image represents the base image to edit, provided by the user. It can optionally be provided in addition to a mask reference image or a style reference image.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
RawReferenceImage()

Method Summary

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

Methods inherited from class com.google.genai.JsonSerializable

fromJsonString, toJson

Methods inherited from class java.lang.Object

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

Constructor Details

RawReferenceImage

public RawReferenceImage()

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 RawReferenceImage.Builder builder()

Instantiates a builder for RawReferenceImage.

toBuilder

public abstract RawReferenceImage.Builder toBuilder()

Creates a builder with the same values as this instance.

fromJson

public static RawReferenceImage fromJson(String jsonString)

Deserializes a JSON string to a RawReferenceImage object.

toReferenceImageAPI

public ReferenceImageAPI toReferenceImageAPI()

Specified by:

toReferenceImageAPI in interface ReferenceImage