FieldDefinition

Defines a field in an entity schema for REST connector data sources, specifying the field name and data type.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

The data type of the field.

Link copied to clipboard

Per-field overrides for filter behavior, allowing customization of how filters are applied to this specific field.

Link copied to clipboard

Indicates whether this field can contain null values.

Link copied to clipboard

Indicates whether this field can be used for ordering results.

Link copied to clipboard

Indicates whether this field can be used for partitioning queries to the data source.

Link copied to clipboard

Indicates whether this field can be used in filter predicates when querying data.

Link copied to clipboard

The name of the field in the entity schema.

Link copied to clipboard

The format pattern for parsing date values from API responses. Required when the API uses a non-ISO-8601 format. Accepts Java DateTimeFormatter patterns (for example, EEE, d MMM yyyy HH:mm:ss Z), EPOCH_SECONDS for Unix epoch seconds, or EPOCH_MILLIS for Unix epoch milliseconds.

Functions

Link copied to clipboard
inline fun copy(block: FieldDefinition.Builder.() -> Unit = {}): FieldDefinition
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String