Package com.google.genai.types

Class CustomMetadata

java.lang.Object

com.google.genai.JsonSerializable

com.google.genai.types.CustomMetadata

public abstract class CustomMetadata
extends JsonSerializable

User provided metadata stored as key-value pairs. This data type is not supported in Vertex AI.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CustomMetadata.Builder	Builder for CustomMetadata.

Field Summary

Fields inherited from class com.google.genai.JsonSerializable

MAX_READ_LENGTH_PROPERTY

Constructor Summary

Constructors

Constructor	Description
CustomMetadata()

Method Summary

Modifier and Type	Method	Description
static CustomMetadata.Builder	builder()	Instantiates a builder for CustomMetadata.
static CustomMetadata	fromJson(String jsonString)	Deserializes a JSON string to a CustomMetadata object.
abstract Optional<String>	key()	Required.
abstract Optional<Float>	numericValue()	The numeric value of the metadata to store.
abstract Optional<StringList>	stringListValue()	The StringList value of the metadata to store.
abstract Optional<String>	stringValue()	The string value of the metadata to store.
abstract CustomMetadata.Builder	toBuilder()	Creates a builder with the same values as this instance.

Methods inherited from class com.google.genai.JsonSerializable

setMaxReadLength, stringToJsonNode, toJson

Methods inherited from class java.lang.Object

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

Constructor Details

CustomMetadata

public CustomMetadata()

Method Details

key

public abstract Optional<String> key()

Required. The key of the metadata to store.

numericValue

public abstract Optional<Float> numericValue()

The numeric value of the metadata to store.

stringListValue

public abstract Optional<StringList> stringListValue()

The StringList value of the metadata to store.

stringValue

public abstract Optional<String> stringValue()

The string value of the metadata to store.

builder

public static CustomMetadata.Builder builder()

Instantiates a builder for CustomMetadata.

toBuilder

public abstract CustomMetadata.Builder toBuilder()

Creates a builder with the same values as this instance.

fromJson

public static CustomMetadata fromJson(String jsonString)

Deserializes a JSON string to a CustomMetadata object.