Package com.google.genai.types

Class FileSearchStore

java.lang.Object

com.google.genai.JsonSerializable

com.google.genai.types.FileSearchStore

public abstract class FileSearchStore
extends JsonSerializable

A collection of Documents.

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class com.google.genai.JsonSerializable

MAX_READ_LENGTH_PROPERTY

Constructor Summary

Constructors

Constructor	Description
FileSearchStore()

Method Summary

Modifier and Type	Method	Description
abstract Optional<Long>	activeDocumentsCount()	Output only.
static FileSearchStore.Builder	builder()	Instantiates a builder for FileSearchStore.
abstract Optional<Instant>	createTime()	Output only.
abstract Optional<String>	displayName()	Optional.
abstract Optional<String>	embeddingModel()	The embedding model used by the FileSearchStore.
abstract Optional<Long>	failedDocumentsCount()	Output only.
static FileSearchStore	fromJson(String jsonString)	Deserializes a JSON string to a FileSearchStore object.
abstract Optional<String>	name()	Output only.
abstract Optional<Long>	pendingDocumentsCount()	Output only.
abstract Optional<Long>	sizeBytes()	Output only.
abstract FileSearchStore.Builder	toBuilder()	Creates a builder with the same values as this instance.
abstract Optional<Instant>	updateTime()	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

FileSearchStore

public FileSearchStore()

Method Details

name

public abstract Optional<String> name()

Output only. Immutable. Identifier. The `FileSearchStore` resource name. It is an ID (name excluding the "fileSearchStores/" prefix) that can contain up to 40 characters that are lowercase alphanumeric or dashes (-). It is output only. The unique name will be derived from `display_name` along with a 12 character random suffix. Example: `fileSearchStores/my-awesome-file-search-store-123a456b789c` If `display_name` is not provided, the name will be randomly generated.

displayName

public abstract Optional<String> displayName()

Optional. The human-readable display name for the `FileSearchStore`. The display name must be no more than 512 characters in length, including spaces. Example: "Docs on Semantic Retriever".

createTime

public abstract Optional<Instant> createTime()

Output only. The Timestamp of when the `FileSearchStore` was created.

updateTime

public abstract Optional<Instant> updateTime()

Output only. The Timestamp of when the `FileSearchStore` was last updated.

activeDocumentsCount

public abstract Optional<Long> activeDocumentsCount()

Output only. The number of documents in the `FileSearchStore` that are active and ready for retrieval.

pendingDocumentsCount

public abstract Optional<Long> pendingDocumentsCount()

Output only. The number of documents in the `FileSearchStore` that are being processed.

failedDocumentsCount

public abstract Optional<Long> failedDocumentsCount()

Output only. The number of documents in the `FileSearchStore` that have failed processing.

sizeBytes

public abstract Optional<Long> sizeBytes()

Output only. The size of raw bytes ingested into the `FileSearchStore`. This is the total size of all the documents in the `FileSearchStore`.

embeddingModel

public abstract Optional<String> embeddingModel()

The embedding model used by the FileSearchStore.

builder

public static FileSearchStore.Builder builder()

Instantiates a builder for FileSearchStore.

toBuilder

public abstract FileSearchStore.Builder toBuilder()

Creates a builder with the same values as this instance.

fromJson

public static FileSearchStore fromJson(String jsonString)

Deserializes a JSON string to a FileSearchStore object.