Package ai.vectros.resources.documents.requests

Interface DocumentLookupRequest._FinalStage

All Known Implementing Classes:

DocumentLookupRequest.Builder

Enclosing class:

DocumentLookupRequest

public static interface DocumentLookupRequest._FinalStage

Method Summary

Modifier and Type	Method	Description
DocumentLookupRequest._FinalStage	additionalProperties(Map<String,Object> additionalProperties)
DocumentLookupRequest._FinalStage	additionalProperty(String key, Object value)
DocumentLookupRequest	build()
DocumentLookupRequest._FinalStage	from(String from)
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)
DocumentLookupRequest._FinalStage	limit(Optional<Integer> limit)	Maximum number of documents to return per page (1–100; defaults to 20).
DocumentLookupRequest._FinalStage	order(DocumentLookupRequestOrder order)
DocumentLookupRequest._FinalStage	order(Optional<DocumentLookupRequestOrder> order)	Sort direction for the returned results: asc (default) or desc.
DocumentLookupRequest._FinalStage	prefix(String prefix)
DocumentLookupRequest._FinalStage	prefix(Optional<String> prefix)	Prefix to match for a prefix lookup (range-enabled string fields only).
DocumentLookupRequest._FinalStage	scope(String scope)
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	startFrom(String startFrom)
DocumentLookupRequest._FinalStage	startFrom(Optional<String> startFrom)	Pagination cursor.
DocumentLookupRequest._FinalStage	to(String to)
DocumentLookupRequest._FinalStage	to(Optional<String> to)	Inclusive upper bound for a range lookup (requires from; mutually exclusive with value and prefix).
DocumentLookupRequest._FinalStage	userId(String userId)
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)
DocumentLookupRequest._FinalStage	value(Optional<String> value)	Exact value to match (equality mode).

Method Details

build

DocumentLookupRequest build()

additionalProperty

DocumentLookupRequest._FinalStage additionalProperty(String key,
 Object value)

additionalProperties

DocumentLookupRequest._FinalStage additionalProperties(Map<String,Object> additionalProperties)

value

DocumentLookupRequest._FinalStage value(Optional<String> value)

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

value

DocumentLookupRequest._FinalStage value(String value)

from

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.

from

DocumentLookupRequest._FinalStage from(String from)

to

DocumentLookupRequest._FinalStage to(Optional<String> to)

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

to

DocumentLookupRequest._FinalStage to(String to)

prefix

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.

prefix

DocumentLookupRequest._FinalStage prefix(String prefix)

startFrom

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.

startFrom

DocumentLookupRequest._FinalStage startFrom(String startFrom)

limit

DocumentLookupRequest._FinalStage limit(Optional<Integer> limit)

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

limit

DocumentLookupRequest._FinalStage limit(Integer limit)

order

DocumentLookupRequest._FinalStage order(Optional<DocumentLookupRequestOrder> order)

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

order

DocumentLookupRequest._FinalStage order(DocumentLookupRequestOrder order)

userId

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.

userId

DocumentLookupRequest._FinalStage userId(String userId)

scope

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.

scope

DocumentLookupRequest._FinalStage scope(String scope)