Skip to content

DestinationFieldProperties

Source code in docs_src/capo_appflow/types/destination_field_properties.py
class DestinationFieldProperties(TypedDict, closed=True):
    is_creatable: "capo_appflow.types.boolean.Boolean"
    """<p> Specifies if the destination field can be created by the current user. </p>"""
    is_nullable: "capo_appflow.types.boolean.Boolean"
    """<p> Specifies if the destination field can have a null value. </p>"""
    is_upsertable: "capo_appflow.types.boolean.Boolean"
    """<p> Specifies if the flow run can either insert new rows in the destination field if they do not already exist, or update them if they do. </p>"""
    is_updatable: "capo_appflow.types.boolean.Boolean"
    """<p> Specifies whether the field can be updated during an <code>UPDATE</code> or <code>UPSERT</code> write operation. </p>"""
    is_defaulted_on_create: "capo_appflow.types.boolean.Boolean"
    """<p>Specifies whether the field can use the default value during a Create operation.</p>"""
    supported_write_operations: NotRequired[
        "capo_appflow.types.supported_write_operation_list.SupportedWriteOperationList"
    ]
    """<p> A list of supported write operations. For each write operation listed, this field can be used in <code>idFieldNames</code> when that write operation is present as a destination option. </p>"""

is_creatable instance-attribute

is_creatable: Boolean

Specifies if the destination field can be created by the current user.

is_defaulted_on_create instance-attribute

is_defaulted_on_create: Boolean

Specifies whether the field can use the default value during a Create operation.

is_nullable instance-attribute

is_nullable: Boolean

Specifies if the destination field can have a null value.

is_updatable instance-attribute

is_updatable: Boolean

Specifies whether the field can be updated during an UPDATE or UPSERT write operation.

is_upsertable instance-attribute

is_upsertable: Boolean

Specifies if the flow run can either insert new rows in the destination field if they do not already exist, or update them if they do.

supported_write_operations instance-attribute

supported_write_operations: NotRequired[SupportedWriteOperationList]

A list of supported write operations. For each write operation listed, this field can be used in idFieldNames when that write operation is present as a destination option.