Package ai.vectros.resources.documents.requests

Class IngestDocumentRequest.Builder

java.lang.Object

ai.vectros.resources.documents.requests.IngestDocumentRequest.Builder

All Implemented Interfaces:

IngestDocumentRequest._FinalStage, IngestDocumentRequest.BodyStage

Enclosing class:

IngestDocumentRequest

public static final class IngestDocumentRequest.Builder
extends Object
implements IngestDocumentRequest.BodyStage, IngestDocumentRequest._FinalStage

Method Summary

Modifier and Type	Method	Description
IngestDocumentRequest.Builder	additionalProperties(Map<String,Object> additionalProperties)
IngestDocumentRequest.Builder	additionalProperty(String key, Object value)
IngestDocumentRequest._FinalStage	allowClear(Boolean allowClear)	Only relevant with ?
IngestDocumentRequest._FinalStage	allowClear(Optional<Boolean> allowClear)	Only relevant with ?
IngestDocumentRequest._FinalStage	body(@NotNull DocumentRequest body)
IngestDocumentRequest	build()
IngestDocumentRequest.Builder	from(IngestDocumentRequest other)
IngestDocumentRequest._FinalStage	upsert(Boolean upsert)	When true, if a document with the same externalId already exists its content is overwritten (the submitted payload, title, and — when supplied — text are applied and the version is bumped) instead of being returned unchanged; the immutable externalId, schemaId, indexMode, and ownership are never changed.
IngestDocumentRequest._FinalStage	upsert(Optional<Boolean> upsert)	When true, if a document with the same externalId already exists its content is overwritten (the submitted payload, title, and — when supplied — text are applied and the version is bumped) instead of being returned unchanged; the immutable externalId, schemaId, indexMode, and ownership are never changed.

Methods inherited from class java.lang.Object

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

Method Details

from

public IngestDocumentRequest.Builder from(IngestDocumentRequest other)

Specified by:

from in interface IngestDocumentRequest.BodyStage

body

public IngestDocumentRequest._FinalStage body(@NotNull
 @NotNull DocumentRequest body)

Specified by:

body in interface IngestDocumentRequest.BodyStage

allowClear

public IngestDocumentRequest._FinalStage allowClear(Boolean allowClear)

Only relevant with ?upsert=true, which overwrites an existing document as a full replacement. If the submitted request omits (or sends as null) a stored field that a list or lookup response returns only as an indexed projection (a large document whose payload is stored externally), the overwrite is rejected unless you set allowClear=true to confirm that clearing those fields is intended. Use PATCH to update without clearing omitted fields. Defaults to false.

Specified by:

allowClear in interface IngestDocumentRequest._FinalStage

Returns:

Reference to this so that method calls can be chained together.

allowClear

public IngestDocumentRequest._FinalStage allowClear(Optional<Boolean> allowClear)

Only relevant with ?upsert=true, which overwrites an existing document as a full replacement. If the submitted request omits (or sends as null) a stored field that a list or lookup response returns only as an indexed projection (a large document whose payload is stored externally), the overwrite is rejected unless you set allowClear=true to confirm that clearing those fields is intended. Use PATCH to update without clearing omitted fields. Defaults to false.

Specified by:

allowClear in interface IngestDocumentRequest._FinalStage

upsert

public IngestDocumentRequest._FinalStage upsert(Boolean upsert)

When true, if a document with the same externalId already exists its content is overwritten (the submitted payload, title, and — when supplied — text are applied and the version is bumped) instead of being returned unchanged; the immutable externalId, schemaId, indexMode, and ownership are never changed. Defaults to false. Requires the documents:u scope in addition to documents:c.

Specified by:

upsert in interface IngestDocumentRequest._FinalStage

Returns:

Reference to this so that method calls can be chained together.

upsert

public IngestDocumentRequest._FinalStage upsert(Optional<Boolean> upsert)

When true, if a document with the same externalId already exists its content is overwritten (the submitted payload, title, and — when supplied — text are applied and the version is bumped) instead of being returned unchanged; the immutable externalId, schemaId, indexMode, and ownership are never changed. Defaults to false. Requires the documents:u scope in addition to documents:c.

Specified by:

upsert in interface IngestDocumentRequest._FinalStage

build

public IngestDocumentRequest build()

Specified by:

build in interface IngestDocumentRequest._FinalStage

additionalProperty

public IngestDocumentRequest.Builder additionalProperty(String key,
 Object value)

Specified by:

additionalProperty in interface IngestDocumentRequest._FinalStage

additionalProperties

public IngestDocumentRequest.Builder additionalProperties(Map<String,Object> additionalProperties)

Specified by:

additionalProperties in interface IngestDocumentRequest._FinalStage