Package com.google.genai.types

Class ListDocumentsResponse

java.lang.Object

com.google.genai.JsonSerializable

com.google.genai.types.ListDocumentsResponse

public abstract class ListDocumentsResponse
extends JsonSerializable

Config for documents.list return value.

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class com.google.genai.JsonSerializable

MAX_READ_LENGTH_PROPERTY

Constructor Summary

Constructors

Constructor	Description
ListDocumentsResponse()

Method Summary

Modifier and Type	Method	Description
static ListDocumentsResponse.Builder	builder()	Instantiates a builder for ListDocumentsResponse.
abstract Optional<List<Document>>	documents()	The returned `Document`s.
static ListDocumentsResponse	fromJson(String jsonString)	Deserializes a JSON string to a ListDocumentsResponse object.
abstract Optional<String>	nextPageToken()	A token, which can be sent as `page_token` to retrieve the next page.
abstract Optional<HttpResponse>	sdkHttpResponse()	Used to retain the full HTTP response.
abstract ListDocumentsResponse.Builder	toBuilder()	Creates a builder with the same values as this instance.

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

ListDocumentsResponse

public ListDocumentsResponse()

Method Details

sdkHttpResponse

public abstract Optional<HttpResponse> sdkHttpResponse()

Used to retain the full HTTP response.

nextPageToken

public abstract Optional<String> nextPageToken()

A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no more pages.

documents

public abstract Optional<List<Document>> documents()

The returned `Document`s.

builder

public static ListDocumentsResponse.Builder builder()

Instantiates a builder for ListDocumentsResponse.

toBuilder

public abstract ListDocumentsResponse.Builder toBuilder()

Creates a builder with the same values as this instance.

fromJson

public static ListDocumentsResponse fromJson(String jsonString)

Deserializes a JSON string to a ListDocumentsResponse object.