Package ai.vectros.types

Class RecordResponse.Builder

java.lang.Object

ai.vectros.types.RecordResponse.Builder

Enclosing class:

RecordResponse

public static final class RecordResponse.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
RecordResponse.Builder	additionalProperties(Map<String,Object> additionalProperties)
RecordResponse.Builder	additionalProperty(String key, Object value)
RecordResponse	build()
RecordResponse.Builder	clientId(String clientId)
RecordResponse.Builder	clientId(Optional<String> clientId)	Identifier of the associated client (a Vectros-assigned UUID).
RecordResponse.Builder	createdAt(String createdAt)
RecordResponse.Builder	createdAt(Optional<String> createdAt)	When the record was created, as an ISO-8601 UTC timestamp.
RecordResponse.Builder	createdBy(String createdBy)
RecordResponse.Builder	createdBy(Optional<String> createdBy)	Identifier of the API key or scoped token that created this record (for example, key_abc123 for an API key).
RecordResponse.Builder	externalId(String externalId)
RecordResponse.Builder	externalId(Optional<String> externalId)	Your own stable identifier for this record.
RecordResponse.Builder	folderId(String folderId)
RecordResponse.Builder	folderId(Optional<String> folderId)	Identifier of the folder grouping this record.
RecordResponse.Builder	from(RecordResponse other)
RecordResponse.Builder	id(String id)
RecordResponse.Builder	id(Optional<String> id)	Unique identifier for this record (UUID), assigned by Vectros at creation.
RecordResponse.Builder	indexMode(RecordResponseIndexMode indexMode)
RecordResponse.Builder	indexMode(Optional<RecordResponseIndexMode> indexMode)	The record's resolved search-index mode: the per-record override if set, otherwise the schema's type-level default, otherwise NONE.
RecordResponse.Builder	indexStatus(RecordResponseIndexStatus indexStatus)
RecordResponse.Builder	indexStatus(Optional<RecordResponseIndexStatus> indexStatus)	Search-index status.
RecordResponse.Builder	orgId(String orgId)
RecordResponse.Builder	orgId(Optional<String> orgId)	Identifier of the owning organization (a Vectros-assigned UUID).
RecordResponse.Builder	payload(Map<String,Object> payload)
RecordResponse.Builder	payload(Optional<Map<String,Object>> payload)	The record's data payload.
RecordResponse.Builder	payloadBytes(Long payloadBytes)
RecordResponse.Builder	payloadBytes(Optional<Long> payloadBytes)	Size in bytes of the full externalized payload.
RecordResponse.Builder	payloadExternalized(Boolean payloadExternalized)
RecordResponse.Builder	payloadExternalized(Optional<Boolean> payloadExternalized)	True when this record's full payload is stored externally rather than inline.
RecordResponse.Builder	schemaId(String schemaId)
RecordResponse.Builder	schemaId(Optional<String> schemaId)	Identifier of the schema this record was validated against.
RecordResponse.Builder	schemaVersion(Integer schemaVersion)
RecordResponse.Builder	schemaVersion(Optional<Integer> schemaVersion)	The version of the governing schema at the moment this record was written.
RecordResponse.Builder	status(String status)
RecordResponse.Builder	status(Optional<String> status)	Record lifecycle status.
RecordResponse.Builder	typeName(String typeName)
RecordResponse.Builder	typeName(Optional<String> typeName)	The record's type, matching the typeName declared on the schema this record was created against.
RecordResponse.Builder	updatedAt(String updatedAt)
RecordResponse.Builder	updatedAt(Optional<String> updatedAt)	When the record was last updated, as an ISO-8601 UTC timestamp.
RecordResponse.Builder	userId(String userId)
RecordResponse.Builder	userId(Optional<String> userId)	Identifier of the owning user (a Vectros-assigned UUID).
RecordResponse.Builder	version(Long version)
RecordResponse.Builder	version(Optional<Long> version)	Optimistic-concurrency version.

Methods inherited from class java.lang.Object

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

Method Details

from

public RecordResponse.Builder from(RecordResponse other)

id

public RecordResponse.Builder id(Optional<String> id)

Unique identifier for this record (UUID), assigned by Vectros at creation.

id

public RecordResponse.Builder id(String id)

typeName

public RecordResponse.Builder typeName(Optional<String> typeName)

The record's type, matching the typeName declared on the schema this record was created against.

typeName

public RecordResponse.Builder typeName(String typeName)

schemaId

public RecordResponse.Builder schemaId(Optional<String> schemaId)

Identifier of the schema this record was validated against.

schemaId

public RecordResponse.Builder schemaId(String schemaId)

schemaVersion

public RecordResponse.Builder schemaVersion(Optional<Integer> schemaVersion)

The version of the governing schema at the moment this record was written. The schema version increments on every schema edit, but a record keeps the version it was stamped with at write time even after the schema evolves — so you always know which schema shape the payload conforms to. Null for a record created without a schema.

schemaVersion

public RecordResponse.Builder schemaVersion(Integer schemaVersion)

externalId

public RecordResponse.Builder externalId(Optional<String> externalId)

Your own stable identifier for this record. Immutable, and unique within your account, context, and record type. Null if the record was created without one.

externalId

public RecordResponse.Builder externalId(String externalId)

payload

public RecordResponse.Builder payload(Optional<Map<String,Object>> payload)

The record's data payload. Its structure is defined by the referenced schema. Fields the schema marks as searchable are indexed for full-text and semantic search. When a record's payload is stored externally (because it is large), list and lookup responses return only the indexed/metadata projection here and set payloadExternalized to true; to retrieve the full payload, fetch the record by id (GET /v1/records/{id}) or pass includePayload=true on the list or lookup call.

payload

public RecordResponse.Builder payload(Map<String,Object> payload)

payloadExternalized

public RecordResponse.Builder payloadExternalized(Optional<Boolean> payloadExternalized)

True when this record's full payload is stored externally rather than inline. In that case list and lookup responses return only the indexed projection in payload unless includePayload=true was passed; fetching the record by id always returns the full payload. Null (omitted) for inline records.

payloadExternalized

public RecordResponse.Builder payloadExternalized(Boolean payloadExternalized)

payloadBytes

public RecordResponse.Builder payloadBytes(Optional<Long> payloadBytes)

Size in bytes of the full externalized payload. Present only when payloadExternalized is true.

payloadBytes

public RecordResponse.Builder payloadBytes(Long payloadBytes)

status

public RecordResponse.Builder status(Optional<String> status)

Record lifecycle status. ACTIVE records are live. Use this field to model soft-delete or workflow states without physically deleting records.

status

public RecordResponse.Builder status(String status)

folderId

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

Identifier of the folder grouping this record. A folder can group both records and documents together.

folderId

public RecordResponse.Builder folderId(String folderId)

userId

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

Identifier of the owning user (a Vectros-assigned UUID). Set automatically from the calling token's identity when the token carries a user identity.

userId

public RecordResponse.Builder userId(String userId)

orgId

public RecordResponse.Builder orgId(Optional<String> orgId)

Identifier of the owning organization (a Vectros-assigned UUID). Set automatically from the calling token's identity when the token carries an organization identity.

orgId

public RecordResponse.Builder orgId(String orgId)

clientId

public RecordResponse.Builder clientId(Optional<String> clientId)

Identifier of the associated client (a Vectros-assigned UUID). Set automatically from the calling token's identity when the token carries a client identity.

clientId

public RecordResponse.Builder clientId(String clientId)

indexStatus

public RecordResponse.Builder indexStatus(Optional<RecordResponseIndexStatus> indexStatus)

Search-index status. PENDING_INDEX means the record is queued for indexing. INDEXED means it is searchable via POST /v1/search. SKIPPED means the record had no indexable text (e.g. only non-searchable fields populated) so there was nothing to index — it is stored and retrievable, just not full-text/semantic searchable until a searchable field is filled in; not an error. FAILED means indexing hit an error — the record is still readable but not searchable. Null for a store-only record (indexMode NONE), which has no indexing to track.

indexStatus

public RecordResponse.Builder indexStatus(RecordResponseIndexStatus indexStatus)

indexMode

public RecordResponse.Builder indexMode(Optional<RecordResponseIndexMode> indexMode)

The record's resolved search-index mode: the per-record override if set, otherwise the schema's type-level default, otherwise NONE. HYBRID, SEMANTIC, and TEXT make the record searchable; NONE is store-only.

indexMode

public RecordResponse.Builder indexMode(RecordResponseIndexMode indexMode)

createdBy

public RecordResponse.Builder createdBy(Optional<String> createdBy)

Identifier of the API key or scoped token that created this record (for example, key_abc123 for an API key).

createdBy

public RecordResponse.Builder createdBy(String createdBy)

createdAt

public RecordResponse.Builder createdAt(Optional<String> createdAt)

When the record was created, as an ISO-8601 UTC timestamp.

createdAt

public RecordResponse.Builder createdAt(String createdAt)

updatedAt

public RecordResponse.Builder updatedAt(Optional<String> updatedAt)

When the record was last updated, as an ISO-8601 UTC timestamp.

updatedAt

public RecordResponse.Builder updatedAt(String updatedAt)

version

public RecordResponse.Builder version(Optional<Long> version)

Optimistic-concurrency version. Pass this value back as expectedVersion on a later update to avoid silently overwriting a concurrent change — the update is rejected with 409 VERSION_CONFLICT if the record changed in the meantime. Incremented on every successful write.

version

public RecordResponse.Builder version(Long version)

build

public RecordResponse build()

additionalProperty

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

additionalProperties

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