Package ai.vectros.types

Interface FieldDef._FinalStage

All Known Implementing Classes:

FieldDef.Builder

Enclosing class:

FieldDef

public static interface FieldDef._FinalStage

Method Summary

Modifier and Type	Method	Description
FieldDef._FinalStage	additionalProperties(Map<String,Object> additionalProperties)
FieldDef._FinalStage	additionalProperty(String key, Object value)
FieldDef	build()
FieldDef._FinalStage	cardinality(String cardinality)
FieldDef._FinalStage	cardinality(Optional<String> cardinality)	For a reference field: one (a single id, the default) or many (an array of ids).
FieldDef._FinalStage	description(String description)
FieldDef._FinalStage	description(Optional<String> description)	Human-readable description of the field.
FieldDef._FinalStage	enumValues(List<Map<String,Object>> enumValues)
FieldDef._FinalStage	enumValues(Optional<List<Map<String,Object>>> enumValues)	The set of allowed values, for an enum-type field.
FieldDef._FinalStage	filterable(Boolean filterable)
FieldDef._FinalStage	filterable(Optional<Boolean> filterable)	Whether this field can be used as a filter in queries.
FieldDef._FinalStage	required(Boolean required)
FieldDef._FinalStage	required(Optional<Boolean> required)	Whether this field is required when a record is created.
FieldDef._FinalStage	searchable(Boolean searchable)
FieldDef._FinalStage	searchable(Optional<Boolean> searchable)	Whether this field's value contributes to full-text search.
FieldDef._FinalStage	sensitive(Boolean sensitive)
FieldDef._FinalStage	sensitive(Optional<Boolean> sensitive)	Marks the field as sensitive (PHI/PII).
FieldDef._FinalStage	targetField(String targetField)
FieldDef._FinalStage	targetField(Optional<String> targetField)	For a reference field: the target's lookup field to resolve against.
FieldDef._FinalStage	targetSurface(String targetSurface)
FieldDef._FinalStage	targetSurface(Optional<String> targetSurface)	For a reference field: where the target lives — record, document, user, or the name of an identity namespace (org, client, or one you registered, such as team).
FieldDef._FinalStage	targetTypeName(String targetTypeName)
FieldDef._FinalStage	targetTypeName(Optional<String> targetTypeName)	For a reference field: the target type this field points at.
FieldDef._FinalStage	validation(Map<String,Object> validation)
FieldDef._FinalStage	validation(Optional<Map<String,Object>> validation)	Validation rules for this field's value (such as minimum/maximum length or a regex pattern).

Method Details

build

FieldDef build()

additionalProperty

FieldDef._FinalStage additionalProperty(String key,
 Object value)

additionalProperties

FieldDef._FinalStage additionalProperties(Map<String,Object> additionalProperties)

required

FieldDef._FinalStage required(Optional<Boolean> required)

Whether this field is required when a record is created.

required

FieldDef._FinalStage required(Boolean required)

searchable

FieldDef._FinalStage searchable(Optional<Boolean> searchable)

Whether this field's value contributes to full-text search.

searchable

FieldDef._FinalStage searchable(Boolean searchable)

filterable

FieldDef._FinalStage filterable(Optional<Boolean> filterable)

Whether this field can be used as a filter in queries.

filterable

FieldDef._FinalStage filterable(Boolean filterable)

description

FieldDef._FinalStage description(Optional<String> description)

Human-readable description of the field.

description

FieldDef._FinalStage description(String description)

validation

FieldDef._FinalStage validation(Optional<Map<String,Object>> validation)

Validation rules for this field's value (such as minimum/maximum length or a regex pattern).

validation

FieldDef._FinalStage validation(Map<String,Object> validation)

enumValues

FieldDef._FinalStage enumValues(Optional<List<Map<String,Object>>> enumValues)

The set of allowed values, for an enum-type field.

enumValues

FieldDef._FinalStage enumValues(List<Map<String,Object>> enumValues)

targetTypeName

FieldDef._FinalStage targetTypeName(Optional<String> targetTypeName)

For a reference field: the target type this field points at. Required for reference fields.

targetTypeName

FieldDef._FinalStage targetTypeName(String targetTypeName)

targetField

FieldDef._FinalStage targetField(Optional<String> targetField)

For a reference field: the target's lookup field to resolve against. Defaults to externalId, and must name a unique lookup on the target type.

targetField

FieldDef._FinalStage targetField(String targetField)

cardinality

FieldDef._FinalStage cardinality(Optional<String> cardinality)

For a reference field: one (a single id, the default) or many (an array of ids).

cardinality

FieldDef._FinalStage cardinality(String cardinality)

targetSurface

FieldDef._FinalStage targetSurface(Optional<String> targetSurface)

For a reference field: where the target lives — record, document, user, or the name of an identity namespace (org, client, or one you registered, such as team). Required for reference fields. The same type name can exist in more than one place, so this disambiguates which lookup resolves the reference. A namespace must already be registered and entity-backed, otherwise the schema is rejected — a reference that could never resolve fails when you define it, not on every write.

targetSurface

FieldDef._FinalStage targetSurface(String targetSurface)

sensitive

FieldDef._FinalStage sensitive(Optional<Boolean> sensitive)

Marks the field as sensitive (PHI/PII). Sensitive fields are redacted in logs, audit trails, and errors; blind-indexed for lookups; excluded from search; and masked in responses unless the token carries the s reveal scope for this record type.

sensitive

FieldDef._FinalStage sensitive(Boolean sensitive)