Skip to main content
Version: 11 - Zimtschnecke

Flow

class flow_api.flow.Flow(select=None, cls=None, init=None, by='name', 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'>, description=<class 'flow_api.system.NotSet'>, input_schema=<class 'flow_api.system.NotSet'>, is_bundle_content=<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'>, name=<class 'flow_api.system.NotSet'>, output_schema=<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'>, savepoint_retention=<class 'flow_api.system.NotSet'>, script=<class 'flow_api.system.NotSet'>, track_in_git=<class 'flow_api.system.NotSet'>, debug=False)

Base class: Resource

A script which contains automation logic.

See the corresponding Resources class at Flow

Parameters​

NameTypeDescription
allow_deletedbool
allow_normalbool
breakpointstyping.Union[ flow_api.system.NotSet, list ]The breakpoints of the flow.
bundle_idtyping.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_nametyping.Union[ flow_api.system.NotSet, str, NoneType ]The name of the bundle. Will look up the bundle and set bundle_id.
bystr
clstyping.Union[ type, NoneType ]
commitbool
commit_messagetyping.Union[ flow_api.system.NotSet, str, NoneType ]The commit message for this change.
debugboolif set, the content of the data being written will be logged.
descriptiontyping.Union[ flow_api.system.NotSet, str, NoneType ]A multiline description of what this record is and does.
inittyping.Union[ dict, NoneType ]
input_schematyping.Union[ flow_api.system.NotSet, typing.Any, NoneType ]The schema of the data an execution of the flow accepts in input_value.
is_bundle_contenttyping.Union[ flow_api.system.NotSet, bool ]A flag to control if the resource is considered bundle content. Changes in bundle content mark the bundle as modified. Updating the bundle will modify the bundle content.
is_readonlytyping.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_inheritancetyping.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:
location_inheritance record types description
created_by all use the same location as the identity which creates the record
default all use the "Default project" where applicable or "Workspace" for record types which cannot be in a project
wrapped_resource execution use the same location as the innermost resource which is wrapped
resource execution use the same location as the resource on which the execution is based on
Notes:
  • If a project_id/project_name/bundle_id/bundle_name is specified in the request, it always takes precedence.
  • The options wrapped_resource and resource only work with executions which are based on a resource, not with ad-hoc connections or executions of type "SCRIPT". If used with ad-hoc connections or "SCRIPT" it will fall back to default.
  • If the record being created cannot be associated with the specified location, the fallback to default will be used.
  • If location_inheritance is unset, the default value used depends on the type of identity which creates the record as well as the type of record which is created. If an execution is created by any identity which is not an execution, it defaults to wrapped_resource. In all other cases it defaults to created_by.
max_runtime_minutestyping.Union[ flow_api.system.NotSet, int, NoneType ]The maximum runtime of executions of this flow in minutes. If set to 0, there is no limit. If set to null, the EXECUTION_MAX_RUNTIME_MINUTES workspace configuration will be used when creating an execution of this flow.
nametyping.Union[ flow_api.system.NotSet, str ]The name of this record. Must be unique across a workspace.
output_schematyping.Union[ flow_api.system.NotSet, typing.Any, NoneType ]The schema of the data an execution of the flow produces in output_value.
prioritytyping.Union[ flow_api.system.NotSet, int, NoneType ]The execution priority of the flow. Will be inherited to executions of this flow. If unset the EXECUTION_DEFAULT_PRIORITY workspace configuration will be used. Higher priority executions will be processed first.
project_idtyping.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_nametyping.Union[ flow_api.system.NotSet, str, NoneType ]The name of the project. Will look up the project and set project_id.
savepoint_retentiontyping.Union[ flow_api.system.NotSet, str, NoneType ]Controls which savepoints are retained during execution (e.g. LAST, ALL)
scripttyping.Union[ flow_api.system.NotSet, str ]The automation logic script.
selecttyping.Union[ str, NoneType ]
track_in_gittyping.Union[ flow_api.system.NotSet, bool, NoneType ]Should new records automatically be tracked in git.

Constants​

RESOURCE = flow

Methods​

add_bundle_setup_flow_id​

add_execution_flow_id​

add_object_template_before_create​

add_object_template_on_create​

add_object_template_on_delete​

add_object_template_on_update​

add_plugin_action​

add_record_metadata​

add_record_tag​

add_record_user​

add_resource_wrapper​

add_schedule​

add_webhook​

bundle​

bundle_list_setup_flow_id​

clone​

commit​

created_by_identity​

delete​

deleted_by_identity​

execute​

execution_list​

exists​

export​

get​

get_dict​

git_log_list​

git_restore​

metadata​

migrate_deprecations​

modified_by_identity​

object_template_list_before_create​

object_template_list_on_create​

object_template_list_on_delete​

object_template_list_on_update​

organization​

plugin_action_list​

project​

record_log_list​

record_metadata_list​

record_tag_list​

record_user_list​

resource_wrapper_list​

restore​

run​

save​

schedule_list​

using​

webhook_list​

workspace​