Skip to content

FieldDefinition

Source code in docs_src/capo_glue/types/field_definition.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
class FieldDefinition(TypedDict, closed=True):
    name: "str"
    """<p>The name of the field in the entity schema.</p>"""
    field_data_type: "capo_glue.types.field_data_type.FieldDataType"
    """<p>The data type of the field.</p>"""
    response_date_format: NotRequired["str"]
    """<p>The format pattern for parsing date values from API responses. Required when the API uses a non-ISO-8601 format. Accepts Java <code>DateTimeFormatter</code> patterns (for example, <code>EEE, d MMM yyyy HH:mm:ss Z</code>), <code>EPOCH_SECONDS</code> for Unix epoch seconds, or <code>EPOCH_MILLIS</code> for Unix epoch milliseconds.</p>"""
    is_partitionable: NotRequired["capo_glue.types.bool.Bool"]
    """<p>Indicates whether this field can be used for partitioning queries to the data source.</p>"""
    is_nullable: NotRequired["capo_glue.types.bool.Bool"]
    """<p>Indicates whether this field can contain null values.</p>"""
    is_queryable: NotRequired["capo_glue.types.bool.Bool"]
    """<p>Indicates whether this field can be used in filter predicates when querying data.</p>"""
    is_orderable: NotRequired["capo_glue.types.bool.Bool"]
    """<p>Indicates whether this field can be used for ordering results.</p>"""
    filter_overrides: NotRequired["capo_glue.types.filter_overrides.FilterOverrides"]
    """<p>Per-field overrides for filter behavior, allowing customization of how filters are applied to this specific field.</p>"""

field_data_type instance-attribute 

field_data_type: FieldDataType

The data type of the field.

filter_overrides instance-attribute 

filter_overrides: NotRequired[FilterOverrides]

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

is_nullable instance-attribute 

is_nullable: NotRequired[Bool]

Indicates whether this field can contain null values.

is_orderable instance-attribute 

is_orderable: NotRequired[Bool]

Indicates whether this field can be used for ordering results.

is_partitionable instance-attribute 

is_partitionable: NotRequired[Bool]

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

is_queryable instance-attribute 

is_queryable: NotRequired[Bool]

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

name instance-attribute 

name: str

The name of the field in the entity schema.

response_date_format instance-attribute 

response_date_format: NotRequired[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.