Package com.google.genai.types

Class UpscaleImageAPIConfig

java.lang.Object

com.google.genai.JsonSerializable

com.google.genai.types.UpscaleImageAPIConfig

@InternalApi
public abstract class UpscaleImageAPIConfig
extends JsonSerializable

Internal API config for UpscaleImage.

These fields require default values sent to the API which are not intended to be modifiable or exposed to users in the SDK method.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
UpscaleImageAPIConfig()

Method Summary

Modifier and Type	Method	Description
static UpscaleImageAPIConfig.Builder	builder()	Instantiates a builder for UpscaleImageAPIConfig.
abstract Optional<Boolean>	enhanceInputImage()	Whether to add an image enhancing step before upscaling.
static UpscaleImageAPIConfig	fromJson(String jsonString)	Deserializes a JSON string to a UpscaleImageAPIConfig object.
abstract Optional<HttpOptions>	httpOptions()	Used to override HTTP request options.
abstract Optional<Float>	imagePreservationFactor()	With a higher image preservation factor, the original image pixels are more respected.
abstract Optional<Boolean>	includeRaiReason()	Whether to include a reason for filtered-out images in the response.
abstract Optional<String>	mode()
abstract Optional<Integer>	numberOfImages()
abstract Optional<Integer>	outputCompressionQuality()	The level of compression.
abstract Optional<String>	outputGcsUri()	Cloud Storage URI used to store the generated images.
abstract Optional<String>	outputMimeType()	The image format that the output should be saved as.
abstract UpscaleImageAPIConfig.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

UpscaleImageAPIConfig

public UpscaleImageAPIConfig()

Method Details

httpOptions

public abstract Optional<HttpOptions> httpOptions()

Used to override HTTP request options.

outputGcsUri

public abstract Optional<String> outputGcsUri()

Cloud Storage URI used to store the generated images.

includeRaiReason

public abstract Optional<Boolean> includeRaiReason()

Whether to include a reason for filtered-out images in the response.

outputMimeType

public abstract Optional<String> outputMimeType()

The image format that the output should be saved as.

outputCompressionQuality

public abstract Optional<Integer> outputCompressionQuality()

The level of compression. Only applicable if the ``output_mime_type`` is ``image/jpeg``.

enhanceInputImage

public abstract Optional<Boolean> enhanceInputImage()

Whether to add an image enhancing step before upscaling. It is expected to suppress the noise and JPEG compression artifacts from the input image.

imagePreservationFactor

public abstract Optional<Float> imagePreservationFactor()

With a higher image preservation factor, the original image pixels are more respected. With a lower image preservation factor, the output image will have be more different from the input image, but with finer details and less noise.

numberOfImages

public abstract Optional<Integer> numberOfImages()

mode

public abstract Optional<String> mode()

builder

public static UpscaleImageAPIConfig.Builder builder()

Instantiates a builder for UpscaleImageAPIConfig.

toBuilder

public abstract UpscaleImageAPIConfig.Builder toBuilder()

Creates a builder with the same values as this instance.

fromJson

public static UpscaleImageAPIConfig fromJson(String jsonString)

Deserializes a JSON string to a UpscaleImageAPIConfig object.