Interface SchemaRequest._FinalStage
- All Known Implementing Classes:
SchemaRequest.Builder
- Enclosing class:
SchemaRequest
-
Method Summary
Modifier and TypeMethodDescriptionWhether this schema is active.addAllAllowedSurfaces(List<SchemaRequestAllowedSurfacesItem> allowedSurfaces) addAllowedSurfaces(SchemaRequestAllowedSurfacesItem allowedSurfaces) additionalProperties(Map<String, Object> additionalProperties) additionalProperty(String key, Object value) allowedSurfaces(List<SchemaRequestAllowedSurfacesItem> allowedSurfaces) Which typed surfaces may bind this schema by its id: record, document, user, org, or client.build()capabilities(Map<String, Boolean> capabilities) capabilities(Optional<Map<String, Boolean>> capabilities) Feature flags for this schema.Associated client — the Vectros-assigned UUID of a client in your account.description(String description) description(Optional<String> description) Optional description of what this schema is for.Field definitions used to validate record payloads.indexMode(SchemaRequestIndexMode indexMode) indexMode(Optional<SchemaRequestIndexMode> indexMode) Default search-index mode for instances of this type — applies to records of this type and to documents bound to this schema, unless the individual record or document sets its own indexMode.lookupFields(List<LookupDef> lookupFields) lookupFields(Optional<List<LookupDef>> lookupFields) Payload fields to index for direct lookup queries.Owning organization — the Vectros-assigned UUID of an organization in your account.renderHints(Map<String, RenderHintDef> renderHints) renderHints(Optional<Map<String, RenderHintDef>> renderHints) UI rendering hints keyed by field id.storageProfile(SchemaRequestStorageProfile storageProfile) storageProfile(Optional<SchemaRequestStorageProfile> storageProfile) Where this type's payload is stored.Owning user — the Vectros-assigned UUID of a user in your account.
-
Method Details
-
build
SchemaRequest build() -
additionalProperty
-
additionalProperties
-
description
Optional description of what this schema is for.
-
description
-
fields
Field definitions used to validate record payloads. Omit for a bare schema that performs no payload validation.
-
fields
-
lookupFields
Payload fields to index for direct lookup queries. Maximum 10 lookup fields.
-
lookupFields
-
renderHints
UI rendering hints keyed by field id.
-
renderHints
-
capabilities
Feature flags for this schema.
auditHistory(default true) controls whether a change-history (version) trail is kept for this type's data; setting it false stops recording the trail but never affects your record or document data itself.readAccessLog(default false; opt-in) controls accounting-of-disclosures logging: when true, each governed read of this schema's records writes a retained, subject-enumerable access record. The effective value resolves in order: this schema flag, then your context's default, then the platform default (false). -
capabilities
-
indexMode
Default search-index mode for instances of this type — applies to records of this type and to documents bound to this schema, unless the individual record or document sets its own indexMode. HYBRID, SEMANTIC, and TEXT make content searchable; NONE is store-only (the data is persisted, retrievable, and usable for lookups, but not searchable). Omit for no default: a record with no indexMode of its own then defaults to NONE, and a document with no indexMode is rejected.
-
indexMode
-
storageProfile
Where this type's payload is stored. STANDARD (default): payloads of 4 KB or larger are externalized to S3, smaller ones are stored inline. LOW_LATENCY: always store inline for the lowest read latency. LARGE_PAYLOAD: always externalize to S3, which lifts the 400 KB item-size ceiling. For externalized types, list and lookup responses return only the indexed projection unless you pass
includePayload=true. -
storageProfile
-
allowedSurfaces
Which typed surfaces may bind this schema by its id: record, document, user, org, or client. Required and must be non-empty. A schema may list several surfaces (for a shared type usable on both records and documents). This drives surface-scoped schema listing (
GET /v1/schemas?surface=) and is enforced at bind time — for example, a document cannot bind a record-only schema. -
addAllowedSurfaces
-
addAllAllowedSurfaces
SchemaRequest._FinalStage addAllAllowedSurfaces(List<SchemaRequestAllowedSurfacesItem> allowedSurfaces) -
active
Whether this schema is active. An inactive schema rejects creation of new records of its type.
-
active
-
userId
Owning user — the Vectros-assigned UUID of a user in your account. Optional; omit to create an account-wide shared schema. With an API key, this sets the schema's owner explicitly. With a scoped token, the user must match the token's identity claim (if set) or fall within the token's data scope.
-
userId
-
orgId
Owning organization — the Vectros-assigned UUID of an organization in your account. Optional. With an API key, this sets the schema's owning organization explicitly. With a scoped token, it must match the token's identity claim (if set) or fall within the token's data scope.
-
orgId
-
clientId
Associated client — the Vectros-assigned UUID of a client in your account. Optional. With an API key, this sets the schema's client explicitly. With a scoped token, it must match the token's identity claim (if set) or fall within the token's data scope.
-
clientId
-