Skip to main content
Version: 12 - TBD

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
breakpointsUnion
bundle_idUnion
bundle_nameUnion
bystr
clsOptional
commitbool
commit_messageUnion
debugbool
descriptionUnion
initOptional
input_schemaUnion
is_bundle_contentUnion
is_readonlyUnion
location_inheritanceUnion
max_runtime_minutesUnion
nameUnion
output_schemaUnion
priorityUnion
project_idUnion
project_nameUnion
savepoint_retentionUnion
scriptUnion
selectOptional
track_in_gitUnion

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​

pending_delete_identity_id_identity​

pending_restore_identity_id_identity​

pending_trash_identity_id_identity​

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​