Skip to content

FieldTypeDetails

Source code in docs_src/capo_appflow/types/field_type_details.py
class FieldTypeDetails(TypedDict, closed=True):
    field_type: "capo_appflow.types.field_type.FieldType"
    """<p> The type of field, such as string, integer, date, and so on. </p>"""
    filter_operators: "capo_appflow.types.filter_operator_list.FilterOperatorList"
    """<p> The list of operators supported by a field. </p>"""
    supported_values: NotRequired[
        "capo_appflow.types.supported_value_list.SupportedValueList"
    ]
    """<p> The list of values that a field can contain. For example, a Boolean <code>fieldType</code> can have two values: "true" and "false". </p>"""
    value_regex_pattern: NotRequired["capo_appflow.types.string.String"]
    """<p>The regular expression pattern for the field name.</p>"""
    supported_date_format: NotRequired["capo_appflow.types.string.String"]
    """<p>The date format that the field supports.</p>"""
    field_value_range: NotRequired["capo_appflow.types.range.Range"]
    """<p>The range of values this field can hold.</p>"""
    field_length_range: NotRequired["capo_appflow.types.range.Range"]
    """<p>This is the allowable length range for this field's value.</p>"""

field_length_range instance-attribute

field_length_range: NotRequired[Range]

This is the allowable length range for this field's value.

field_type instance-attribute

field_type: FieldType

The type of field, such as string, integer, date, and so on.

field_value_range instance-attribute

field_value_range: NotRequired[Range]

The range of values this field can hold.

filter_operators instance-attribute

filter_operators: FilterOperatorList

The list of operators supported by a field.

supported_date_format instance-attribute

supported_date_format: NotRequired[String]

The date format that the field supports.

supported_values instance-attribute

supported_values: NotRequired[SupportedValueList]

The list of values that a field can contain. For example, a Boolean fieldType can have two values: "true" and "false".

value_regex_pattern instance-attribute

value_regex_pattern: NotRequired[String]

The regular expression pattern for the field name.