google-genai/com.google.genai.types/RawReferenceImage

RawReferenceImage

public abstract class RawReferenceImage extends JsonSerializable implements ReferenceImage

A raw reference image.

A raw reference image represents the base image to edit, provided by the user. It can optionally be provided in addition to a mask reference image or a style reference image.

Constructors

Link copied to clipboard
public void RawReferenceImage()

Types

Link copied to clipboard
public abstract class Builder
Builder for RawReferenceImage.

Properties

Link copied to clipboard
public final static String MAX_READ_LENGTH_PROPERTY
System property to override the default max JSON string length (20MB) in read constraints.

Functions

Link copied to clipboard
public static RawReferenceImage.Builder builder()
Instantiates a builder for RawReferenceImage.
Link copied to clipboard
public static RawReferenceImage fromJson(String jsonString)
Deserializes a JSON string to a RawReferenceImage object.
Link copied to clipboard
@InternalApi()
public static T fromJsonNode<T extends JsonSerializable>(JsonNode jsonNode, Class<T> clazz)
Deserializes a JsonNode to an object of the given type.
Link copied to clipboard
@InternalApi()
public static T fromJsonString<T extends JsonSerializable>(String jsonString, Class<T> clazz)
Deserializes a Json string to an object of the given type.
Link copied to clipboard
public static ObjectMapper objectMapper()
Link copied to clipboard
public abstract Optional<Integer> referenceId()
The id of the reference image.
Link copied to clipboard
public abstract Optional<Image> referenceImage()
The reference image for the editing operation.
Link copied to clipboard
public abstract Optional<String> referenceType()
The type of the reference image.
Link copied to clipboard
public static void setMaxReadLength(int maxReadLength)
Overrides the default maximum JSON string length (20MB) for the JSON parser.
Link copied to clipboard
public static JsonNode stringToJsonNode(String string)
Converts a Json string to a JsonNode.
Link copied to clipboard
public abstract RawReferenceImage.Builder toBuilder()
Creates a builder with the same values as this instance.
Link copied to clipboard
public String toJson()
Serializes the instance to a Json string.
Link copied to clipboard
public static JsonNode toJsonNode(Object object)
Serializes an object to a JsonNode.
Link copied to clipboard
public static String toJsonString(Object object)
Serializes an object to a Json string.
Link copied to clipboard