google-genai/com.google.genai.types/Schema

Schema

public abstract class Schema extends JsonSerializable

Schema is used to define the format of input/output data.

Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed.

Constructors

Schema

public void Schema()

Types

Builder

public abstract class Builder

Builder for Schema.

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

anyOf

public abstract Optional<List<Schema>> anyOf()

Optional.

builder

public static Schema.Builder builder()

Instantiates a builder for Schema.

default_

public abstract Optional<Object> default_()

Optional.

description

public abstract Optional<String> description()

Optional.

enum_

public abstract Optional<List<String>> enum_()

Optional.

example

public abstract Optional<Object> example()

Optional.

format

public abstract Optional<String> format()

Optional.

fromJson

public static Schema fromJson(String jsonString)

Deserializes a JSON string to a Schema object.

fromJsonNode

@InternalApi()

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

Deserializes a JsonNode to an object of the given type.

fromJsonString

@InternalApi()

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

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

items

public abstract Optional<Schema> items()

Optional.

maximum

public abstract Optional<Double> maximum()

Optional.

maxItems

public abstract Optional<Long> maxItems()

Optional.

maxLength

public abstract Optional<Long> maxLength()

Optional.

maxProperties

public abstract Optional<Long> maxProperties()

Optional.

minimum

public abstract Optional<Double> minimum()

Optional.

minItems

public abstract Optional<Long> minItems()

Optional.

minLength

public abstract Optional<Long> minLength()

Optional.

minProperties

public abstract Optional<Long> minProperties()

Optional.

nullable

public abstract Optional<Boolean> nullable()

Optional.

objectMapper

public static ObjectMapper objectMapper()

pattern

public abstract Optional<String> pattern()

Optional.

properties

public abstract Optional<Map<String, Schema>> properties()

Optional.

propertyOrdering

public abstract Optional<List<String>> propertyOrdering()

Optional.

required

public abstract Optional<List<String>> required()

Optional.

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.

title

public abstract Optional<String> title()

Optional.

toBuilder

public abstract Schema.Builder toBuilder()

Creates a builder with the same values as this instance.

toJson

public String toJson()

Serializes the instance to a Json string.

toJsonNode

public static JsonNode toJsonNode(Object object)

Serializes an object to a JsonNode.

toJsonString

public static String toJsonString(Object object)

Serializes an object to a Json string.

type

public abstract Optional<Type> type()

Optional.