Package com.google.genai.types

Class StyleReferenceImage

java.lang.Object

com.google.genai.JsonSerializable

com.google.genai.types.StyleReferenceImage

All Implemented Interfaces:

ReferenceImage

public abstract class StyleReferenceImage
extends JsonSerializable
implements ReferenceImage

A style reference image.

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

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

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
StyleReferenceImage()

Method Summary

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

StyleReferenceImage

public StyleReferenceImage()

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

Configuration for the style reference image.

builder

public static StyleReferenceImage.Builder builder()

Instantiates a builder for StyleReferenceImage.

toBuilder

public abstract StyleReferenceImage.Builder toBuilder()

Creates a builder with the same values as this instance.

fromJson

public static StyleReferenceImage fromJson(String jsonString)

Deserializes a JSON string to a StyleReferenceImage object.

toReferenceImageAPI

public ReferenceImageAPI toReferenceImageAPI()

Specified by:

toReferenceImageAPI in interface ReferenceImage