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

ProcessFactory

Contains methods to instantiate TaskModel and ProtocolModel but it does not save the instances to the database, it only create th objects

Functions
CREATE_EMPTY_PROTOCOL_MODEL_FROM_CONFIG_DTO - @classmethod

Create a protocol model from a ProcessConfigDTO. The protocol is fully created from the dto and the process type is not used. It can create a protocol where the type does not exist in the system.

Warning, it does not initialize the graph.

Parameters:
NameTypeDefault valueDescription
protocol_config_dtoProcessConfigDTO
copy_idbool
Return type:
ProtocolModel
CREATE_OUTPUT_TASK - @classmethod
Return type:
TaskModel
CREATE_PROCESS_MODEL_FROM_TYPE - @classmethod
Parameters:
NameTypeDefault valueDescription
process_typeType
config_paramsDict
instance_namestr
community_agent_version_idstr
Return type:
TaskModel
CREATE_PROCESS_MODEL_FROM_TYPING_NAME - @classmethod
Parameters:
NameTypeDefault valueDescription
typing_namestr
config_paramsDict
instance_namestr
Return type:
TaskModel
CREATE_PROTOCOL_EMPTY - @classmethod
Parameters:
NameTypeDefault valueDescription
instance_namestr
namestr
protocol_typeType <class 'gws_core.protocol.protocol.Protocol'>
Return type:
ProtocolModel
CREATE_PROTOCOL_MODEL_FROM_TYPE - @classmethod
Parameters:
NameTypeDefault valueDescription
protocol_typeType
config_paramsDict
instance_namestr
namestr
Return type:
ProtocolModel
CREATE_SOURCE - @classmethod
Parameters:
NameTypeDefault valueDescription
resouce_idstr
Return type:
TaskModel
CREATE_TASK_MODEL_FROM_CONFIG_DTO - @classmethod

Create a task model from a ProcessConfigDTO. The task is fully created from the dto and the process type is not used. It can create a task where the type does not exist in the system.

Parameters:
NameTypeDefault valueDescription
task_config_dtoProcessConfigDTO Object containing the task configuration
copy_idbool
Return type:
TaskModel
CREATE_TASK_MODEL_FROM_TYPE - @classmethod

Create a task model from a task type. The specs are created from the task type.

:raises BadRequestException: description :raises BadRequestException: description

Parameters:
NameTypeDefault valueDescription
task_typeType _description_ [task]
config_paramsOptional _description_, defaults to none [configparamsdict], optional
instance_nameOptional _description_, defaults to none [str], optional
inputs_dtoOptional If provided, override the input spec of the task (useful for dynamic io), defaults to none [iodto], optional
outputs_dtoOptional If provided, override the output spec of the task (useful for dynamic io), defaults to none [iodto], optional
nameOptional _description_, defaults to none [str], optional
community_agent_version_idOptional _description_, defaults to none [str], optional
styleOptional _description_, defaults to none [typingstyle], optional
config_specsOptional
Return type:
TaskModel
CREATE_TASK_MODEL_FROM_TYPING_NAME - @classmethod
Parameters:
NameTypeDefault valueDescription
typing_namestr
config_paramsDict
instance_namestr
Return type:
TaskModel
CREATE_VIEWER - @classmethod
Parameters:
NameTypeDefault valueDescription
resource_typing_namestr
Return type:
TaskModel