Skip to main content
Version: 9 - Germknödel

Schedule

class flow_api.schedule.Schedule(select=None, cls=None, init=None, by='name', allow_normal=True, allow_deleted=False, 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'], flow_id=[class 'flow_api.system.NotSet'], is_enabled=[class 'flow_api.system.NotSet'], is_readonly=[class 'flow_api.system.NotSet'], name=[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'], setting_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 ]Reference to the bundle this record is associated with. Allowed for BUNDLE_REPOSITORY, CONNECTOR, CUSTOM_OBJECT, FILE, FLOW, LDAP_CONFIG, OAUTH, OBJECT_TEMPLATE, PLUGIN, ROLE, SCHEDULE, SCHEDULER, SCHEMA, SETTING, SYNC_CONFIG, TAG, VAULT_CONFIG, WEBHOOK, WRAPPER. Not allowed for BUNDLE, EXECUTION, MESSAGE, 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 ]
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.
flow_idtyping.Union[ flow_api.system.NotSet, str, NoneType ]Reference to the flow that is executed via the scheduler.
inittyping.Union[ dict, NoneType ]
is_enabledtyping.Union[ flow_api.system.NotSet, bool ]Flag to control if the schedule should be used.
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, 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
nametyping.Union[ flow_api.system.NotSet, str ]The name of this record. Must be unique across a workspace.
project_idtyping.Union[ flow_api.system.NotSet, str, NoneType ]Reference to the project this record is associated with. Allowed for CONNECTOR, CUSTOM_OBJECT, 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.
rolestyping.Union[ flow_api.system.NotSet, dict, NoneType ]The roles this identity has.
scheduler_idtyping.Union[ flow_api.system.NotSet, str, NoneType ]Reference to the scheduler that the schedule uses for implementing the scheduling logic.
selecttyping.Union[ str, NoneType ]
setting_idtyping.Union[ flow_api.system.NotSet, str, NoneType ]Reference to the setting that contains the configuration for the scheduler.

Constants​

RESOURCE = schedule

Methods​

add_identity_role​

add_record_tag​

add_record_user​

add_resource_wrapper​

add_role​

add_tag​

bundle​

clone​

created_by_identity​

delete​

deleted_by_identity​

execution_list​

execution_list_sync_config_id​

exists​

export​

flow​

get​

get_dict​

get_identity_created_by​

get_identity_deleted_by​

get_identity_modified_by​

get_logs​

get_roles​

get_tags​

identity_role_list​

modified_by_identity​

organization​

project​

record_list_created_by​

record_list_deleted_by​

record_list_modified_by​

record_log_list​

record_tag_list​

record_user_list​

remove_role​

remove_tag​

resource_wrapper_list​

restore​

save​

scheduler​

setting​

workspace​