MaskReferenceImage

All Implemented Interfaces:

com.google.genai.types.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
`public abstract class`	`MaskReferenceImage.Builder`	Builder for MaskReferenceImage.

Field Summary

Fields
Modifier and Type	Field	Description
`public final static String`	`MAX_READ_LENGTH_PROPERTY`

Constructor Summary

Constructors
Constructor	Description
`MaskReferenceImage()`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`abstract Optional<Image>`	`referenceImage()`	The reference image for the editing operation.
`abstract Optional<Integer>`	`referenceId()`	The id of the reference image.
`abstract Optional<String>`	`referenceType()`	The type of the reference image.
`abstract Optional<MaskReferenceConfig>`	`config()`	Configuration for the mask reference image.
`static MaskReferenceImage.Builder`	`builder()`	Instantiates a builder for MaskReferenceImage.
`abstract MaskReferenceImage.Builder`	`toBuilder()`	Creates a builder with the same values as this instance.
`static MaskReferenceImage`	`fromJson(String jsonString)`	Deserializes a JSON string to a MaskReferenceImage object.
`ReferenceImageAPI`	`toReferenceImageAPI()`

Methods inherited from class com.google.genai.JsonSerializable
fromJsonNode, fromJsonString, objectMapper, setMaxReadLength, stringToJsonNode, toJson, toJsonNode, toJsonString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MaskReferenceImage
```
MaskReferenceImage()
```
- Method Detail
  - referenceImage
```
 abstract Optional<Image> referenceImage()
```
    The reference image for the editing operation.
  - referenceId
```
 abstract Optional<Integer> referenceId()
```
    The id of the reference image.
  - referenceType
```
 abstract Optional<String> referenceType()
```
    The type of the reference image. Only set by the SDK.
  - config
```
 abstract Optional<MaskReferenceConfig> config()
```
    Configuration for the mask reference image.
  - builder
```
 static MaskReferenceImage.Builder builder()
```
    Instantiates a builder for MaskReferenceImage.
  - toBuilder
```
 abstract MaskReferenceImage.Builder toBuilder()
```
    Creates a builder with the same values as this instance.
  - fromJson
```
 static MaskReferenceImage fromJson(String jsonString)
```
    Deserializes a JSON string to a MaskReferenceImage object.
  - toReferenceImageAPI
```
 ReferenceImageAPI toReferenceImageAPI()
```