Package com.google.genai.types

Class DeleteDocumentParameters

java.lang.Object

com.google.genai.JsonSerializable

com.google.genai.types.DeleteDocumentParameters

@InternalApi
public abstract class DeleteDocumentParameters
extends JsonSerializable

Config for documents.delete parameters.

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class com.google.genai.JsonSerializable

MAX_READ_LENGTH_PROPERTY

Constructor Summary

Constructors

Constructor	Description
DeleteDocumentParameters()

Method Summary

Modifier and Type	Method	Description
static DeleteDocumentParameters.Builder	builder()	Instantiates a builder for DeleteDocumentParameters.
abstract Optional<DeleteDocumentConfig>	config()	Optional parameters for the request.
static DeleteDocumentParameters	fromJson(String jsonString)	Deserializes a JSON string to a DeleteDocumentParameters object.
abstract Optional<String>	name()	The resource name of the Document.
abstract DeleteDocumentParameters.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

DeleteDocumentParameters

public DeleteDocumentParameters()

Method Details

name

public abstract Optional<String> name()

The resource name of the Document. Example: fileSearchStores/file-search-store-foo/documents/documents-bar

config

public abstract Optional<DeleteDocumentConfig> config()

Optional parameters for the request.

builder

public static DeleteDocumentParameters.Builder builder()

Instantiates a builder for DeleteDocumentParameters.

toBuilder

public abstract DeleteDocumentParameters.Builder toBuilder()

Creates a builder with the same values as this instance.

fromJson

public static DeleteDocumentParameters fromJson(String jsonString)

Deserializes a JSON string to a DeleteDocumentParameters object.