Login

Fs node

RESOURCE
Typing name :  RESOURCE.gws_core.FSNode Brick :  gws_core v Parent : 

Node class to manage resources that are stored in the server (as file or folder)

/!\ The class that extend file can only have a path and file_store_id attributes. Other attributes will not be provided when creating the resource

Views

VIEW RESOURCE - view_as_json()Default view
View the complete resource as json

Functions










__INIT__

Constructor, please do not overwrite this method, use the init method instead Leave the constructor without parameters.

Parameters:
pathstr
ADD_TECHNICAL_INFO

Add a technical information to the resource

Parameters:
technical_infoTechnicalInfo
CHECK_RESOURCE

You can redefine this method to define custom logic to check this resource. If there is a problem with the resource, return a string that define the error, otherwise return None This method is called on output resources of a task. If there is an error returned, the task will be set to error and next proceses will not be run. It is also call when uploading a resource (usually for files or folder), if there is an error returned, the resource will not be uploaded

Return type:
Union[str, NoneType]
CLONE

Clone the resource to create a new instance with a new id It copies the RFields

Return type:
Resource
EXISTS
GET_DEFAULT_NAME

You can redefine this method to set a name of the resource. When saving the resource the name will be saved automatically This can be useful to distinguish this resource from another one or to search for the resource

Return type:
str
GET_SIZE
Return type:
int
GET_TECHNICAL_INFO

Get the technical information of the resource

Parameters:
keystr
Return type:
TechnicalInfo
INIT

This can be overwritten to perform custom initialization of the resource. This method is called just after the init (constructor) of the resource. The default values of RFields are set before this method is called.