File
class flow_api.file.File(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'>, content=<class 'flow_api.system.NotSet'>, description=<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'>, name=<class 'flow_api.system.NotSet'>, project_id=<class 'flow_api.system.NotSet'>, project_name=<class 'flow_api.system.NotSet'>, track_in_git=<class 'flow_api.system.NotSet'>, debug=False)
Base class: Resource
A file which is stored in Cloudomation Engine.
To store data in a file there are three additional arguments for the save() method available:
import flow_api
def handler(system: flow_api.System, this: flow_api.Execution, inputs: dict):
# store a text (utf8 string)
system.file('my-file.txt').save_text_content('text content')
# read as base64
assert system.file('my-file.txt').get_base64_content() == 'dGV4dCBjb250ZW50'
# store bytes data
system.file('my-file.dat').save_bytes_content(b'bytes data äöü')
# read as text (utf8 string)
assert system.file('my-file.dat').get_text_content() == 'bytes data äöü'
# store a base64 encoded string
system.file('my-file.ext').save_base64_content('Q2xvdWRvbWF0aW9u')
# read as bytes
assert system.file('my-file.ext').get_bytes_content() == b'Cloudomation'
# list files
for file_ in system.files():
this.log(file_.get('name', 'content_size_bytes'))
# clean up
system.file('my-file.txt').delete()
system.file('my-file.dat').delete()
system.file('my-file.ext').delete()
return this.success('all done')
See the corresponding Resources class at File
Parameters
| Name | Type | Description |
|---|---|---|
| allow_deleted | bool | |
| allow_normal | bool | |
| bundle_id | typing.Union[ flow_api.system.NotSet, str, NoneType ] | |
| bundle_name | typing.Union[ flow_api.system.NotSet, str, NoneType ] | |
| by | str | |
| cls | typing.Union[ type, NoneType ] | |
| commit | bool | |
| commit_message | typing.Union[ flow_api.system.NotSet, str, NoneType ] | |
| content | typing.Union[ flow_api.system.NotSet, bytes ] | |
| debug | bool | |
| description | typing.Union[ flow_api.system.NotSet, str, NoneType ] | |
| init | typing.Union[ dict, NoneType ] | |
| is_bundle_content | typing.Union[ flow_api.system.NotSet, bool ] | |
| is_readonly | typing.Union[ flow_api.system.NotSet, bool ] | |
| location_inheritance | typing.Union[ flow_api.system.NotSet, str, NoneType ] | |
| name | typing.Union[ flow_api.system.NotSet, str ] | |
| project_id | typing.Union[ flow_api.system.NotSet, str, NoneType ] | |
| project_name | typing.Union[ flow_api.system.NotSet, str, NoneType ] | |
| select | typing.Union[ str, NoneType ] | |
| track_in_git | typing.Union[ flow_api.system.NotSet, bool, NoneType ] |