ConnectorEntityField ¶

class ConnectorEntityField(TypedDict, closed=True):
    identifier: "capo_appflow.types.identifier.Identifier"
    """<p> The unique identifier of the connector field. </p>"""
    parent_identifier: NotRequired["capo_appflow.types.identifier.Identifier"]
    """<p>The parent identifier of the connector field.</p>"""
    label: NotRequired["capo_appflow.types.label.Label"]
    """<p> The label applied to a connector entity field. </p>"""
    is_primary_key: "capo_appflow.types.boolean.Boolean"
    """<p>Booelan value that indicates whether this field can be used as a primary key.</p>"""
    default_value: NotRequired["capo_appflow.types.string.String"]
    """<p>Default value that can be assigned to this field.</p>"""
    is_deprecated: "capo_appflow.types.boolean.Boolean"
    """<p>Booelan value that indicates whether this field is deprecated or not.</p>"""
    supported_field_type_details: NotRequired[
        "capo_appflow.types.supported_field_type_details.SupportedFieldTypeDetails"
    ]
    """<p> Contains details regarding the supported <code>FieldType</code>, including the corresponding <code>filterOperators</code> and <code>supportedValues</code>. </p>"""
    description: NotRequired["capo_appflow.types.description.Description"]
    """<p> A description of the connector entity field. </p>"""
    source_properties: NotRequired[
        "capo_appflow.types.source_field_properties.SourceFieldProperties"
    ]
    """<p> The properties that can be applied to a field when the connector is being used as a source. </p>"""
    destination_properties: NotRequired[
        "capo_appflow.types.destination_field_properties.DestinationFieldProperties"
    ]
    """<p> The properties applied to a field when the connector is being used as a destination. </p>"""
    custom_properties: NotRequired[
        "capo_appflow.types.custom_properties.CustomProperties"
    ]
    """<p>A map that has specific properties related to the ConnectorEntityField.</p>"""