Struct FieldDefinition 

#[non_exhaustive]
pub struct FieldDefinition {
    pub name: String,
    pub field_data_type: FieldDataType,
    pub response_date_format: Option<String>,
    pub is_partitionable: Option<bool>,
    pub is_nullable: Option<bool>,
    pub is_queryable: Option<bool>,
    pub is_orderable: Option<bool>,
    pub filter_overrides: Option<FilterOverrides>,
}

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

The name of the field in the entity schema.

field_data_type: FieldDataType

The data type of the field.

response_date_format: Option<String>

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.

is_partitionable: Option<bool>

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

is_nullable: Option<bool>

Indicates whether this field can contain null values.

is_queryable: Option<bool>

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

is_orderable: Option<bool>

Indicates whether this field can be used for ordering results.

filter_overrides: Option<FilterOverrides>

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

Implementations

impl FieldDefinition

pub fn name(&self) -> &str

The name of the field in the entity schema.

pub fn field_data_type(&self) -> &FieldDataType

The data type of the field.

pub fn response_date_format(&self) -> Option<&str>

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.

pub fn is_partitionable(&self) -> Option<bool>

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

pub fn is_nullable(&self) -> Option<bool>

Indicates whether this field can contain null values.

pub fn is_queryable(&self) -> Option<bool>

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

pub fn is_orderable(&self) -> Option<bool>

Indicates whether this field can be used for ordering results.

pub fn filter_overrides(&self) -> Option<&FilterOverrides>

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

impl FieldDefinition

pub fn builder() -> FieldDefinitionBuilder

Creates a new builder-style object to manufacture FieldDefinition.

Trait Implementations

impl Clone for FieldDefinition

fn clone(&self) -> FieldDefinition

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FieldDefinition

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for FieldDefinition

fn eq(&self, other: &FieldDefinition) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for FieldDefinition