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<String> getStatus()
      Returns:
      Record lifecycle status. Defaults to ACTIVE. Use it to model soft-delete or workflow states without physically deleting records.

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

    • getOrgId

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

    • getClientId

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

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

    • 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()