Field ¶

class Field(TypedDict, closed=True):
    field_name: NotRequired["capo_glue.types.entity_field_name.EntityFieldName"]
    """<p>A unique identifier for the field.</p>"""
    label: NotRequired["capo_glue.types.field_label.FieldLabel"]
    """<p>A readable label used for the field.</p>"""
    description: NotRequired["capo_glue.types.field_description.FieldDescription"]
    """<p>A description of the field.</p>"""
    field_type: NotRequired["capo_glue.types.field_data_type.FieldDataType"]
    """<p>The type of data in the field.</p>"""
    is_primary_key: NotRequired["capo_glue.types.bool.Bool"]
    """<p>Indicates whether this field can used as a primary key for the given entity.</p>"""
    is_nullable: NotRequired["capo_glue.types.bool.Bool"]
    """<p>Indicates whether this field can be nullable or not.</p>"""
    is_retrievable: NotRequired["capo_glue.types.bool.Bool"]
    """<p>Indicates whether this field can be added in Select clause of SQL query or whether it is retrievable or not.</p>"""
    is_filterable: NotRequired["capo_glue.types.bool.Bool"]
    """<p> Indicates whether this field can used in a filter clause (<code>WHERE</code> clause) of a SQL statement when querying data. </p>"""
    is_partitionable: NotRequired["capo_glue.types.bool.Bool"]
    """<p>Indicates whether a given field can be used in partitioning the query made to SaaS.</p>"""
    is_createable: NotRequired["capo_glue.types.bool.Bool"]
    """<p>Indicates whether this field can be created as part of a destination write.</p>"""
    is_updateable: NotRequired["capo_glue.types.bool.Bool"]
    """<p>Indicates whether this field can be updated as part of a destination write.</p>"""
    is_upsertable: NotRequired["capo_glue.types.bool.Bool"]
    """<p>Indicates whether this field can be upserted as part of a destination write.</p>"""
    is_default_on_create: NotRequired["capo_glue.types.bool.Bool"]
    """<p>Indicates whether this field is populated automatically when the object is created, such as a created at timestamp.</p>"""
    supported_values: NotRequired["capo_glue.types.list_of_string.ListOfString"]
    """<p>A list of supported values for the field.</p>"""
    supported_filter_operators: NotRequired[
        "capo_glue.types.field_filter_operators_list.FieldFilterOperatorsList"
    ]
    """<p>Indicates the support filter operators for this field.</p>"""
    parent_field: NotRequired["str"]
    """<p>A parent field name for a nested field.</p>"""
    native_data_type: NotRequired["str"]
    """<p>The data type returned by the SaaS API, such as “picklist” or “textarea” from Salesforce.</p>"""
    custom_properties: NotRequired["capo_glue.types.custom_properties.CustomProperties"]
    """<p>Optional map of keys which may be returned.</p>"""