RecordBase
class flow_api.record_base.RecordBase
(select, cls, init, by, allow_normal=True, allow_archived=False, allow_deleted=False, **kwargs
)
The RecordBase class is the base class for all of Cloudomation records.
It provides a basic interface to read and write fields of records.
Do not create RecordBase
objects directly. Instead use System.execution
,
System.file
, System.flow
, or System.setting
to create classes of
the respective record subclass.
Parameters
Name | Type | Description |
---|---|---|
**kwargs | ||
allow_archived | bool | |
allow_deleted | bool | |
allow_normal | bool | |
by | Which field of the record is used to identify the record. Should be 'id' or 'name' | |
cls | The class of the record type | |
init | a dictionary containing fields of the record to save | |
select | The name or ID of the record |
Methods
archive ()
clone (update=None, **kwargs)
delete (permanently=False)
exists ()
export ()
get (*fields, default=None)
get_dict (*fields, default=None)
get_identity_created_by ()
get_identity_modified_by ()
load (*fields)
restore ()
save (update=None, **kwargs)
set (key, value)