Package ai.vectros.resources.records.requests

Interface LookupRecordsRequest._FinalStage

All Known Implementing Classes:

LookupRecordsRequest.Builder

Enclosing class:

LookupRecordsRequest

public static interface LookupRecordsRequest._FinalStage

Method Summary

Modifier and Type	Method	Description
LookupRecordsRequest._FinalStage	additionalProperties(Map<String,Object> additionalProperties)
LookupRecordsRequest._FinalStage	additionalProperty(String key, Object value)
LookupRecordsRequest	build()
LookupRecordsRequest._FinalStage	from(String from)
LookupRecordsRequest._FinalStage	from(Optional<String> from)	Inclusive lower bound of a range lookup (requires to; non-sensitive fields only).
LookupRecordsRequest._FinalStage	includePayload(String includePayload)
LookupRecordsRequest._FinalStage	includePayload(Optional<String> includePayload)	Set to true to include each record's full payload, rehydrating any payloads stored externally (capped per page).
LookupRecordsRequest._FinalStage	limit(Long limit)
LookupRecordsRequest._FinalStage	limit(Optional<Long> limit)	Maximum number of records to return per page.
LookupRecordsRequest._FinalStage	order(LookupRecordsRequestOrder order)
LookupRecordsRequest._FinalStage	order(Optional<LookupRecordsRequestOrder> order)	Sort direction by the field's value: asc (ascending, the default) or desc (descending).
LookupRecordsRequest._FinalStage	prefix(String prefix)
LookupRecordsRequest._FinalStage	prefix(Optional<String> prefix)	Prefix to match (string, non-sensitive fields only).
LookupRecordsRequest._FinalStage	sortFrom(String sortFrom)
LookupRecordsRequest._FinalStage	sortFrom(Optional<String> sortFrom)	Inclusive lower bound on the lookup field's sort key, narrowing a value match to records at or after this point.
LookupRecordsRequest._FinalStage	sortTo(String sortTo)
LookupRecordsRequest._FinalStage	sortTo(Optional<String> sortTo)	Inclusive upper bound on the lookup field's sort key, narrowing a value match to records at or before this point.
LookupRecordsRequest._FinalStage	startFrom(String startFrom)
LookupRecordsRequest._FinalStage	startFrom(Optional<String> startFrom)	Pagination cursor.
LookupRecordsRequest._FinalStage	to(String to)
LookupRecordsRequest._FinalStage	to(Optional<String> to)	Inclusive upper bound of a range lookup (requires from).
LookupRecordsRequest._FinalStage	value(String value)
LookupRecordsRequest._FinalStage	value(Optional<String> value)	Exact value to match.
LookupRecordsRequest._FinalStage	values(String values)
LookupRecordsRequest._FinalStage	values(List<String> values)
LookupRecordsRequest._FinalStage	values(Optional<List<String>> values)	Exact values to match, for a lookup declared over several fields — one value per field, in the order the lookup declares them, given as a repeated parameter (?

Method Details

build

LookupRecordsRequest build()

additionalProperty

LookupRecordsRequest._FinalStage additionalProperty(String key,
 Object value)

additionalProperties

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

values

LookupRecordsRequest._FinalStage values(Optional<List<String>> values)

Exact values to match, for a lookup declared over several fields — one value per field, in the order the lookup declares them, given as a repeated parameter (?field=status,area&values=open&values=billing). Mutually exclusive with value; a single values is identical to value.

You may supply fewer values than the lookup declares, as long as they are a leading run of its fields; doing so returns the records grouped by the fields you left unspecified. Narrowing with sortFrom/sortTo then requires a value for every field, because the ordering is only continuous within one fully specified combination.

values

LookupRecordsRequest._FinalStage values(List<String> values)

values

LookupRecordsRequest._FinalStage values(String values)

value

LookupRecordsRequest._FinalStage value(Optional<String> value)

Exact value to match. Mutually exclusive with from/to, prefix and values. Rejected for a sensitive field — use POST /v1/records/lookup instead so the value is not exposed in the URL.

value

LookupRecordsRequest._FinalStage value(String value)

from

LookupRecordsRequest._FinalStage from(Optional<String> from)

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

from

LookupRecordsRequest._FinalStage from(String from)

to

LookupRecordsRequest._FinalStage to(Optional<String> to)

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

to

LookupRecordsRequest._FinalStage to(String to)

prefix

LookupRecordsRequest._FinalStage prefix(Optional<String> prefix)

Prefix to match (string, non-sensitive fields only). Mutually exclusive with value and from/to.

prefix

LookupRecordsRequest._FinalStage prefix(String prefix)

sortFrom

LookupRecordsRequest._FinalStage sortFrom(Optional<String> sortFrom)

Inclusive lower bound on the lookup field's sort key, narrowing a value match to records 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. Records with no value for the sorted field are never included in a bounded window.

sortFrom

LookupRecordsRequest._FinalStage sortFrom(String sortFrom)

sortTo

LookupRecordsRequest._FinalStage sortTo(Optional<String> sortTo)

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

sortTo

LookupRecordsRequest._FinalStage sortTo(String sortTo)

startFrom

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

LookupRecordsRequest._FinalStage startFrom(String startFrom)

limit

LookupRecordsRequest._FinalStage limit(Optional<Long> limit)

Maximum number of records to return per page. Allowed range 1–100; defaults to 20.

limit

LookupRecordsRequest._FinalStage limit(Long limit)

includePayload

LookupRecordsRequest._FinalStage includePayload(Optional<String> includePayload)

Set to true to include each record's full payload, rehydrating any payloads stored externally (capped per page). Defaults to false, which returns only the indexed projection.

includePayload

LookupRecordsRequest._FinalStage includePayload(String includePayload)

order

LookupRecordsRequest._FinalStage order(Optional<LookupRecordsRequestOrder> order)

Sort direction by the field's value: asc (ascending, the default) or desc (descending).

order

LookupRecordsRequest._FinalStage order(LookupRecordsRequestOrder order)