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

API config for UpscaleImage with fields not exposed to users.

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.

Field Summary

Fields inherited from class com.google.genai.JsonSerializable

objectMapper

Constructor Summary

Constructors

Constructor	Description
UpscaleImageAPIConfig()

Method Summary

Modifier and Type	Method	Description
static UpscaleImageAPIConfig.Builder	builder()	Instantiates a builder for UpscaleImageAPIConfig.
static UpscaleImageAPIConfig	fromJson(String jsonString)	Deserializes a JSON string to a UpscaleImageAPIConfig object.
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 if the ``output_mime_type`` is ``image/jpeg``.
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

fromJsonNode, fromJsonString, toJson, toJsonNode, toJsonString

Methods inherited from class java.lang.Object

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

Constructor Details

UpscaleImageAPIConfig

public UpscaleImageAPIConfig()

Method Details

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 if the ``output_mime_type`` is ``image/jpeg``.

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.