Package ai.vectros.types

Class FieldDef.Builder

java.lang.Object

ai.vectros.types.FieldDef.Builder

All Implemented Interfaces:

FieldDef._FinalStage, FieldDef.FieldIdStage, FieldDef.FieldTypeStage

Enclosing class:

FieldDef

public static final class FieldDef.Builder
extends Object
implements FieldDef.FieldIdStage, FieldDef.FieldTypeStage, FieldDef._FinalStage

Method Summary

Modifier and Type	Method	Description
FieldDef.Builder	additionalProperties(Map<String,Object> additionalProperties)
FieldDef.Builder	additionalProperty(String key, Object value)
FieldDef	build()
FieldDef._FinalStage	cardinality(String cardinality)	For a reference field: one (a single id, the default) or many (an array of ids).
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)	Human-readable description of the field.
FieldDef._FinalStage	description(Optional<String> description)	Human-readable description of the field.
FieldDef._FinalStage	enumValues(List<Map<String,Object>> enumValues)	The set of allowed values, for an enum-type field.
FieldDef._FinalStage	enumValues(Optional<List<Map<String,Object>>> enumValues)	The set of allowed values, for an enum-type field.
FieldDef.FieldTypeStage	fieldId(@NotNull String fieldId)	Unique identifier for this field within the schema.
FieldDef._FinalStage	fieldType(@NotNull FieldDefFieldType fieldType)	Data type of the field.
FieldDef._FinalStage	filterable(Boolean filterable)	Whether this field can be used as a filter in queries.
FieldDef._FinalStage	filterable(Optional<Boolean> filterable)	Whether this field can be used as a filter in queries.
FieldDef.Builder	from(FieldDef other)
FieldDef._FinalStage	required(Boolean required)	Whether this field is required when a record is created.
FieldDef._FinalStage	required(Optional<Boolean> required)	Whether this field is required when a record is created.
FieldDef._FinalStage	searchable(Boolean searchable)	Whether this field's value contributes to full-text search.
FieldDef._FinalStage	searchable(Optional<Boolean> searchable)	Whether this field's value contributes to full-text search.
FieldDef._FinalStage	sensitive(Boolean sensitive)	Marks the field as sensitive (PHI/PII).
FieldDef._FinalStage	sensitive(Optional<Boolean> sensitive)	Marks the field as sensitive (PHI/PII).
FieldDef._FinalStage	targetField(String targetField)	For a reference field: the target's lookup field to resolve against.
FieldDef._FinalStage	targetField(Optional<String> targetField)	For a reference field: the target's lookup field to resolve against.
FieldDef._FinalStage	targetSurface(FieldDefTargetSurface targetSurface)	For a reference field: which surface the target lives on — record, document, user, org, or client.
FieldDef._FinalStage	targetSurface(Optional<FieldDefTargetSurface> targetSurface)	For a reference field: which surface the target lives on — record, document, user, org, or client.
FieldDef._FinalStage	targetTypeName(String targetTypeName)	For a reference field: the target type this field points at.
FieldDef._FinalStage	targetTypeName(Optional<String> targetTypeName)	For a reference field: the target type this field points at.
FieldDef._FinalStage	validation(Map<String,Object> validation)	Validation rules for this field's value (such as minimum/maximum length or a regex pattern).
FieldDef._FinalStage	validation(Optional<Map<String,Object>> validation)	Validation rules for this field's value (such as minimum/maximum length or a regex pattern).

Methods inherited from class java.lang.Object

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

Method Details

from

public FieldDef.Builder from(FieldDef other)

Specified by:

from in interface FieldDef.FieldIdStage

fieldId

public FieldDef.FieldTypeStage fieldId(@NotNull
 @NotNull String fieldId)

Unique identifier for this field within the schema.

Unique identifier for this field within the schema.

Specified by:

fieldId in interface FieldDef.FieldIdStage

Returns:

Reference to this so that method calls can be chained together.

fieldType

public FieldDef._FinalStage fieldType(@NotNull
 @NotNull FieldDefFieldType fieldType)

Data type of the field. Use reference for a foreign-key field that points at another type — then set targetTypeName, targetField, targetSurface, and cardinality below.

Data type of the field. Use reference for a foreign-key field that points at another type — then set targetTypeName, targetField, targetSurface, and cardinality below.

Specified by:

fieldType in interface FieldDef.FieldTypeStage

Returns:

Reference to this so that method calls can be chained together.

sensitive

public FieldDef._FinalStage sensitive(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.

Specified by:

sensitive in interface FieldDef._FinalStage

Returns:

Reference to this so that method calls can be chained together.

sensitive

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

Specified by:

sensitive in interface FieldDef._FinalStage

targetSurface

public FieldDef._FinalStage targetSurface(FieldDefTargetSurface targetSurface)

For a reference field: which surface the target lives on — record, document, user, org, or client. Required for reference fields. The same type name can exist on more than one surface, so this disambiguates which lookup resolves the reference.

Specified by:

targetSurface in interface FieldDef._FinalStage

Returns:

Reference to this so that method calls can be chained together.

targetSurface

public FieldDef._FinalStage targetSurface(Optional<FieldDefTargetSurface> targetSurface)

For a reference field: which surface the target lives on — record, document, user, org, or client. Required for reference fields. The same type name can exist on more than one surface, so this disambiguates which lookup resolves the reference.

Specified by:

targetSurface in interface FieldDef._FinalStage

cardinality

public FieldDef._FinalStage cardinality(String cardinality)

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

Specified by:

cardinality in interface FieldDef._FinalStage

Returns:

Reference to this so that method calls can be chained together.

cardinality

public FieldDef._FinalStage cardinality(Optional<String> cardinality)

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

Specified by:

cardinality in interface FieldDef._FinalStage

targetField

public FieldDef._FinalStage targetField(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.

Specified by:

targetField in interface FieldDef._FinalStage

Returns:

Reference to this so that method calls can be chained together.

targetField

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

Specified by:

targetField in interface FieldDef._FinalStage

targetTypeName

public FieldDef._FinalStage targetTypeName(String targetTypeName)

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

Specified by:

targetTypeName in interface FieldDef._FinalStage

Returns:

Reference to this so that method calls can be chained together.

targetTypeName

public FieldDef._FinalStage targetTypeName(Optional<String> targetTypeName)

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

Specified by:

targetTypeName in interface FieldDef._FinalStage

enumValues

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

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

Specified by:

enumValues in interface FieldDef._FinalStage

Returns:

Reference to this so that method calls can be chained together.

enumValues

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

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

Specified by:

enumValues in interface FieldDef._FinalStage

validation

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

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

Specified by:

validation in interface FieldDef._FinalStage

Returns:

Reference to this so that method calls can be chained together.

validation

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

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

Specified by:

validation in interface FieldDef._FinalStage

description

public FieldDef._FinalStage description(String description)

Human-readable description of the field.

Specified by:

description in interface FieldDef._FinalStage

Returns:

Reference to this so that method calls can be chained together.

description

public FieldDef._FinalStage description(Optional<String> description)

Human-readable description of the field.

Specified by:

description in interface FieldDef._FinalStage

filterable

public FieldDef._FinalStage filterable(Boolean filterable)

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

Specified by:

filterable in interface FieldDef._FinalStage

Returns:

Reference to this so that method calls can be chained together.

filterable

public FieldDef._FinalStage filterable(Optional<Boolean> filterable)

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

Specified by:

filterable in interface FieldDef._FinalStage

searchable

public FieldDef._FinalStage searchable(Boolean searchable)

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

Specified by:

searchable in interface FieldDef._FinalStage

Returns:

Reference to this so that method calls can be chained together.

searchable

public FieldDef._FinalStage searchable(Optional<Boolean> searchable)

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

Specified by:

searchable in interface FieldDef._FinalStage

required

public FieldDef._FinalStage required(Boolean required)

Whether this field is required when a record is created.

Specified by:

required in interface FieldDef._FinalStage

Returns:

Reference to this so that method calls can be chained together.

required

public FieldDef._FinalStage required(Optional<Boolean> required)

Whether this field is required when a record is created.

Specified by:

required in interface FieldDef._FinalStage

build

public FieldDef build()

Specified by:

build in interface FieldDef._FinalStage

additionalProperty

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

Specified by:

additionalProperty in interface FieldDef._FinalStage

additionalProperties

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

Specified by:

additionalProperties in interface FieldDef._FinalStage