Package ai.vectros.types

Class SchemaResponse.Builder

java.lang.Object

ai.vectros.types.SchemaResponse.Builder

Enclosing class:

SchemaResponse

public static final class SchemaResponse.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
SchemaResponse.Builder	active(Boolean active)
SchemaResponse.Builder	active(Optional<Boolean> active)	Whether this schema is active.
SchemaResponse.Builder	additionalProperties(Map<String,Object> additionalProperties)
SchemaResponse.Builder	additionalProperty(String key, Object value)
SchemaResponse.Builder	allowedSurfaces(List<SchemaResponseAllowedSurfacesItem> allowedSurfaces)
SchemaResponse.Builder	allowedSurfaces(Optional<List<SchemaResponseAllowedSurfacesItem>> allowedSurfaces)	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.
SchemaResponse.Builder	basedOn(String basedOn)
SchemaResponse.Builder	basedOn(Optional<String> basedOn)	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.
SchemaResponse	build()
SchemaResponse.Builder	capabilities(Map<String,Boolean> capabilities)
SchemaResponse.Builder	capabilities(Optional<Map<String,Boolean>> capabilities)	Feature flags for this schema.
SchemaResponse.Builder	created(Boolean created)
SchemaResponse.Builder	created(Optional<Boolean> created)	Whether this call created a new schema.
SchemaResponse.Builder	createdAt(String createdAt)
SchemaResponse.Builder	createdAt(Optional<String> createdAt)	When the schema was created, as an ISO-8601 UTC timestamp.
SchemaResponse.Builder	description(String description)
SchemaResponse.Builder	description(Optional<String> description)	Description of what this schema is for.
SchemaResponse.Builder	displayName(String displayName)
SchemaResponse.Builder	displayName(Optional<String> displayName)	Human-readable display name.
SchemaResponse.Builder	fields(List<FieldDef> fields)
SchemaResponse.Builder	fields(Optional<List<FieldDef>> fields)	Field definitions used to validate record payloads.
SchemaResponse.Builder	from(SchemaResponse other)
SchemaResponse.Builder	id(String id)
SchemaResponse.Builder	id(Optional<String> id)	Unique identifier for this schema.
SchemaResponse.Builder	indexMode(SchemaResponseIndexMode indexMode)
SchemaResponse.Builder	indexMode(Optional<SchemaResponseIndexMode> indexMode)	Default search-index mode for this type's records: HYBRID, SEMANTIC, TEXT, or NONE (store-only, not searchable).
SchemaResponse.Builder	lookupFields(List<LookupDef> lookupFields)
SchemaResponse.Builder	lookupFields(Optional<List<LookupDef>> lookupFields)	Payload fields indexed for direct lookup queries.
SchemaResponse.Builder	renderHints(Map<String,RenderHintDef> renderHints)
SchemaResponse.Builder	renderHints(Optional<Map<String,RenderHintDef>> renderHints)	UI rendering hints keyed by field id.
SchemaResponse.Builder	schemaVersion(Integer schemaVersion)
SchemaResponse.Builder	schemaVersion(Optional<Integer> schemaVersion)	Schema version number, incremented each time the schema definition changes.
SchemaResponse.Builder	storageProfile(SchemaResponseStorageProfile storageProfile)
SchemaResponse.Builder	storageProfile(Optional<SchemaResponseStorageProfile> storageProfile)	Payload storage profile: STANDARD (externalize large payloads to S3), LOW_LATENCY (always store inline), or LARGE_PAYLOAD (always externalize).
SchemaResponse.Builder	typeName(String typeName)
SchemaResponse.Builder	typeName(Optional<String> typeName)	Type identifier for this schema.
SchemaResponse.Builder	updatedAt(String updatedAt)
SchemaResponse.Builder	updatedAt(Optional<String> updatedAt)	When the schema was last modified, as an ISO-8601 UTC timestamp.

Methods inherited from class java.lang.Object

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

Method Details

from

public SchemaResponse.Builder from(SchemaResponse other)

created

public SchemaResponse.Builder created(Optional<Boolean> created)

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.

created

public SchemaResponse.Builder created(Boolean created)

id

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

Unique identifier for this schema.

id

public SchemaResponse.Builder id(String id)

typeName

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

Type identifier for this schema.

typeName

public SchemaResponse.Builder typeName(String typeName)

displayName

public SchemaResponse.Builder displayName(Optional<String> displayName)

Human-readable display name.

displayName

public SchemaResponse.Builder displayName(String displayName)

description

public SchemaResponse.Builder description(Optional<String> description)

Description of what this schema is for.

description

public SchemaResponse.Builder description(String description)

fields

public SchemaResponse.Builder fields(Optional<List<FieldDef>> fields)

Field definitions used to validate record payloads.

fields

public SchemaResponse.Builder fields(List<FieldDef> fields)

lookupFields

public SchemaResponse.Builder lookupFields(Optional<List<LookupDef>> lookupFields)

Payload fields indexed for direct lookup queries.

lookupFields

public SchemaResponse.Builder lookupFields(List<LookupDef> lookupFields)

renderHints

public SchemaResponse.Builder renderHints(Optional<Map<String,RenderHintDef>> renderHints)

UI rendering hints keyed by field id.

renderHints

public SchemaResponse.Builder renderHints(Map<String,RenderHintDef> renderHints)

capabilities

public SchemaResponse.Builder capabilities(Optional<Map<String,Boolean>> capabilities)

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.

capabilities

public SchemaResponse.Builder capabilities(Map<String,Boolean> capabilities)

storageProfile

public SchemaResponse.Builder storageProfile(Optional<SchemaResponseStorageProfile> storageProfile)

Payload storage profile: STANDARD (externalize large payloads to S3), LOW_LATENCY (always store inline), or LARGE_PAYLOAD (always externalize). Defaults to STANDARD.

storageProfile

public SchemaResponse.Builder storageProfile(SchemaResponseStorageProfile storageProfile)

indexMode

public SchemaResponse.Builder indexMode(Optional<SchemaResponseIndexMode> indexMode)

Default search-index mode for this type's records: HYBRID, SEMANTIC, TEXT, or NONE (store-only, not searchable).

indexMode

public SchemaResponse.Builder indexMode(SchemaResponseIndexMode indexMode)

allowedSurfaces

public SchemaResponse.Builder allowedSurfaces(Optional<List<SchemaResponseAllowedSurfacesItem>> allowedSurfaces)

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

allowedSurfaces

public SchemaResponse.Builder allowedSurfaces(List<SchemaResponseAllowedSurfacesItem> allowedSurfaces)

active

public SchemaResponse.Builder active(Optional<Boolean> active)

Whether this schema is active.

active

public SchemaResponse.Builder active(Boolean active)

basedOn

public SchemaResponse.Builder basedOn(Optional<String> basedOn)

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.

basedOn

public SchemaResponse.Builder basedOn(String basedOn)

schemaVersion

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

Schema version number, incremented each time the schema definition changes.

schemaVersion

public SchemaResponse.Builder schemaVersion(Integer schemaVersion)

createdAt

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

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

createdAt

public SchemaResponse.Builder createdAt(String createdAt)

updatedAt

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

When the schema was last modified, as an ISO-8601 UTC timestamp.

updatedAt

public SchemaResponse.Builder updatedAt(String updatedAt)

build

public SchemaResponse build()

additionalProperty

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

additionalProperties

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