Back to bricks list
Introduction Getting Started
Architecture
Technical Documentation
Other Classes
AbstractDbManager AgentFactory AudioView AuthService BadRequestException BarPlotView Base BaseEnvShell BaseHTTPException BaseModelDTO BaseTestCase BaseTestCaseLight BashCodeParam BoolParam BoolRField BoolValidator BoxPlotView BrickMigration BrickService CheckBeforeTaskResult CommunityService Compress CondaShellProxy Config ConfigParams Connector ConnectorPartSpec ConnectorSpec ConverterRunner Credentials CredentialsDataBasic CredentialsDataLab CredentialsDataOther CredentialsDataS3 CredentialsParam CredentialsType CurrentUserService Dashboard DashboardType DataframeAggregatorHelper DataframeDataFilterHelper DataframeFilterHelper DataFrameRField DataframeScalerHelper datetime DateTimeUTC DbConfig DictRField DictValidator DispatchedMessage DynamicInputs DynamicOutputs EntityNavigator EntityNavigatorNote EntityNavigatorResource EntityNavigatorScenario EntityNavigatorService EntityNavigatorView EntityTag EntityType Enum ExceptionHandler ExceptionResponse ExpressionBuilder ExternalApiService ExternalSpaceCreateFolder FileDownloader FileHelper FileRField FloatParam FloatRField FloatValidator ForbiddenException FrontService FrontTheme FSNodeModel FsNodeService GwsCorePackages GWSException GzipCompress HeatmapView HistogramView ImageView InPort Inputs InputSpec InputSpecs InterfaceSpec IntParam IntRField IntValidator IO IOface Job JsonCodeParam JSONField JSONView JuliaCodeParam KVStore LazyViewParam LinePlot2DView ListParam ListRField ListValidator Logger LoggerMessageObserver MailService MambaShellProxy MessageDispatcher MessageLevel MessageObserver Model ModelRfield ModelService Monitor MonitorService MultiViews NetworkView Note Notebook NoteParam NoteSearchBuilder NoteService NoteTemplate NoteTemplateParam NoteTemplateService NotFoundException NumericHelper NumericParam NumericValidator OpenAiChat OpenAiChatMessage OpenAiChatParam OpenAiHelper OutPort Outputs OutputSpec OutputSpecs PackageHelper Paginator ParamSet ParamSpec PerlCodeParam PipShellProxy PlotlyRField PlotlyView PoolDb Port PrimitiveRField Process ProcessFactory ProcessModel ProcessProxy ProcessSpec ProgressBar ProgressBarMessageObserver ProgressBarService ProtocolModel ProtocolProxy ProtocolService ProtocolTyping PythonCodeParam Queue QueueService RCodeParam Requests ResourceDownloaderBase ResourceModel ResourceOrigin ResourceRField ResourceSearchBuilder ResourceService ResourceTransfertService ResourceTyping RField RichText RichTextBlock RichTextBlockModificationDTO RichTextBlockModificationWithUserDTO RichTextBlockType RichTextDTO RichTextFigureData RichTextFileData RichTextFormulaData RichTextListData RichTextListItem RichTextModificationDifferenceDTO RichTextModificationsDTO RichTextModificationType RichTextNoteResourceViewData RichTextObjectType RichTextParagraphData RichTextParagraphHeaderData RichTextParagraphHeaderLevel RichTextParagraphListData RichTextParagraphListItemData RichTextParagraphText RichTextResourceViewData RichTextTimestampData RichTextUserDTO RichTextVariableData RichTextView RichTextViewFileData S3Bucket ScatterPlot2DView Scenario ScenarioCreationType ScenarioProcessStatus ScenarioProxy ScenarioRunService ScenarioSaveDTO ScenarioSearchBuilder ScenarioService ScenarioStatus ScenarioTemplate ScenarioTemplateFactory ScenarioTransfertService SearchBuilder SerializableObjectJson SerializableRField Settings ShellProxy ShellProxyFactory SimpleTextView SpaceFolder SpaceService SqlMigrator StackedBarPlotView StreamlitApp StreamlitAppManager StreamlitProcess StringHelper StrParam StrRField StrValidator SysProc TableAnnotatorHelper TableColumnSelector TableColumnTagToRowExtractor TableColumnTagUnfolder TableConcatHelper TableHeaderInfo TableOperationHelper TableRowSelector TableRowTagToColumnExtractor TableRowTagUnfolder TableScalerHelper TableTagAggregatorHelper TableUnfolderHelper TableView TabularView Tag TagHelper TagKeyModel TagList TagService TagsParam TagValueModel TarCompress TarGzCompress TaskFileDownloader TaskHelper TaskInputs TaskModel TaskProxy TaskRunner TaskService TaskTyping TechnicalInfo TextParam TextView TextViewData Typing TypingDeprecated TypingIconColor TypingIconType TypingManager TypingStyle UnauthorizedException URLValidator User UserCredentialsDTO UserGroup UserService Utils UUIDRField Validator VennDiagramView Version View ViewConfig ViewTester ViewType YamlCodeParam ZipCompress
Version

ResourceService

Functions
CALL_VIEW_FROM_VIEW_CONFIG - @classmethod
Parameters:
NameTypeDefault valueDescription
view_config_idstr
Return type:
CallViewResult
CALL_VIEW_ON_RESOURCE_MODEL - @classmethod
Parameters:
NameTypeDefault valueDescription
resource_modelResourceModel
view_namestr
config_valuesDict
save_view_configbool False
Return type:
CallViewResult
CHECK_IF_RESOURCE_IS_USED - @classmethod

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

Parameters:
NameTypeDefault valueDescription
resource_modelResourceModel
DELETE - @classmethod
Parameters:
NameTypeDefault valueDescription
resource_idstr
GET_AND_CALL_VIEW_ON_RESOURCE_MODEL - @classmethod
Parameters:
NameTypeDefault valueDescription
resource_model_idstr
view_namestr
config_valuesDict
save_view_configbool False
Return type:
CallViewResult
GET_BY_ID_AND_CHECK - @classmethod
Parameters:
NameTypeDefault valueDescription
idstr
Return type:
ResourceModel
GET_RESOURCE_CHILDREN - @classmethod
Parameters:
NameTypeDefault valueDescription
idstr
Return type:
List
GET_SCENARIO_GENERATED_RESOURCES - @classmethod
Parameters:
NameTypeDefault valueDescription
scenario_idsList
Return type:
List
GET_SCENARIO_INPUT_RESOURCES - @classmethod
Parameters:
NameTypeDefault valueDescription
scenario_idsList
Return type:
List
GET_SCENARIOS_RESOURCES - @classmethod

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

Parameters:
NameTypeDefault valueDescription
scenario_idsList
Return type:
List
GET_SHARED_RESOURCE_ORIGIN_INFO - @classmethod
Parameters:
NameTypeDefault valueDescription
resource_model_idstr
Return type:
SharedResource
GET_VIEW_JSON_FILE - @classmethod
Parameters:
NameTypeDefault valueDescription
resource_model_idstr
view_namestr
config_valuesDict
save_view_configbool False
Return type:
ViewDTO
GET_VIEW_SPECS_FROM_RESOURCE - @classmethod
Parameters:
NameTypeDefault valueDescription
resource_model_idstr
view_namestr
Return type:
ResourceViewMetadatalDTO
GET_VIEW_SPECS_FROM_TYPE - @classmethod
Parameters:
NameTypeDefault valueDescription
resource_typing_namestr
view_namestr
Return type:
ResourceViewMetadatalDTO
GET_VIEWS_OF_RESOURCE - @classmethod
Parameters:
NameTypeDefault valueDescription
resource_typing_namestr
Return type:
List
GET_VIEWS_OF_RESOURCE_TYPE - @classmethod
Parameters:
NameTypeDefault valueDescription
resource_typeType
Return type:
List
UPDATE_FLAGGED - @classmethod
Parameters:
NameTypeDefault valueDescription
view_config_idstr
flaggedbool
Return type:
ResourceModel
UPDATE_FOLDER - @classmethod
Parameters:
NameTypeDefault valueDescription
resource_idstr
folder_idOptional
Return type:
ResourceModel
UPDATE_NAME - @classmethod
Parameters:
NameTypeDefault valueDescription
resource_model_idstr
namestr
Return type:
ResourceModel
UPDATE_RESOURCE_TYPE - @classmethod
Parameters:
NameTypeDefault valueDescription
file_idstr
file_typing_namestr
Return type:
ResourceModel