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

Method Details

build

LookupRecordsRequest build()

additionalProperty

LookupRecordsRequest._FinalStage additionalProperty(String key,
 Object value)

additionalProperties

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

value

LookupRecordsRequest._FinalStage value(Optional<String> value)

Exact value to match. Mutually exclusive with from/to and prefix. 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)

startFrom

LookupRecordsRequest._FinalStage startFrom(Optional<String> startFrom)

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

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)