Package ai.vectros.resources.documents.requests

Class DocumentLookupRequest.Builder

java.lang.Object

ai.vectros.resources.documents.requests.DocumentLookupRequest.Builder

All Implemented Interfaces:

DocumentLookupRequest._FinalStage, DocumentLookupRequest.FieldStage, DocumentLookupRequest.TypeStage

Enclosing class:

DocumentLookupRequest

public static final class DocumentLookupRequest.Builder
extends Object
implements DocumentLookupRequest.TypeStage, DocumentLookupRequest.FieldStage, DocumentLookupRequest._FinalStage

Method Summary

Modifier and Type	Method	Description
DocumentLookupRequest.Builder	additionalProperties(Map<String,Object> additionalProperties)
DocumentLookupRequest.Builder	additionalProperty(String key, Object value)
DocumentLookupRequest	build()
DocumentLookupRequest._FinalStage	field(@NotNull String field)	The field to look up by.
DocumentLookupRequest.Builder	from(DocumentLookupRequest other)
DocumentLookupRequest._FinalStage	from(String from)	Inclusive lower bound for a range lookup (requires to; non-sensitive, range-enabled fields only).
DocumentLookupRequest._FinalStage	from(Optional<String> from)	Inclusive lower bound for a range lookup (requires to; non-sensitive, range-enabled fields only).
DocumentLookupRequest._FinalStage	limit(Integer limit)	Maximum number of documents to return per page (1–100; defaults to 20).
DocumentLookupRequest._FinalStage	limit(Optional<Integer> limit)	Maximum number of documents to return per page (1–100; defaults to 20).
DocumentLookupRequest._FinalStage	order(DocumentLookupRequestOrder order)	Sort direction for the returned results: asc (default) or desc.
DocumentLookupRequest._FinalStage	order(Optional<DocumentLookupRequestOrder> order)	Sort direction for the returned results: asc (default) or desc.
DocumentLookupRequest._FinalStage	prefix(String prefix)	Prefix to match for a prefix lookup (range-enabled string fields only).
DocumentLookupRequest._FinalStage	prefix(Optional<String> prefix)	Prefix to match for a prefix lookup (range-enabled string fields only).
DocumentLookupRequest._FinalStage	scope(String scope)	Root API key ONLY: resolve type's schema as this scope would (basedOn-aware shadowing), as a single namespace:value entry — mirrors GET /v1/schemas?
DocumentLookupRequest._FinalStage	scope(Optional<String> scope)	Root API key ONLY: resolve type's schema as this scope would (basedOn-aware shadowing), as a single namespace:value entry — mirrors GET /v1/schemas?
DocumentLookupRequest._FinalStage	sortFrom(String sortFrom)	Inclusive lower bound on the lookup field's sort key, narrowing a value match to documents at or after this point (#870).
DocumentLookupRequest._FinalStage	sortFrom(Optional<String> sortFrom)	Inclusive lower bound on the lookup field's sort key, narrowing a value match to documents at or after this point (#870).
DocumentLookupRequest._FinalStage	sortTo(String sortTo)	Inclusive upper bound on the lookup field's sort key, narrowing a value match to documents at or before this point (#870).
DocumentLookupRequest._FinalStage	sortTo(Optional<String> sortTo)	Inclusive upper bound on the lookup field's sort key, narrowing a value match to documents at or before this point (#870).
DocumentLookupRequest._FinalStage	startFrom(String startFrom)	Pagination cursor.
DocumentLookupRequest._FinalStage	startFrom(Optional<String> startFrom)	Pagination cursor.
DocumentLookupRequest._FinalStage	to(String to)	Inclusive upper bound for a range lookup (requires from; mutually exclusive with value and prefix).
DocumentLookupRequest._FinalStage	to(Optional<String> to)	Inclusive upper bound for a range lookup (requires from; mutually exclusive with value and prefix).
DocumentLookupRequest.FieldStage	type(@NotNull String type)	Document type to look up (the type defined by the bound schema).
DocumentLookupRequest._FinalStage	userId(String userId)	Root API key ONLY: resolve type's schema as this user would (basedOn-aware shadowing) instead of the shared base — mirrors GET /v1/schemas?
DocumentLookupRequest._FinalStage	userId(Optional<String> userId)	Root API key ONLY: resolve type's schema as this user would (basedOn-aware shadowing) instead of the shared base — mirrors GET /v1/schemas?
DocumentLookupRequest._FinalStage	value(String value)	Exact value to match (equality mode).
DocumentLookupRequest._FinalStage	value(Optional<String> value)	Exact value to match (equality mode).

Methods inherited from class java.lang.Object

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

Method Details

from

public DocumentLookupRequest.Builder from(DocumentLookupRequest other)

Specified by:

from in interface DocumentLookupRequest.TypeStage

type

public DocumentLookupRequest.FieldStage type(@NotNull
 @NotNull String type)

Document type to look up (the type defined by the bound schema).

Document type to look up (the type defined by the bound schema).

Specified by:

type in interface DocumentLookupRequest.TypeStage

Returns:

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

field

public DocumentLookupRequest._FinalStage field(@NotNull
 @NotNull String field)

The field to look up by. Use externalId to look up by the document's external identifier (no schema declaration required), or the name of any lookup field declared on the bound schema. For a sensitive field, this body variant is required (the GET variant rejects sensitive-field lookups).

The field to look up by. Use externalId to look up by the document's external identifier (no schema declaration required), or the name of any lookup field declared on the bound schema. For a sensitive field, this body variant is required (the GET variant rejects sensitive-field lookups).

Specified by:

field in interface DocumentLookupRequest.FieldStage

Returns:

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

scope

public DocumentLookupRequest._FinalStage scope(String scope)

Root API key ONLY: resolve type's schema as this scope would (basedOn-aware shadowing), as a single namespace:value entry — mirrors GET /v1/schemas?recordType='s scope selector. Ignored for a scoped credential.

Specified by:

scope in interface DocumentLookupRequest._FinalStage

Returns:

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

scope

public DocumentLookupRequest._FinalStage scope(Optional<String> scope)

Root API key ONLY: resolve type's schema as this scope would (basedOn-aware shadowing), as a single namespace:value entry — mirrors GET /v1/schemas?recordType='s scope selector. Ignored for a scoped credential.

Specified by:

scope in interface DocumentLookupRequest._FinalStage

userId

public DocumentLookupRequest._FinalStage userId(String userId)

Root API key ONLY: resolve type's schema as this user would (basedOn-aware shadowing) instead of the shared base — mirrors GET /v1/schemas?recordType='s userId selector. Ignored for a scoped credential, which always resolves via its own token identity.

Specified by:

userId in interface DocumentLookupRequest._FinalStage

Returns:

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

userId

public DocumentLookupRequest._FinalStage userId(Optional<String> userId)

Root API key ONLY: resolve type's schema as this user would (basedOn-aware shadowing) instead of the shared base — mirrors GET /v1/schemas?recordType='s userId selector. Ignored for a scoped credential, which always resolves via its own token identity.

Specified by:

userId in interface DocumentLookupRequest._FinalStage

order

public DocumentLookupRequest._FinalStage order(DocumentLookupRequestOrder order)

Sort direction for the returned results: asc (default) or desc.

Specified by:

order in interface DocumentLookupRequest._FinalStage

Returns:

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

order

public DocumentLookupRequest._FinalStage order(Optional<DocumentLookupRequestOrder> order)

Sort direction for the returned results: asc (default) or desc.

Specified by:

order in interface DocumentLookupRequest._FinalStage

limit

public DocumentLookupRequest._FinalStage limit(Integer limit)

Maximum number of documents to return per page (1–100; defaults to 20).

Specified by:

limit in interface DocumentLookupRequest._FinalStage

Returns:

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

limit

public DocumentLookupRequest._FinalStage limit(Optional<Integer> limit)

Maximum number of documents to return per page (1–100; defaults to 20).

Specified by:

limit in interface DocumentLookupRequest._FinalStage

startFrom

public DocumentLookupRequest._FinalStage startFrom(String startFrom)

Pagination cursor. Pass the nextCursor from the previous page to fetch the next page; omit it for the first page.

Specified by:

startFrom in interface DocumentLookupRequest._FinalStage

Returns:

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

startFrom

public DocumentLookupRequest._FinalStage startFrom(Optional<String> startFrom)

Pagination cursor. Pass the nextCursor from the previous page to fetch the next page; omit it for the first page.

Specified by:

startFrom in interface DocumentLookupRequest._FinalStage

sortTo

public DocumentLookupRequest._FinalStage sortTo(String sortTo)

Inclusive upper bound on the lookup field's sort key, narrowing a value match to documents at or before this point (#870). Use with value; combine with sortFrom.

Specified by:

sortTo in interface DocumentLookupRequest._FinalStage

Returns:

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

sortTo

public DocumentLookupRequest._FinalStage sortTo(Optional<String> sortTo)

Inclusive upper bound on the lookup field's sort key, narrowing a value match to documents at or before this point (#870). Use with value; combine with sortFrom.

Specified by:

sortTo in interface DocumentLookupRequest._FinalStage

sortFrom

public DocumentLookupRequest._FinalStage sortFrom(String sortFrom)

Inclusive lower bound on the lookup field's sort key, narrowing a value match to documents at or after this point (#870). Use with value; combine with sortTo to bound both ends. Give the bound in the same form as the sorted field's own values — epoch milliseconds when the lookup sorts by createdAt or lastUpdated. Documents with no value for the sorted field are never included in a bounded window.

Specified by:

sortFrom in interface DocumentLookupRequest._FinalStage

Returns:

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

sortFrom

public DocumentLookupRequest._FinalStage sortFrom(Optional<String> sortFrom)

Inclusive lower bound on the lookup field's sort key, narrowing a value match to documents at or after this point (#870). Use with value; combine with sortTo to bound both ends. Give the bound in the same form as the sorted field's own values — epoch milliseconds when the lookup sorts by createdAt or lastUpdated. Documents with no value for the sorted field are never included in a bounded window.

Specified by:

sortFrom in interface DocumentLookupRequest._FinalStage

prefix

public DocumentLookupRequest._FinalStage prefix(String prefix)

Prefix to match for a prefix lookup (range-enabled string fields only). Mutually exclusive with value and from/to.

Specified by:

prefix in interface DocumentLookupRequest._FinalStage

Returns:

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

prefix

public DocumentLookupRequest._FinalStage prefix(Optional<String> prefix)

Prefix to match for a prefix lookup (range-enabled string fields only). Mutually exclusive with value and from/to.

Specified by:

prefix in interface DocumentLookupRequest._FinalStage

to

public DocumentLookupRequest._FinalStage to(String to)

Inclusive upper bound for a range lookup (requires from; mutually exclusive with value and prefix).

Specified by:

to in interface DocumentLookupRequest._FinalStage

Returns:

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

to

public DocumentLookupRequest._FinalStage to(Optional<String> to)

Inclusive upper bound for a range lookup (requires from; mutually exclusive with value and prefix).

Specified by:

to in interface DocumentLookupRequest._FinalStage

from

public DocumentLookupRequest._FinalStage from(String from)

Inclusive lower bound for a range lookup (requires to; non-sensitive, range-enabled fields only). Mutually exclusive with value and prefix.

Specified by:

from in interface DocumentLookupRequest._FinalStage

Returns:

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

from

public DocumentLookupRequest._FinalStage from(Optional<String> from)

Inclusive lower bound for a range lookup (requires to; non-sensitive, range-enabled fields only). Mutually exclusive with value and prefix.

Specified by:

from in interface DocumentLookupRequest._FinalStage

value

public DocumentLookupRequest._FinalStage value(String value)

Exact value to match (equality mode). Mutually exclusive with from/to and prefix.

Specified by:

value in interface DocumentLookupRequest._FinalStage

Returns:

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

value

public DocumentLookupRequest._FinalStage value(Optional<String> value)

Exact value to match (equality mode). Mutually exclusive with from/to and prefix.

Specified by:

value in interface DocumentLookupRequest._FinalStage

build

public DocumentLookupRequest build()

Specified by:

build in interface DocumentLookupRequest._FinalStage

additionalProperty

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

Specified by:

additionalProperty in interface DocumentLookupRequest._FinalStage

additionalProperties

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

Specified by:

additionalProperties in interface DocumentLookupRequest._FinalStage