google-genai/com.google.genai.interactions.models.interactions/FileCitation/Builder

Builder

public final class Builder

A builder for FileCitation.

Functions

additionalProperties

public final FileCitation.Builder additionalProperties(Map<String, JsonValue> additionalProperties)

build

public final FileCitation build()

Returns an immutable instance of FileCitation.

customMetadata

public final FileCitation.Builder customMetadata(JsonField<FileCitation.CustomMetadata> customMetadata)

Sets Builder.customMetadata to an arbitrary JSON value.

public final FileCitation.Builder customMetadata(FileCitation.CustomMetadata customMetadata)

User provided metadata about the retrieved context.

documentUri

public final FileCitation.Builder documentUri(JsonField<String> documentUri)

Sets Builder.documentUri to an arbitrary JSON value.

public final FileCitation.Builder documentUri(String documentUri)

The URI of the file.

endIndex

public final FileCitation.Builder endIndex(JsonField<Integer> endIndex)

Sets Builder.endIndex to an arbitrary JSON value.

public final FileCitation.Builder endIndex(Integer endIndex)

End of the attributed segment, exclusive.

fileName

public final FileCitation.Builder fileName(JsonField<String> fileName)

Sets Builder.fileName to an arbitrary JSON value.

public final FileCitation.Builder fileName(String fileName)

The name of the file.

mediaId

public final FileCitation.Builder mediaId(JsonField<String> mediaId)

Sets Builder.mediaId to an arbitrary JSON value.

public final FileCitation.Builder mediaId(String mediaId)

Media ID in-case of image citations, if applicable.

pageNumber

public final FileCitation.Builder pageNumber(JsonField<Integer> pageNumber)

Sets Builder.pageNumber to an arbitrary JSON value.

public final FileCitation.Builder pageNumber(Integer pageNumber)

Page number of the cited document, if applicable.

putAdditionalProperty

public final FileCitation.Builder putAdditionalProperty(String key, JsonValue value)

putAllAdditionalProperties

public final FileCitation.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)

removeAdditionalProperty

public final FileCitation.Builder removeAdditionalProperty(String key)

removeAllAdditionalProperties

public final FileCitation.Builder removeAllAdditionalProperties(Set<String> keys)

source

public final FileCitation.Builder source(JsonField<String> source)

Sets Builder.source to an arbitrary JSON value.

public final FileCitation.Builder source(String source)

Source attributed for a portion of the text.

startIndex

public final FileCitation.Builder startIndex(JsonField<Integer> startIndex)

Sets Builder.startIndex to an arbitrary JSON value.

public final FileCitation.Builder startIndex(Integer startIndex)

Start of segment of the response that is attributed to this source.

type

public final FileCitation.Builder type(JsonValue type)

Sets the field to an arbitrary JSON value.