Package ai.vectros.resources.documents.requests

Interface LookupDocumentsRequest._FinalStage

All Known Implementing Classes:

LookupDocumentsRequest.Builder

Enclosing class:

LookupDocumentsRequest

public static interface LookupDocumentsRequest._FinalStage

Method Summary

Modifier and Type	Method	Description
LookupDocumentsRequest._FinalStage	additionalProperties(Map<String,Object> additionalProperties)
LookupDocumentsRequest._FinalStage	additionalProperty(String key, Object value)
LookupDocumentsRequest	build()
LookupDocumentsRequest._FinalStage	from(String from)
LookupDocumentsRequest._FinalStage	from(Optional<String> from)	Inclusive lower bound for a range lookup (requires to; range-enabled, non-sensitive fields only).
LookupDocumentsRequest._FinalStage	limit(Long limit)
LookupDocumentsRequest._FinalStage	limit(Optional<Long> limit)	Maximum number of documents to return per page (1-100; defaults to 20).
LookupDocumentsRequest._FinalStage	order(LookupDocumentsRequestOrder order)
LookupDocumentsRequest._FinalStage	order(Optional<LookupDocumentsRequestOrder> order)	Sort direction for the returned documents: asc (the default) or desc.
LookupDocumentsRequest._FinalStage	prefix(String prefix)
LookupDocumentsRequest._FinalStage	prefix(Optional<String> prefix)	Prefix to match for a prefix lookup (range-enabled string fields only).
LookupDocumentsRequest._FinalStage	scope(String scope)
LookupDocumentsRequest._FinalStage	scope(Optional<String> scope)	Root API key ONLY: resolve type's schema as this scope would, as a single namespace:value entry — mirrors GET /v1/schemas?
LookupDocumentsRequest._FinalStage	sortFrom(String sortFrom)
LookupDocumentsRequest._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.
LookupDocumentsRequest._FinalStage	sortTo(String sortTo)
LookupDocumentsRequest._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.
LookupDocumentsRequest._FinalStage	startFrom(String startFrom)
LookupDocumentsRequest._FinalStage	startFrom(Optional<String> startFrom)	Pagination cursor.
LookupDocumentsRequest._FinalStage	to(String to)
LookupDocumentsRequest._FinalStage	to(Optional<String> to)	Inclusive upper bound for a range lookup (requires from).
LookupDocumentsRequest._FinalStage	userId(String userId)
LookupDocumentsRequest._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?
LookupDocumentsRequest._FinalStage	value(String value)
LookupDocumentsRequest._FinalStage	value(Optional<String> value)	Exact value to match.

Method Details

build

LookupDocumentsRequest build()

additionalProperty

LookupDocumentsRequest._FinalStage additionalProperty(String key,
 Object value)

additionalProperties

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

value

LookupDocumentsRequest._FinalStage value(Optional<String> value)

Exact value to match. Mutually exclusive with from/to and prefix. Rejected for a sensitive field — use POST /v1/documents/lookup so the value isn't exposed in the URL.

value

LookupDocumentsRequest._FinalStage value(String value)

from

LookupDocumentsRequest._FinalStage from(Optional<String> from)

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

from

LookupDocumentsRequest._FinalStage from(String from)

to

LookupDocumentsRequest._FinalStage to(Optional<String> to)

Inclusive upper bound for a range lookup (requires from).

to

LookupDocumentsRequest._FinalStage to(String to)

prefix

LookupDocumentsRequest._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

LookupDocumentsRequest._FinalStage prefix(String prefix)

sortFrom

LookupDocumentsRequest._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. 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.

sortFrom

LookupDocumentsRequest._FinalStage sortFrom(String sortFrom)

sortTo

LookupDocumentsRequest._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. Use with value; combine with sortFrom.

sortTo

LookupDocumentsRequest._FinalStage sortTo(String sortTo)

startFrom

LookupDocumentsRequest._FinalStage startFrom(Optional<String> startFrom)

Pagination cursor. Pass the nextCursor returned by the previous page to fetch the next page; omit it for the first page. The cursor is opaque — echo it back unchanged, and do not parse it or construct one. Keep every other query parameter identical while paging: a cursor is valid only for the exact query that returned it, and reusing one against a different query is rejected with a 400.

startFrom

LookupDocumentsRequest._FinalStage startFrom(String startFrom)

limit

LookupDocumentsRequest._FinalStage limit(Optional<Long> limit)

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

limit

LookupDocumentsRequest._FinalStage limit(Long limit)

order

LookupDocumentsRequest._FinalStage order(Optional<LookupDocumentsRequestOrder> order)

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

order

LookupDocumentsRequest._FinalStage order(LookupDocumentsRequestOrder order)

userId

LookupDocumentsRequest._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.

userId

LookupDocumentsRequest._FinalStage userId(String userId)

scope

LookupDocumentsRequest._FinalStage scope(Optional<String> scope)

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

scope

LookupDocumentsRequest._FinalStage scope(String scope)