Package ai.vectros.types

Class SchemaResponse

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

  • Method Details

    • getCreated

      public Optional<Boolean> getCreated()
      Returns:
      Whether this call created a new schema. True when a new schema was created; false when a schema with the same typeName already existed and was returned unchanged (idempotent create) or reconciled to the submitted shape (when ?upsert=true). Present only on the create response (POST /v1/schemas); absent on reads. The HTTP status mirrors it — 201 when created, 200 when an existing schema was returned.

    • getId

      public Optional<String> getId()
      Returns:
      Unique identifier for this schema.

    • getTypeName

      public Optional<String> getTypeName()
      Returns:
      Type identifier for this schema.

    • getDisplayName

      public Optional<String> getDisplayName()
      Returns:
      Human-readable display name.

    • getDescription

      public Optional<String> getDescription()
      Returns:
      Description of what this schema is for.

    • getFields

      public Optional<List<FieldDef>> getFields()
      Returns:
      Field definitions used to validate record payloads.

    • getLookupFields

      public Optional<List<LookupDef>> getLookupFields()
      Returns:
      Payload fields indexed for direct lookup queries.

    • getRenderHints

      public Optional<Map<String,RenderHintDef>> getRenderHints()
      Returns:
      UI rendering hints keyed by field id.

    • getCapabilities

      public Optional<Map<String,Boolean>> getCapabilities()
      Returns:
      Feature flags for this schema. auditHistory (default true) controls whether a change-history (version) trail is kept for this type's data; it never affects the records themselves. readAccessLog (default false) controls accounting-of-disclosures logging for reads of this type's records.

    • getStorageProfile

      public Optional<SchemaResponseStorageProfile> getStorageProfile()
      Returns:
      Payload storage profile: STANDARD (externalize large payloads to S3), LOW_LATENCY (always store inline), or LARGE_PAYLOAD (always externalize). Defaults to STANDARD.

    • getIndexMode

      public Optional<SchemaResponseIndexMode> getIndexMode()
      Returns:
      Default search-index mode for this type's records: HYBRID, SEMANTIC, TEXT, or NONE (store-only, not searchable).

    • getAllowedSurfaces

      public Optional<List<SchemaResponseAllowedSurfacesItem>> getAllowedSurfaces()
      Returns:
      Which typed surfaces may bind this schema: record, document, user, or entity — identity entities in ANY namespace (org, client, or one you registered) bind under the single entity surface. Always present (it is required at write time).

    • getActive

      public Optional<Boolean> getActive()
      Returns:
      Whether this schema is active.

    • getBasedOn

      public Optional<String> getBasedOn()
      Returns:
      The id of the schema this one is a customization of, or null if this schema IS the shared base for typeName in this context.

    • getSchemaVersion

      public Optional<Integer> getSchemaVersion()
      Returns:
      Schema version number, incremented each time the schema definition changes.

    • getCreatedAt

      public Optional<String> getCreatedAt()
      Returns:
      When the schema was created, as an ISO-8601 UTC timestamp.

    • getUpdatedAt

      public Optional<String> getUpdatedAt()
      Returns:
      When the schema was last modified, as an ISO-8601 UTC timestamp.

    • 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 SchemaResponse.Builder builder()