Package ai.vectros.resources.records.requests

Class RecordLookupRequest.Builder

java.lang.Object

ai.vectros.resources.records.requests.RecordLookupRequest.Builder

All Implemented Interfaces:

RecordLookupRequest._FinalStage, RecordLookupRequest.FieldStage, RecordLookupRequest.TypeStage

Enclosing class:

RecordLookupRequest

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

Method Summary

Modifier and Type	Method	Description
RecordLookupRequest.Builder	additionalProperties(Map<String,Object> additionalProperties)
RecordLookupRequest.Builder	additionalProperty(String key, Object value)
RecordLookupRequest	build()
RecordLookupRequest._FinalStage	field(@NotNull String field)	Name of the lookup field declared on the schema.
RecordLookupRequest.Builder	from(RecordLookupRequest other)
RecordLookupRequest._FinalStage	from(String from)	Inclusive lower bound for a range lookup (requires to; non-sensitive fields only).
RecordLookupRequest._FinalStage	from(Optional<String> from)	Inclusive lower bound for a range lookup (requires to; non-sensitive fields only).
RecordLookupRequest._FinalStage	includePayload(Boolean includePayload)	When true, externalized record payloads are returned in full in this response (capped per page).
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)	Maximum number of records to return per page (1–100; defaults to 20).
RecordLookupRequest._FinalStage	limit(Optional<Integer> limit)	Maximum number of records to return per page (1–100; defaults to 20).
RecordLookupRequest._FinalStage	order(RecordLookupRequestOrder order)	Sort direction for the returned results: asc (default) or desc.
RecordLookupRequest._FinalStage	order(Optional<RecordLookupRequestOrder> order)	Sort direction for the returned results: asc (default) or desc.
RecordLookupRequest._FinalStage	prefix(String prefix)	Prefix to match (string, non-sensitive fields only).
RecordLookupRequest._FinalStage	prefix(Optional<String> prefix)	Prefix to match (string, non-sensitive fields only).
RecordLookupRequest._FinalStage	sortFrom(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	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)	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	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)	Pagination cursor — pass the nextCursor returned by the previous page.
RecordLookupRequest._FinalStage	startFrom(Optional<String> startFrom)	Pagination cursor — pass the nextCursor returned by the previous page.
RecordLookupRequest._FinalStage	to(String to)	Inclusive upper bound for a range lookup (requires from).
RecordLookupRequest._FinalStage	to(Optional<String> to)	Inclusive upper bound for a range lookup (requires from).
RecordLookupRequest.FieldStage	type(@NotNull String type)	The record type to look up (for example, intake_form).
RecordLookupRequest._FinalStage	value(String value)	Exact value to match.
RecordLookupRequest._FinalStage	value(Optional<String> value)	Exact value to match.
RecordLookupRequest._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.
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.

Methods inherited from class java.lang.Object

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

Method Details

from

public RecordLookupRequest.Builder from(RecordLookupRequest other)

Specified by:

from in interface RecordLookupRequest.TypeStage

type

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

The record type to look up (for example, intake_form).

The record type to look up (for example, intake_form).

Specified by:

type in interface RecordLookupRequest.TypeStage

Returns:

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

field

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

Name of the lookup field declared on the schema. For a field marked sensitive, this body variant is required (the GET variant rejects looking up by a sensitive value). For a lookup declared over several fields, give those field names joined with commas (status,area) and put the values in values.

Name of the lookup field declared on the schema. For a field marked sensitive, this body variant is required (the GET variant rejects looking up by a sensitive value). For a lookup declared over several fields, give those field names joined with commas (status,area) and put the values in values.

Specified by:

field in interface RecordLookupRequest.FieldStage

Returns:

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

includePayload

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

Specified by:

includePayload in interface RecordLookupRequest._FinalStage

Returns:

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

includePayload

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

Specified by:

includePayload in interface RecordLookupRequest._FinalStage

order

public RecordLookupRequest._FinalStage order(RecordLookupRequestOrder order)

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

Specified by:

order in interface RecordLookupRequest._FinalStage

Returns:

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

order

public RecordLookupRequest._FinalStage order(Optional<RecordLookupRequestOrder> order)

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

Specified by:

order in interface RecordLookupRequest._FinalStage

limit

public RecordLookupRequest._FinalStage limit(Integer limit)

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

Specified by:

limit in interface RecordLookupRequest._FinalStage

Returns:

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

limit

public RecordLookupRequest._FinalStage limit(Optional<Integer> limit)

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

Specified by:

limit in interface RecordLookupRequest._FinalStage

startFrom

public RecordLookupRequest._FinalStage startFrom(String startFrom)

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

Specified by:

startFrom in interface RecordLookupRequest._FinalStage

Returns:

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

startFrom

public RecordLookupRequest._FinalStage startFrom(Optional<String> startFrom)

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

Specified by:

startFrom in interface RecordLookupRequest._FinalStage

sortTo

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

Specified by:

sortTo in interface RecordLookupRequest._FinalStage

Returns:

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

sortTo

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

Specified by:

sortTo in interface RecordLookupRequest._FinalStage

sortFrom

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

Specified by:

sortFrom in interface RecordLookupRequest._FinalStage

Returns:

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

sortFrom

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

Specified by:

sortFrom in interface RecordLookupRequest._FinalStage

prefix

public RecordLookupRequest._FinalStage prefix(String prefix)

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

Specified by:

prefix in interface RecordLookupRequest._FinalStage

Returns:

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

prefix

public RecordLookupRequest._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 RecordLookupRequest._FinalStage

to

public RecordLookupRequest._FinalStage to(String to)

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

Specified by:

to in interface RecordLookupRequest._FinalStage

Returns:

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

to

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

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

Specified by:

to in interface RecordLookupRequest._FinalStage

from

public RecordLookupRequest._FinalStage from(String from)

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

Specified by:

from in interface RecordLookupRequest._FinalStage

Returns:

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

from

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

Specified by:

from in interface RecordLookupRequest._FinalStage

values

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

Specified by:

values in interface RecordLookupRequest._FinalStage

Returns:

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

values

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

Specified by:

values in interface RecordLookupRequest._FinalStage

value

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

Specified by:

value in interface RecordLookupRequest._FinalStage

Returns:

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

value

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

Specified by:

value in interface RecordLookupRequest._FinalStage

build

public RecordLookupRequest build()

Specified by:

build in interface RecordLookupRequest._FinalStage

additionalProperty

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

Specified by:

additionalProperty in interface RecordLookupRequest._FinalStage

additionalProperties

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

Specified by:

additionalProperties in interface RecordLookupRequest._FinalStage