Login
Introduction Version

View resource

RESOURCE
Typing name :  RESOURCE.gws_core.ViewResource Brick :  gws_core v
Parent :
Resource

Resource that contains a view

Special resource that holds a view

Views

SHOW VIEW - default_view()Default view
VIEW RESOURCE - view_as_json()
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:
NameTypeDefault valueDescription
view_dictdict None
ADD_TECHNICAL_INFO

Add a technical information to the resource

Parameters:
NameTypeDefault valueDescription
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:
ResourceType
FROM_RESOURCE
Parameters:
NameTypeDefault valueDescription
resourceResource
view_method_namestr
config_valuesDict None
Return type:
ViewResource
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_TECHNICAL_INFO

Get the technical information of the resource

Parameters:
NameTypeDefault valueDescription
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.