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

Add a resource to the AppResource.

Add technical information on the resource. Technical info are useful to set additional information on the 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

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

Disable the automatic stop of the app when no connections are detected.

Return the access mode of the app, derived from the _requires_authentification flag (True -> AUTHENTICATED, False -> PUBLIC).

Get the id of the resource model in the database. It is provided by the system for input resources of a task. If the model id is None, it raises an exception.

Get the technical information of the resource and raise if it does not exist

Return the custom subdomain of the app, or None if not set.

When set, the app is reachable at a readable, stable host derived from this value instead of the (unstable) resource model id.

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

Get the default style of the resource

Get the main app file name that will be used to run the app. This file must be in the app folder.

Get the id of the resource model in the database. It is provided by the system for input resources of a task.

Get the name of the resource or the default name if the name is None

Get the parameters that will be passed to the app.

Return the first resource with the given name

Return the resource model ids of the sub resources

Return the resource models of the sub resources list

Return the sub resources as a list

Return the sub resources as a set

Return the stop policy of the app.

Get the technical information of the resource

Return true if the resource with the given id is in the resource list

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

Initialize the app instance with the shell proxy. This method is used to create the app instance that will be used to run the app.

Return true if the resource list is empty

Return True if the app is executed in a virtual environment.

Replace current resources by the resources in the dict

Set the access mode of the app. By default the app is AUTHENTICATED.

Set the app config that will be used to generate the app. The AppResource stores the app config typing name to find the app config code. As long as the app config typing name does not change, the app config will be working.

If the app config code is updated, the AppResource will automatically use the updated the app config code.

Mark this resource as a reference to an existing saved resource.

When set, the system will not create a new resource on save but will reuse the existing one. Use this in a task's run() method before returning an input resource unchanged, or use create_new_resource=False in ResourceSet/ResourceList.add_resource().

Set an optional readable, stable custom subdomain for the app.

When set, the app host uses this value instead of the resource model id, so the URL stays stable across re-publishes. The value is validated as a DNS label and must be unique across all persisted AppResources in the lab.

Passing a falsy value (None or empty string) clears the custom subdomain and restores the default id-based host.

Set the code that will be executed in the app environment. This code is executed before the app is loaded and can be used to load environment variables.

Set the name of the resource. You can override this method to force a format for the name of the resource.

Set a parameter that will be passed to the app into the 'params' variable.

Set the parameters that will be passed to the app into the 'params' variable.

Back-compat shim for the boolean flag. Prefer set_access_mode for new code.

Set the folder that contains the app code.

This is only recommended if you want to force the version of the app in this Resource and avoid automatic updates. Otherwise use the set_app_config method. The folder is copied and stored as a sub resource of the AppResource. The app need to be re-generated to update the code.

Set how the app should be stopped when no connections are detected. By default (AUTO), the app is automatically stopped when no connections are detected.

Return the resources as a list

Returns the name of the class

Copy the style of the resource with the possibility to override some properties. Useful when settings the style for a task based on the resource style.

Returns the full name of the class

Get the human name of the object

Get the short description of the object

Get the style of the object

Get the typing name of the object Ex: 'RESOURCE.gws_core.Table'

Get all the classes that inherit this class