Skip to main content
Version: 11 - TBD

Schedule

class flow_api.schedule.Schedule(select=None, cls=None, init=None, by='name', allow_normal=True, allow_deleted=False, commit=False, bundle_id=<class 'flow_api.system.NotSet'>, bundle_name=<class 'flow_api.system.NotSet'>, commit_message=<class 'flow_api.system.NotSet'>, configuration=<class 'flow_api.system.NotSet'>, description=<class 'flow_api.system.NotSet'>, flow_id=<class 'flow_api.system.NotSet'>, is_enabled=<class 'flow_api.system.NotSet'>, is_readonly=<class 'flow_api.system.NotSet'>, location_inheritance=<class 'flow_api.system.NotSet'>, name=<class 'flow_api.system.NotSet'>, next_runs=<class 'flow_api.system.NotSet'>, project_id=<class 'flow_api.system.NotSet'>, project_name=<class 'flow_api.system.NotSet'>, roles=<class 'flow_api.system.NotSet'>, scheduler_id=<class 'flow_api.system.NotSet'>, debug=False)

Base class: Resource

A schedule for an automated execution of flows.

A Schedule object links a flow (to be scheduled) with a scheduler-logic and respective settings for the schedule.

See the corresponding Resources class at Schedule

Parameters

NameTypeDescription
allow_deletedbool
allow_normalbool
bundle_idtyping.Union[ flow_api.system.NotSet, str, NoneType ]
bundle_nametyping.Union[ flow_api.system.NotSet, str, NoneType ]
bystr
clstyping.Union[ type, NoneType ]
commitbool
commit_messagetyping.Union[ flow_api.system.NotSet, str, NoneType ]
configurationtyping.Union[ flow_api.system.NotSet, typing.Any ]
debugbool
descriptiontyping.Union[ flow_api.system.NotSet, str, NoneType ]
flow_idtyping.Union[ flow_api.system.NotSet, str, NoneType ]
inittyping.Union[ dict, NoneType ]
is_enabledtyping.Union[ flow_api.system.NotSet, bool ]
is_readonlytyping.Union[ flow_api.system.NotSet, bool ]
location_inheritancetyping.Union[ flow_api.system.NotSet, str, NoneType ]
nametyping.Union[ flow_api.system.NotSet, str ]
next_runstyping.Union[ flow_api.system.NotSet, typing.Any ]
project_idtyping.Union[ flow_api.system.NotSet, str, NoneType ]
project_nametyping.Union[ flow_api.system.NotSet, str, NoneType ]
rolestyping.Union[ flow_api.system.NotSet, list, NoneType ]
scheduler_idtyping.Union[ flow_api.system.NotSet, str, NoneType ]
selecttyping.Union[ str, NoneType ]

Constants

RESOURCE = schedule

Methods

add_execution

add_identity_role

add_record_metadata

add_record_tag

add_record_user

add_resource_wrapper

bundle

clone

commit

created_by_identity

delete

deleted_by_identity

execution_list

execution_list_sync_config_id

exists

export

flow

get

get_dict

git_log_list

git_restore

identity_role_list

metadata

modified_by_identity

organization

project

record_list_created_by

record_list_deleted_by

record_list_modified_by

record_log_list

record_metadata_list

record_tag_list

record_user_list

resource_wrapper_list

restore

save

scheduler

workspace