google-genai/com.google.genai.types/MaskReferenceImage

MaskReferenceImage

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.

Constructors

MaskReferenceImage

public void MaskReferenceImage()

Types

public abstract class Builder

Builder for MaskReferenceImage.

Properties

MAX_READ_LENGTH_PROPERTY

public final static String MAX_READ_LENGTH_PROPERTY

System property to override the default max JSON string length (20MB) in read constraints.

Functions

public static MaskReferenceImage.Builder builder()

Instantiates a builder for MaskReferenceImage.

public abstract Optional<MaskReferenceConfig> config()

Configuration for the mask reference image.

public static MaskReferenceImage fromJson(String jsonString)

Deserializes a JSON string to a MaskReferenceImage object.

@InternalApi()

public static T fromJsonNode<T extends JsonSerializable>(JsonNode jsonNode, Class<T> clazz)

Deserializes a JsonNode to an object of the given type.

@InternalApi()

public static T fromJsonString<T extends JsonSerializable>(String jsonString, Class<T> clazz)

Deserializes a Json string to an object of the given type.

public static ObjectMapper objectMapper()

public abstract Optional<Integer> referenceId()

The id of the reference image.

public abstract Optional<Image> referenceImage()

The reference image for the editing operation.

public abstract Optional<String> referenceType()

The type of the reference image.

setMaxReadLength

public static void setMaxReadLength(int maxReadLength)

Overrides the default maximum JSON string length (20MB) for the JSON parser.

stringToJsonNode

public static JsonNode stringToJsonNode(String string)

Converts a Json string to a JsonNode.

public abstract MaskReferenceImage.Builder toBuilder()

Creates a builder with the same values as this instance.

public String toJson()

Serializes the instance to a Json string.

public static JsonNode toJsonNode(Object object)

Serializes an object to a JsonNode.

public static String toJsonString(Object object)

Serializes an object to a Json string.

toReferenceImageAPI

public ReferenceImageAPI toReferenceImageAPI()