Skip to main content
Version: 11 - TBD

Schema

class flow_api.schema.Schema(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'>, description=<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'>, project_id=<class 'flow_api.system.NotSet'>, project_name=<class 'flow_api.system.NotSet'>, value=<class 'flow_api.system.NotSet'>, debug=False)

Base class: Resource

A YAML schema document which can be used to validate data.

See the corresponding Resources class at Schema

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 ]
debugbool
descriptiontyping.Union[ flow_api.system.NotSet, str, NoneType ]
inittyping.Union[ dict, NoneType ]
is_readonlytyping.Union[ flow_api.system.NotSet, bool ]
location_inheritancetyping.Union[ flow_api.system.NotSet, str, NoneType ]
nametyping.Union[ flow_api.system.NotSet, str ]
project_idtyping.Union[ flow_api.system.NotSet, str, NoneType ]
project_nametyping.Union[ flow_api.system.NotSet, str, NoneType ]
selecttyping.Union[ str, NoneType ]
valuetyping.Union[ flow_api.system.NotSet, typing.Any ]

Constants​

RESOURCE = schema

Methods​

add_record_metadata​

add_record_tag​

add_record_user​

add_resource_wrapper​

bundle​

clone​

coerce​

commit​

created_by_identity​

delete​

deleted_by_identity​

exists​

export​

get​

get_dict​

git_log_list​

git_restore​

metadata​

modified_by_identity​

organization​

project​

record_log_list​

record_metadata_list​

record_tag_list​

record_user_list​

resource_wrapper_list​

restore​

save​

validate​

workspace​