Package com.google.genai.types

Class MaskReferenceImage

java.lang.Object

com.google.genai.JsonSerializable

com.google.genai.types.MaskReferenceImage

All Implemented Interfaces:

ReferenceImage

public abstract class MaskReferenceImage
extends JsonSerializable
implements ReferenceImage

A mask reference image.

This encapsulates either a mask image provided by the user and configs for the user provided mask, or only config parameters for the model to generate a mask.

A mask image is an image whose non-zero values indicate where to edit the base image. If the user provides a mask image, the mask must be in the same dimensions as the raw image.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
MaskReferenceImage()

Method Summary

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

MaskReferenceImage

public MaskReferenceImage()

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

Configuration for the mask reference image.

builder

public static MaskReferenceImage.Builder builder()

Instantiates a builder for MaskReferenceImage.

toBuilder

public abstract MaskReferenceImage.Builder toBuilder()

Creates a builder with the same values as this instance.

fromJson

public static MaskReferenceImage fromJson(String jsonString)

Deserializes a JSON string to a MaskReferenceImage object.

toReferenceImageAPI

public ReferenceImageAPI toReferenceImageAPI()

Specified by:

toReferenceImageAPI in interface ReferenceImage