Execution
class flow_api.execution.Execution
(select=None, cls=None, init=None, by='id', allow_normal=True, allow_deleted=False, commit=False, breakpoints=<class 'flow_api.system.NotSet'>, bundle_id=<class 'flow_api.system.NotSet'>, bundle_name=<class 'flow_api.system.NotSet'>, commit_message=<class 'flow_api.system.NotSet'>, connector_id=<class 'flow_api.system.NotSet'>, connector_name=<class 'flow_api.system.NotSet'>, connector_type=<class 'flow_api.system.NotSet'>, description=<class 'flow_api.system.NotSet'>, flow_id=<class 'flow_api.system.NotSet'>, flow_name=<class 'flow_api.system.NotSet'>, input_schema=<class 'flow_api.system.NotSet'>, input_value=<class 'flow_api.system.NotSet'>, is_paused=<class 'flow_api.system.NotSet'>, is_productive=<class 'flow_api.system.NotSet'>, is_readonly=<class 'flow_api.system.NotSet'>, location_inheritance=<class 'flow_api.system.NotSet'>, max_runtime_minutes=<class 'flow_api.system.NotSet'>, message=<class 'flow_api.system.NotSet'>, name=<class 'flow_api.system.NotSet'>, orphan=<class 'flow_api.system.NotSet'>, output_schema=<class 'flow_api.system.NotSet'>, output_value=<class 'flow_api.system.NotSet'>, plugin_action_id=<class 'flow_api.system.NotSet'>, priority=<class 'flow_api.system.NotSet'>, project_id=<class 'flow_api.system.NotSet'>, project_name=<class 'flow_api.system.NotSet'>, remote_workspace_name=<class 'flow_api.system.NotSet'>, roles=<class 'flow_api.system.NotSet'>, savepoint_retention=<class 'flow_api.system.NotSet'>, schedule_id=<class 'flow_api.system.NotSet'>, schedule_name=<class 'flow_api.system.NotSet'>, scheduled_for=<class 'flow_api.system.NotSet'>, script=<class 'flow_api.system.NotSet'>, track_in_git=<class 'flow_api.system.NotSet'>, type=<class 'flow_api.system.NotSet'>, unwrapped=<class 'flow_api.system.NotSet'>, use_breakpoints=<class 'flow_api.system.NotSet'>, use_only_explicit_breakpoints=<class 'flow_api.system.NotSet'>, webhook_id=<class 'flow_api.system.NotSet'>, wrapper_id=<class 'flow_api.system.NotSet'>, wrapper_name=<class 'flow_api.system.NotSet'>, wrappers=<class 'flow_api.system.NotSet'>, debug=False
)
Base class: Activity
An automation (flow, script, or connection) which is or was running.
See the corresponding Resources class at Execution
Parameters
Name | Type | Description | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
allow_deleted | bool | ||||||||||||||||
allow_normal | bool | ||||||||||||||||
breakpoints | typing.Union[ flow_api.system.NotSet, list ] | The breakpoints of the execution. | |||||||||||||||
bundle_id | typing.Union[ flow_api.system.NotSet, str, NoneType ] | Reference to the bundle this record is associated with. Allowed for BUNDLE_REPOSITORY, CONNECTOR, CUSTOM_OBJECT, DEVOLUTIONS_CONFIG, EXECUTION, FILE, FLOW, LDAP_CONFIG, MESSAGE, OAUTH, OBJECT_TEMPLATE, PLUGIN, ROLE, SCHEDULE, SCHEDULER, SCHEMA, SETTING, SYNC_CONFIG, TAG, VAULT_CONFIG, WEBHOOK, WRAPPER. Not allowed for BUNDLE, ORGANIZATION, PROCESS, PROJECT, USER, WORKSPACE. Mutually exclusive with project_id | |||||||||||||||
bundle_name | typing.Union[ flow_api.system.NotSet, str, NoneType ] | The name of the bundle. Will look up the bundle and set bundle_id. | |||||||||||||||
by | str | ||||||||||||||||
cls | typing.Union[ type, NoneType ] | ||||||||||||||||
commit | bool | ||||||||||||||||
commit_message | typing.Union[ flow_api.system.NotSet, str, NoneType ] | The commit message for this change. | |||||||||||||||
connector_id | typing.Union[ flow_api.system.NotSet, str, NoneType ] | The ID of the connector record the execution is using. | |||||||||||||||
connector_name | typing.Union[ flow_api.system.NotSet, str, NoneType ] | The name of the connector. Only used for type CONNECTION | |||||||||||||||
connector_type | typing.Union[ flow_api.system.NotSet, str, NoneType ] | The type of the connector / the type of the remote system. | |||||||||||||||
debug | bool | if set, the content of the data being written will be logged. | |||||||||||||||
description | typing.Union[ flow_api.system.NotSet, str, NoneType ] | A multiline description of what this record is and does. | |||||||||||||||
flow_id | typing.Union[ flow_api.system.NotSet, str, NoneType ] | The ID of the flow record the execution is processing. | |||||||||||||||
flow_name | typing.Union[ flow_api.system.NotSet, str, NoneType ] | The name of the flow. Only used for type FLOW | |||||||||||||||
init | typing.Union[ dict, NoneType ] | ||||||||||||||||
input_schema | typing.Union[ flow_api.system.NotSet, typing.Any, NoneType ] | The schema of the data the execution accepts in input_value. | |||||||||||||||
input_value | typing.Union[ flow_api.system.NotSet, typing.Any, NoneType ] | The data which was passed to the execution. | |||||||||||||||
is_paused | typing.Union[ flow_api.system.NotSet, bool ] | A flag to control if the execution should be processed. | |||||||||||||||
is_productive | typing.Union[ flow_api.system.NotSet, bool ] | A flag to control if the execution runs in productive mode. | |||||||||||||||
is_readonly | typing.Union[ flow_api.system.NotSet, bool ] | A flag to control if the record can be modified. Allowed for BUNDLE, BUNDLE_REPOSITORY, CONNECTOR, CUSTOM_OBJECT, DEVOLUTIONS_CONFIG, FILE, FLOW, OAUTH, OBJECT_TEMPLATE, PLUGIN, PROJECT, ROLE, SCHEDULE, SCHEDULER, SCHEMA, SETTING, SYNC_CONFIG, TAG, VAULT_CONFIG, WEBHOOK, WRAPPER. Not allowed for EXECUTION, LDAP_CONFIG, MESSAGE, ORGANIZATION, PROCESS, USER, WORKSPACE | |||||||||||||||
location_inheritance | typing.Union[ flow_api.system.NotSet, str, NoneType ] | Controls the project/bundle association of a newly created record when no project_id /project_name /bundle_id /bundle_name is specified in the create request. Depending on the record type different options are available:
| |||||||||||||||
max_runtime_minutes | typing.Union[ flow_api.system.NotSet, int, NoneType ] | The maximum runtime of the execution in minutes. If set to 0, there is no limit. | |||||||||||||||
message | typing.Union[ flow_api.system.NotSet, str, NoneType ] | A status message. | |||||||||||||||
name | typing.Union[ flow_api.system.NotSet, str ] | The name of this record. Must be unique across a workspace. | |||||||||||||||
orphan | typing.Union[ flow_api.system.NotSet, bool, NoneType ] | If set, the child execution will be disconnected from the execution tree | |||||||||||||||
output_schema | typing.Union[ flow_api.system.NotSet, typing.Any, NoneType ] | The schema of the data the execution produces in output_value. | |||||||||||||||
output_value | typing.Union[ flow_api.system.NotSet, typing.Any, NoneType ] | The data returned by the execution | |||||||||||||||
plugin_action_id | typing.Union[ flow_api.system.NotSet, str, NoneType ] | Reference to the plugin_action this execution was started by. | |||||||||||||||
priority | typing.Union[ flow_api.system.NotSet, int ] | The priority of the execution. Higher priority executions will be processed first. Executions with the same priority are processed in the order they were created. | |||||||||||||||
project_id | typing.Union[ flow_api.system.NotSet, str, NoneType ] | Reference to the project this record is associated with. Allowed for CONNECTOR, CUSTOM_OBJECT, DEVOLUTIONS_CONFIG, EXECUTION, FILE, FLOW, MESSAGE, OAUTH, OBJECT_TEMPLATE, PLUGIN, SCHEDULE, SCHEDULER, SCHEMA, SETTING, SYNC_CONFIG, TAG, VAULT_CONFIG, WEBHOOK, WRAPPER. Not allowed for BUNDLE, BUNDLE_REPOSITORY, LDAP_CONFIG, ORGANIZATION, PROCESS, PROJECT, ROLE, USER, WORKSPACE. Mutually exclusive with bundle_id. | |||||||||||||||
project_name | typing.Union[ flow_api.system.NotSet, str, NoneType ] | The name of the project. Will look up the project and set project_id. | |||||||||||||||
remote_workspace_name | typing.Union[ flow_api.system.NotSet, str, NoneType ] | The name of the workspace where this execution is remotely running | |||||||||||||||
roles | typing.Union[ flow_api.system.NotSet, list, NoneType ] | The roles this identity has. | |||||||||||||||
savepoint_retention | typing.Union[ flow_api.system.NotSet, str, NoneType ] | Controls which savepoints are retained during execution (e.g. LAST, ALL) | |||||||||||||||
schedule_id | typing.Union[ flow_api.system.NotSet, str, NoneType ] | The associated schedule for this execution | |||||||||||||||
schedule_name | typing.Union[ flow_api.system.NotSet, str, NoneType ] | The name of the schedule. Only used for type SCHEDULE | |||||||||||||||
scheduled_for | typing.Union[ flow_api.system.NotSet, datetime.datetime, NoneType ] | The timestamp when the execution will continue. This field is also used for timeouts. | |||||||||||||||
script | typing.Union[ flow_api.system.NotSet, str, NoneType ] | The script the execution is processing. | |||||||||||||||
select | typing.Union[ str, NoneType ] | ||||||||||||||||
track_in_git | typing.Union[ flow_api.system.NotSet, bool, NoneType ] | Should new records automatically be tracked in git. | |||||||||||||||
type | typing.Union[ flow_api.system.NotSet, str ] | The type of the execution. | |||||||||||||||
unwrapped | typing.Union[ flow_api.system.NotSet, bool, NoneType ] | If set, static wrappers which are registered on the flow are not used. Dynamically added wrappers and wrappers which are explicitly added using the wrappers field are still used. | |||||||||||||||
use_breakpoints | typing.Union[ flow_api.system.NotSet, bool ] | A flag to control if the execution will stop at breakpoints. | |||||||||||||||
use_only_explicit_breakpoints | typing.Union[ flow_api.system.NotSet, bool ] | Should only explicitly defined breakpoints be used, this disables the step-through feature. | |||||||||||||||
webhook_id | typing.Union[ flow_api.system.NotSet, str, NoneType ] | The associated webhook for this execution | |||||||||||||||
wrapper_id | typing.Union[ flow_api.system.NotSet, str, NoneType ] | The ID of the wrapper record the execution is processing. | |||||||||||||||
wrapper_name | typing.Union[ flow_api.system.NotSet, str, NoneType ] | The name of the wrapper. Only used for type WRAPPER | |||||||||||||||
wrappers | typing.Union[ flow_api.system.NotSet, typing.Any, NoneType ] | A list of dynamic wrappers to apply around the execution. Provide a list of objects in the form [{"wrapper_id": ..., "params": {...}}] . |