Package ai.vectros.resources.documents.requests

Class UpdateDocumentRequest.Builder

java.lang.Object

ai.vectros.resources.documents.requests.UpdateDocumentRequest.Builder

All Implemented Interfaces:

UpdateDocumentRequest._FinalStage, UpdateDocumentRequest.BodyStage

Enclosing class:

UpdateDocumentRequest

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

Method Summary

Modifier and Type	Method	Description
UpdateDocumentRequest.Builder	additionalProperties(Map<String,Object> additionalProperties)
UpdateDocumentRequest.Builder	additionalProperty(String key, Object value)
UpdateDocumentRequest._FinalStage	allowClear(Boolean allowClear)	A PUT is 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 update is rejected unless you set allowClear=true to confirm that clearing those fields is intended.
UpdateDocumentRequest._FinalStage	allowClear(Optional<Boolean> allowClear)	A PUT is 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 update is rejected unless you set allowClear=true to confirm that clearing those fields is intended.
UpdateDocumentRequest._FinalStage	body(@NotNull DocumentRequest body)
UpdateDocumentRequest	build()
UpdateDocumentRequest.Builder	from(UpdateDocumentRequest other)

Methods inherited from class java.lang.Object

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

Method Details

from

public UpdateDocumentRequest.Builder from(UpdateDocumentRequest other)

Specified by:

from in interface UpdateDocumentRequest.BodyStage

body

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

Specified by:

body in interface UpdateDocumentRequest.BodyStage

allowClear

public UpdateDocumentRequest._FinalStage allowClear(Boolean allowClear)

A PUT is 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 update 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 UpdateDocumentRequest._FinalStage

Returns:

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

allowClear

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

A PUT is 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 update 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 UpdateDocumentRequest._FinalStage

build

public UpdateDocumentRequest build()

Specified by:

build in interface UpdateDocumentRequest._FinalStage

additionalProperty

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

Specified by:

additionalProperty in interface UpdateDocumentRequest._FinalStage

additionalProperties

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

Specified by:

additionalProperties in interface UpdateDocumentRequest._FinalStage