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

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

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

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

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

value

public RecordLookupRequest._FinalStage value(String value)

Exact value to match. Mutually exclusive with from/to and prefix. Sensitive fields can only be looked up by exact value, and only through this body variant.

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 and prefix. Sensitive fields can only be looked up by exact value, and only through this body variant.

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