Package ai.vectros.resources.records.requests

Class LookupRecordsRequest.Builder

java.lang.Object

ai.vectros.resources.records.requests.LookupRecordsRequest.Builder

All Implemented Interfaces:

LookupRecordsRequest._FinalStage, LookupRecordsRequest.FieldStage, LookupRecordsRequest.TypeStage

Enclosing class:

LookupRecordsRequest

public static final class LookupRecordsRequest.Builder
extends Object
implements LookupRecordsRequest.TypeStage, LookupRecordsRequest.FieldStage, LookupRecordsRequest._FinalStage

Method Summary

Modifier and Type	Method	Description
LookupRecordsRequest.Builder	additionalProperties(Map<String,Object> additionalProperties)
LookupRecordsRequest.Builder	additionalProperty(String key, Object value)
LookupRecordsRequest	build()
LookupRecordsRequest._FinalStage	field(@NotNull String field)	The name of the lookup field to match on, as declared on the type's schema.
LookupRecordsRequest.Builder	from(LookupRecordsRequest other)
LookupRecordsRequest._FinalStage	from(String from)	Inclusive lower bound of a range lookup (requires to; non-sensitive fields only).
LookupRecordsRequest._FinalStage	from(Optional<String> from)	Inclusive lower bound of a range lookup (requires to; non-sensitive fields only).
LookupRecordsRequest._FinalStage	includePayload(String includePayload)	Set to true to include each record's full payload, rehydrating any payloads stored externally (capped per page).
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)	Maximum number of records to return per page.
LookupRecordsRequest._FinalStage	limit(Optional<Long> limit)	Maximum number of records to return per page.
LookupRecordsRequest._FinalStage	order(LookupRecordsRequestOrder order)	Sort direction by the field's value: asc (ascending, the default) or desc (descending).
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)	Prefix to match (string, non-sensitive fields only).
LookupRecordsRequest._FinalStage	prefix(Optional<String> prefix)	Prefix to match (string, non-sensitive fields only).
LookupRecordsRequest._FinalStage	sortFrom(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	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)	Inclusive upper bound on the lookup field's sort key, narrowing a value match to records at or before this point.
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)	Pagination cursor.
LookupRecordsRequest._FinalStage	startFrom(Optional<String> startFrom)	Pagination cursor.
LookupRecordsRequest._FinalStage	to(String to)	Inclusive upper bound of a range lookup (requires from).
LookupRecordsRequest._FinalStage	to(Optional<String> to)	Inclusive upper bound of a range lookup (requires from).
LookupRecordsRequest.FieldStage	type(@NotNull String type)	The record type to look up, e.g.
LookupRecordsRequest._FinalStage	value(String value)	Exact value to match.
LookupRecordsRequest._FinalStage	value(Optional<String> value)	Exact value to match.
LookupRecordsRequest._FinalStage	values(String values)
LookupRecordsRequest._FinalStage	values(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 (?
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 (?

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

from

public LookupRecordsRequest.Builder from(LookupRecordsRequest other)

Specified by:

from in interface LookupRecordsRequest.TypeStage

type

public LookupRecordsRequest.FieldStage type(@NotNull
 @NotNull String type)

The record type to look up, e.g. intake_form.

The record type to look up, e.g. intake_form.

Specified by:

type in interface LookupRecordsRequest.TypeStage

Returns:

Reference to this so that method calls can be chained together.

field

public LookupRecordsRequest._FinalStage field(@NotNull
 @NotNull String field)

The name of the lookup field to match on, as declared on the type's schema.

The name of the lookup field to match on, as declared on the type's schema.

Specified by:

field in interface LookupRecordsRequest.FieldStage

Returns:

Reference to this so that method calls can be chained together.

order

public LookupRecordsRequest._FinalStage order(LookupRecordsRequestOrder order)

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

Specified by:

order in interface LookupRecordsRequest._FinalStage

Returns:

Reference to this so that method calls can be chained together.

order

public LookupRecordsRequest._FinalStage order(Optional<LookupRecordsRequestOrder> order)

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

Specified by:

order in interface LookupRecordsRequest._FinalStage

includePayload

public LookupRecordsRequest._FinalStage includePayload(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.

Specified by:

includePayload in interface LookupRecordsRequest._FinalStage

Returns:

Reference to this so that method calls can be chained together.

includePayload

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

Specified by:

includePayload in interface LookupRecordsRequest._FinalStage

limit

public LookupRecordsRequest._FinalStage limit(Long limit)

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

Specified by:

limit in interface LookupRecordsRequest._FinalStage

Returns:

Reference to this so that method calls can be chained together.

limit

public LookupRecordsRequest._FinalStage limit(Optional<Long> limit)

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

Specified by:

limit in interface LookupRecordsRequest._FinalStage

startFrom

public LookupRecordsRequest._FinalStage startFrom(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.

Specified by:

startFrom in interface LookupRecordsRequest._FinalStage

Returns:

Reference to this so that method calls can be chained together.

startFrom

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

Specified by:

startFrom in interface LookupRecordsRequest._FinalStage

sortTo

public LookupRecordsRequest._FinalStage sortTo(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.

Specified by:

sortTo in interface LookupRecordsRequest._FinalStage

Returns:

Reference to this so that method calls can be chained together.

sortTo

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

Specified by:

sortTo in interface LookupRecordsRequest._FinalStage

sortFrom

public LookupRecordsRequest._FinalStage sortFrom(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.

Specified by:

sortFrom in interface LookupRecordsRequest._FinalStage

Returns:

Reference to this so that method calls can be chained together.

sortFrom

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

Specified by:

sortFrom in interface LookupRecordsRequest._FinalStage

prefix

public LookupRecordsRequest._FinalStage prefix(String prefix)

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

Specified by:

prefix in interface LookupRecordsRequest._FinalStage

Returns:

Reference to this so that method calls can be chained together.

prefix

public LookupRecordsRequest._FinalStage prefix(Optional<String> prefix)

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

Specified by:

prefix in interface LookupRecordsRequest._FinalStage

to

public LookupRecordsRequest._FinalStage to(String to)

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

Specified by:

to in interface LookupRecordsRequest._FinalStage

Returns:

Reference to this so that method calls can be chained together.

to

public LookupRecordsRequest._FinalStage to(Optional<String> to)

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

Specified by:

to in interface LookupRecordsRequest._FinalStage

from

public LookupRecordsRequest._FinalStage from(String from)

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

Specified by:

from in interface LookupRecordsRequest._FinalStage

Returns:

Reference to this so that method calls can be chained together.

from

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

Specified by:

from in interface LookupRecordsRequest._FinalStage

value

public LookupRecordsRequest._FinalStage value(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.

Specified by:

value in interface LookupRecordsRequest._FinalStage

Returns:

Reference to this so that method calls can be chained together.

value

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

Specified by:

value in interface LookupRecordsRequest._FinalStage

values

public LookupRecordsRequest._FinalStage values(String values)

Specified by:

values in interface LookupRecordsRequest._FinalStage

values

public LookupRecordsRequest._FinalStage values(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.

Specified by:

values in interface LookupRecordsRequest._FinalStage

Returns:

Reference to this so that method calls can be chained together.

values

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

Specified by:

values in interface LookupRecordsRequest._FinalStage

build

public LookupRecordsRequest build()

Specified by:

build in interface LookupRecordsRequest._FinalStage

additionalProperty

public LookupRecordsRequest.Builder additionalProperty(String key,
 Object value)

Specified by:

additionalProperty in interface LookupRecordsRequest._FinalStage

additionalProperties

public LookupRecordsRequest.Builder additionalProperties(Map<String,Object> additionalProperties)

Specified by:

additionalProperties in interface LookupRecordsRequest._FinalStage