Package ai.vectros.resources.records.requests

Class ListRecordsRequest.Builder

java.lang.Object

ai.vectros.resources.records.requests.ListRecordsRequest.Builder

Enclosing class:

ListRecordsRequest

public static final class ListRecordsRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
ListRecordsRequest.Builder	additionalProperties(Map<String,Object> additionalProperties)
ListRecordsRequest.Builder	additionalProperty(String key, Object value)
ListRecordsRequest	build()
ListRecordsRequest.Builder	folderId(String folderId)
ListRecordsRequest.Builder	folderId(Optional<String> folderId)	List all records in this folder, regardless of type.
ListRecordsRequest.Builder	from(ListRecordsRequest other)
ListRecordsRequest.Builder	includePayload(String includePayload)
ListRecordsRequest.Builder	includePayload(Optional<String> includePayload)	Set to true to include each record's full payload in this response, rehydrating any externally stored payloads (hydration is capped per page).
ListRecordsRequest.Builder	limit(Long limit)
ListRecordsRequest.Builder	limit(Optional<Long> limit)	Maximum number of records to return per page.
ListRecordsRequest.Builder	recent(String recent)
ListRecordsRequest.Builder	recent(Optional<String> recent)	Set to true to return the account-wide recently-updated feed across all record types, newest first — a type-agnostic activity view.
ListRecordsRequest.Builder	scope(String scope)
ListRecordsRequest.Builder	scope(Optional<String> scope)	Filter to records carrying this scope value, in namespace:value form (a value is 1-128 chars: a letter or digit first, then letters, digits, _ or -) — for example group:eng-team, org:<id>, or client:<id>.
ListRecordsRequest.Builder	startFrom(String startFrom)
ListRecordsRequest.Builder	startFrom(Optional<String> startFrom)	Pagination cursor.
ListRecordsRequest.Builder	type(String type)
ListRecordsRequest.Builder	type(Optional<String> type)	The record type to list, e.g.
ListRecordsRequest.Builder	userId(String userId)
ListRecordsRequest.Builder	userId(Optional<String> userId)	Filter to records owned by this user.

Methods inherited from class java.lang.Object

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

Method Details

from

public ListRecordsRequest.Builder from(ListRecordsRequest other)

type

public ListRecordsRequest.Builder type(Optional<String> type)

The record type to list, e.g. intake_form. Required unless folderId or recent=true is given.

type

public ListRecordsRequest.Builder type(String type)

folderId

public ListRecordsRequest.Builder folderId(Optional<String> folderId)

List all records in this folder, regardless of type. The value is a Vectros-assigned folder UUID. Required unless type or recent=true is given; may be combined with type to list a single type within the folder.

folderId

public ListRecordsRequest.Builder folderId(String folderId)

userId

public ListRecordsRequest.Builder userId(Optional<String> userId)

Filter to records owned by this user. The value is the Vectros-assigned UUID of a user; resolve one from your own ID via GET /v1/users?externalId=.

userId

public ListRecordsRequest.Builder userId(String userId)

scope

public ListRecordsRequest.Builder scope(Optional<String> scope)

Filter to records carrying this scope value, in namespace:value form (a value is 1-128 chars: a letter or digit first, then letters, digits, _ or -) — for example group:eng-team, org:<id>, or client:<id>. Resolve an entity's UUID from your own identifier via GET /v1/entities/{namespace}?externalId=. Combine with type or folderId.

scope

public ListRecordsRequest.Builder scope(String scope)

startFrom

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

startFrom

public ListRecordsRequest.Builder startFrom(String startFrom)

limit

public ListRecordsRequest.Builder limit(Optional<Long> limit)

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

limit

public ListRecordsRequest.Builder limit(Long limit)

includePayload

public ListRecordsRequest.Builder includePayload(Optional<String> includePayload)

Set to true to include each record's full payload in this response, rehydrating any externally stored payloads (hydration is capped per page). Defaults to false, which returns only the indexed projection; fetch a full payload via GET /v1/records/{id}.

includePayload

public ListRecordsRequest.Builder includePayload(String includePayload)

recent

public ListRecordsRequest.Builder recent(Optional<String> recent)

Set to true to return the account-wide recently-updated feed across all record types, newest first — a type-agnostic activity view. This mode is standalone: it ignores type, folderId, and the owner filters. Per-record scope still applies — you see only the record types your token may read.

recent

public ListRecordsRequest.Builder recent(String recent)

build

public ListRecordsRequest build()

additionalProperty

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

additionalProperties

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