Back to bricks list

Research documentation

Introduction

Getting Started

Developer guide

Release

Architecture

CLI

Technical Documentation

Version

ResourceService

Functions

CALL_VIEW_FROM_VIEW_CONFIG - @classmethod

Parameters:

Name	Type	Default value	Description
view_config_id	`str`

Return type:

CallViewResult

CALL_VIEW_ON_RESOURCE_MODEL - @classmethod

Parameters:

Name	Type	Default value
resource_model	`ResourceModel`
view_name	`str`
config_values	`Dict`
save_view_config	`bool`	False

Return type:

CallViewResult

CHECK_IF_RESOURCE_IS_USED - @classmethod

Check if a resource is used in an experiment, raise an exception if it is the case

Parameters:

Name	Type	Default value	Description
resource_model	`ResourceModel`

DELETE - @classmethod

Parameters:

Name	Type	Default value	Description
resource_id	`str`

GET_AND_CALL_VIEW_ON_RESOURCE_MODEL - @classmethod

Parameters:

Name	Type	Default value
resource_model_id	`str`
view_name	`str`
config_values	`Dict`
save_view_config	`bool`	False

Return type:

CallViewResult

GET_BY_ID_AND_CHECK - @classmethod

Parameters:

Name	Type	Default value	Description
id	`str`

Return type:

ResourceModel

GET_EXPERIMENT_GENERATED_RESOURCES - @classmethod

Parameters:

Name	Type	Default value	Description
experiment_ids	`List`

Return type:

List

GET_EXPERIMENT_INPUT_RESOURCES - @classmethod

Parameters:

Name	Type	Default value	Description
experiment_ids	`List`

Return type:

List

GET_EXPERIMENTS_RESOURCES - @classmethod

Return the list of reosurces used as input or output by the experiments

Parameters:

Name	Type	Default value	Description
experiment_ids	`List`

Return type:

List

GET_RESOURCE_CHILDREN - @classmethod

Parameters:

Name	Type	Default value	Description
id	`str`

Return type:

List

GET_SHARED_RESOURCE_ORIGIN_INFO - @classmethod

Parameters:

Name	Type	Default value	Description
resource_model_id	`str`

Return type:

SharedResource

GET_VIEW_JSON_FILE - @classmethod

Parameters:

Name	Type	Default value
resource_model_id	`str`
view_name	`str`
config_values	`Dict`
save_view_config	`bool`	False

Return type:

ViewDTO

GET_VIEW_SPECS_FROM_RESOURCE - @classmethod

Parameters:

Name	Type	Default value	Description
resource_model_id	`str`
view_name	`str`

Return type:

ResourceViewMetadatalDTO

GET_VIEW_SPECS_FROM_TYPE - @classmethod

Parameters:

Name	Type	Default value	Description
resource_typing_name	`str`
view_name	`str`

Return type:

ResourceViewMetadatalDTO

GET_VIEWS_OF_RESOURCE - @classmethod

Parameters:

Name	Type	Default value	Description
resource_typing_name	`str`

Return type:

List

GET_VIEWS_OF_RESOURCE_TYPE - @classmethod

Parameters:

Name	Type	Default value	Description
resource_type	`Type`

Return type:

List

SEARCH - @classmethod

Parameters:

Name	Type	Default value
search	`SearchParams`
page	`int`	0
number_of_items_per_page	`int`	20

Return type:

Paginator

UPDATE_FLAGGED - @classmethod

Parameters:

Name	Type	Default value	Description
view_config_id	`str`
flagged	`bool`

Return type:

ResourceModel

UPDATE_NAME - @classmethod

Parameters:

Name	Type	Default value	Description
resource_model_id	`str`
name	`str`

Return type:

ResourceModel

UPDATE_PROJECT - @classmethod

Parameters:

Name	Type	Default value	Description
resource_id	`str`
project_id	`Optional`

Return type:

ResourceModel

UPDATE_RESOURCE_TYPE - @classmethod

Parameters:

Name	Type	Default value	Description
file_id	`str`
file_typing_name	`str`

Return type:

ResourceModel

UPLOAD_RESOURCE_FROM_LINK - @classmethod

Parameters:

Name	Type	Default value	Description
link	`str`
uncompress_options	`str`

Return type:

ResourceModel

Stories

Live tasks

Bricks

Documentation

ResourceService

Functions