Package com.google.genai.types

Class UrlContextMetadata

java.lang.Object

com.google.genai.JsonSerializable

com.google.genai.types.UrlContextMetadata

public abstract class UrlContextMetadata
extends JsonSerializable

Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL.

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class com.google.genai.JsonSerializable

MAX_READ_LENGTH_PROPERTY

Constructor Summary

Constructors

Constructor	Description
UrlContextMetadata()

Method Summary

Modifier and Type	Method	Description
static UrlContextMetadata.Builder	builder()	Instantiates a builder for UrlContextMetadata.
static UrlContextMetadata	fromJson(String jsonString)	Deserializes a JSON string to a UrlContextMetadata object.
abstract UrlContextMetadata.Builder	toBuilder()	Creates a builder with the same values as this instance.
abstract Optional<List<UrlMetadata>>	urlMetadata()	Output only.

Methods inherited from class com.google.genai.JsonSerializable

fromJsonNode, fromJsonString, objectMapper, setMaxReadLength, stringToJsonNode, toJson, toJsonNode, toJsonString

Methods inherited from class java.lang.Object

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

Constructor Details

UrlContextMetadata

public UrlContextMetadata()

Method Details

urlMetadata

public abstract Optional<List<UrlMetadata>> urlMetadata()

Output only. A list of URL metadata, with one entry for each URL retrieved by the tool.

builder

public static UrlContextMetadata.Builder builder()

Instantiates a builder for UrlContextMetadata.

toBuilder

public abstract UrlContextMetadata.Builder toBuilder()

Creates a builder with the same values as this instance.

fromJson

public static UrlContextMetadata fromJson(String jsonString)

Deserializes a JSON string to a UrlContextMetadata object.