Package ai.vectros.types

Class RecordRequest

java.lang.Object
ai.vectros.types.RecordRequest
public final class RecordRequest extends Object

  • Method Details

    • getTypeName

      public Optional<String> getTypeName()
      Returns:
      The record type, matching a schema's record type. Provide typeName or schemaId (at least one is required); when only schemaId is given, the type is resolved from the schema, and when both are given they must agree. Immutable after creation and ignored on update.

    • getSchemaId

      public Optional<String> getSchemaId()
      Returns:
      Identifier of the schema to validate against. Optional: omit it and the server resolves the schema from typeName (record types are unique within your account and context); supply it (and omit typeName) to pin a schema and resolve the type from it. Provide typeName or schemaId (at least one); when both are given the server checks that they agree. Immutable after creation and ignored on update.

    • getPayload

      public Optional<Map<String,Object>> getPayload()
      Returns:
      The record's data payload — a JSON object whose structure is validated against the referenced schema. Fields the schema marks as searchable contribute to full-text and semantic search. On update, the supplied object replaces the stored payload in full (it is not key-merged); omit it to leave the payload unchanged.

    • getStatus

      public Optional<RecordRequestStatus> getStatus()
      Returns:
      Record lifecycle status. ACTIVE (the default) keeps the record live and searchable; ARCHIVED retracts it from search and recall (POST /v1/search and RAG) while keeping it stored, retrievable by id, findable by structured-field lookup, and listed by GET /v1/records — set it back to ACTIVE to re-index and restore. On update, omit to leave the current status unchanged.

    • getFolderId

      public Optional<String> getFolderId()
      Returns:
      Identifier of the folder to group this record with related documents. On create, omit to leave the record ungrouped. On update, omit to leave it unchanged; once set, this field cannot be cleared.

    • getUserId

      public Optional<String> getUserId()
      Returns:
      Identifier of the owning user — the Vectros-assigned UUID of a user in your account. Optional, and may be set automatically from the calling token's identity. Use GET /v1/users?externalId= to resolve the UUID from your own identifier.

    • getScopes

      public Optional<List<String>> getScopes()
      Returns:
      The record's scope ownership, as namespace:value entries (at most 2 namespaces) — for example ["org:6ba7b810-9dad-11d1-80b4-00c04fd430c8", "group:eng-team"]. org and client are built-in namespaces; others are custom scopes you define (lowercase, 2-32 chars). Resolve a namespace's UUID from your own identifier with GET /v1/entities/{namespace}?externalId=. When supplied, this is the record's COMPLETE scope declaration: for a token that stamps identity, entries must match the token's identity values, and an empty array creates a record owned by the calling user alone (the private tier). Omit the field to inherit the token's full identity — the default. On update, omit to leave ownership unchanged, or supply the complete new selection ([] clears it). Filter lists by these values with ?scope=.

    • getExternalId

      public Optional<String> getExternalId()
      Returns:
      Your own stable identifier for this record. Optional, and immutable after create. Unique within your account, context, and record type: posting again with the same externalId returns the existing record (idempotent create), and it is the key other records reference. Maximum 256 characters.

    • getIndexMode

      public Optional<RecordRequestIndexMode> getIndexMode()
      Returns:
      Per-record override of the search-index mode. HYBRID, SEMANTIC, and TEXT index this record for search; NONE is store-only (persisted, retrievable by id, and findable by structured-field lookup, but not searchable). Optional — omit it to inherit the schema's type-level default index mode (which itself defaults to NONE when the schema declares none). When both are set, this per-record value wins. Immutable after create.

    • getExpiresAt

      public Optional<String> getExpiresAt()
      Returns:
      Optional absolute expiry, as an ISO-8601 UTC timestamp. When set, the record is automatically deleted at (or shortly after) this time — removed from search and storage, the same as an explicit delete. Requires the schema to opt in with capabilities.ttlEligible: true (else the request is rejected). Must be at least 10 minutes in the future. Omit to leave the record's expiry unchanged; records have no expiry by default.

    • getExpectedVersion

      public Optional<Long> getExpectedVersion()
      Returns:
      Optimistic-concurrency token. Pass the version you last read (from a fetch or a prior write response) to make this update conditional — it is rejected with 409 VERSION_CONFLICT if the record was modified since, leaving the stored record untouched. Omit it for last-write-wins (the default). Ignored on create.

    • equals

      public boolean equals(Object other)
      Overrides:
      equals in class Object

    • getAdditionalProperties

      public Map<String,Object> getAdditionalProperties()

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • builder

      public static RecordRequest.Builder builder()