Package ai.vectros.resources.records.requests

Interface RecordLookupRequest._FinalStage

All Known Implementing Classes:

RecordLookupRequest.Builder

Enclosing class:

RecordLookupRequest

public static interface RecordLookupRequest._FinalStage

Method Summary

Modifier and Type	Method	Description
RecordLookupRequest._FinalStage	additionalProperties(Map<String,Object> additionalProperties)
RecordLookupRequest._FinalStage	additionalProperty(String key, Object value)
RecordLookupRequest	build()
RecordLookupRequest._FinalStage	from(String from)
RecordLookupRequest._FinalStage	from(Optional<String> from)	Inclusive lower bound for a range lookup (requires to; non-sensitive fields only).
RecordLookupRequest._FinalStage	includePayload(Boolean includePayload)
RecordLookupRequest._FinalStage	includePayload(Optional<Boolean> includePayload)	When true, externalized record payloads are returned in full in this response (capped per page).
RecordLookupRequest._FinalStage	limit(Integer limit)
RecordLookupRequest._FinalStage	limit(Optional<Integer> limit)	Maximum number of records to return per page (1–100; defaults to 20).
RecordLookupRequest._FinalStage	order(RecordLookupRequestOrder order)
RecordLookupRequest._FinalStage	order(Optional<RecordLookupRequestOrder> order)	Sort direction for the returned results: asc (default) or desc.
RecordLookupRequest._FinalStage	prefix(String prefix)
RecordLookupRequest._FinalStage	prefix(Optional<String> prefix)	Prefix to match (string, non-sensitive fields only).
RecordLookupRequest._FinalStage	sortFrom(String sortFrom)
RecordLookupRequest._FinalStage	sortFrom(Optional<String> sortFrom)	Inclusive lower bound on the lookup field's sort key, narrowing a value match to records whose sort key is at or after this point.
RecordLookupRequest._FinalStage	sortTo(String sortTo)
RecordLookupRequest._FinalStage	sortTo(Optional<String> sortTo)	Inclusive upper bound on the lookup field's sort key, narrowing a value match to records whose sort key is at or before this point.
RecordLookupRequest._FinalStage	startFrom(String startFrom)
RecordLookupRequest._FinalStage	startFrom(Optional<String> startFrom)	Pagination cursor — pass the nextCursor returned by the previous page.
RecordLookupRequest._FinalStage	to(String to)
RecordLookupRequest._FinalStage	to(Optional<String> to)	Inclusive upper bound for a range lookup (requires from).
RecordLookupRequest._FinalStage	value(String value)
RecordLookupRequest._FinalStage	value(Optional<String> value)	Exact value to match.
RecordLookupRequest._FinalStage	values(List<String> values)
RecordLookupRequest._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.

Method Details

build

RecordLookupRequest build()

additionalProperty

RecordLookupRequest._FinalStage additionalProperty(String key,
 Object value)

additionalProperties

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

value

RecordLookupRequest._FinalStage value(Optional<String> value)

Exact value to match. Mutually exclusive with from/to, prefix and values. Sensitive fields can only be looked up by exact value, and only through this body variant. For a lookup over several fields, use values instead.

value

RecordLookupRequest._FinalStage value(String value)

values

RecordLookupRequest._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. Mutually exclusive with value; a single-element list is exactly value written uniformly.

You may supply fewer values than the lookup declares, as long as they are a leading run of its fields: on a lookup over [status, area, owner] you can match status, or status and area, but never area alone. Supplying fewer values returns the records grouped by the fields you left unspecified; sortFrom/sortTo then need every value, because sorting is only continuous within one fully specified combination.

values

RecordLookupRequest._FinalStage values(List<String> values)

from

RecordLookupRequest._FinalStage from(Optional<String> from)

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

from

RecordLookupRequest._FinalStage from(String from)

to

RecordLookupRequest._FinalStage to(Optional<String> to)

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

to

RecordLookupRequest._FinalStage to(String to)

prefix

RecordLookupRequest._FinalStage prefix(Optional<String> prefix)

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

prefix

RecordLookupRequest._FinalStage prefix(String prefix)

sortFrom

RecordLookupRequest._FinalStage sortFrom(Optional<String> sortFrom)

Inclusive lower bound on the lookup field's sort key, narrowing a value match to records whose sort key is at or after this point. Use with value; may be combined 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

RecordLookupRequest._FinalStage sortFrom(String sortFrom)

sortTo

RecordLookupRequest._FinalStage sortTo(Optional<String> sortTo)

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

sortTo

RecordLookupRequest._FinalStage sortTo(String sortTo)

startFrom

RecordLookupRequest._FinalStage startFrom(Optional<String> startFrom)

Pagination cursor — pass the nextCursor returned by the previous page.

startFrom

RecordLookupRequest._FinalStage startFrom(String startFrom)

limit

RecordLookupRequest._FinalStage limit(Optional<Integer> limit)

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

limit

RecordLookupRequest._FinalStage limit(Integer limit)

order

RecordLookupRequest._FinalStage order(Optional<RecordLookupRequestOrder> order)

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

order

RecordLookupRequest._FinalStage order(RecordLookupRequestOrder order)

includePayload

RecordLookupRequest._FinalStage includePayload(Optional<Boolean> includePayload)

When true, externalized record payloads are returned in full in this response (capped per page). Defaults to false, which returns only the indexed projection.

includePayload

RecordLookupRequest._FinalStage includePayload(Boolean includePayload)