Back to bricks list

Research documentation

Introduction

Getting Started

Developer guide

Release

Architecture

CLI

Technical Documentation

Version

ProtocolService

Functions

ADD_COMMUNITY_LIVE_TASK_VERSION_TO_PROTOCOL_ID - @classmethod

ADD_CONNECTOR_TO_PROTOCOL - @classmethod

Parameters:

Name	Type	Default value	Description
protocol_model	`ProtocolModel`
from_process_name	`str`
from_port_name	`str`
to_process_name	`str`
to_port_name	`str`

Return type:

ProtocolUpdate

ADD_CONNECTOR_TO_PROTOCOL_ID - @classmethod

Parameters:

Name	Type	Default value	Description
protocol_id	`str`
from_process_name	`str`
from_port_name	`str`
to_process_name	`str`
to_port_name	`str`

Return type:

ProtocolUpdate

ADD_CONNECTORS_TO_PROTOCOL - @classmethod

Parameters:

Name	Type	Default value	Description
protocol_model	`ProtocolModel`
connectors	`List`

Return type:

ProtocolUpdate

ADD_DYNAMIC_INPUT_PORT_TO_PROCESS - @classmethod

Parameters:

Name	Type	Default value	Description
protocol_id	`str`
process_name	`str`
io_spec_dto	`IOSpecDTO`

Return type:

ProtocolUpdate

ADD_DYNAMIC_OUTPUT_PORT_TO_PROCESS - @classmethod

Parameters:

Name	Type	Default value	Description
protocol_id	`str`
process_name	`str`
io_spec_dto	`IOSpecDTO`

Return type:

ProtocolUpdate

ADD_EMPTY_PROTOCOL_TO_PROTOCOL - @classmethod

ADD_INTERFACE_TO_PROTOCOL - @classmethod

Parameters:

Name	Type	Default value	Description
protocol_model	`ProtocolModel`
name	`str`
target_process_name	`str`
target_port_name	`str`

Return type:

ProtocolUpdate

ADD_OUTERFACE_TO_PROTOCOL - @classmethod

Parameters:

Name	Type	Default value	Description
protocol_model	`ProtocolModel`
name	`str`
source_process_name	`str`
source_port_name	`str`

Return type:

ProtocolUpdate

ADD_PROCESS_CONNECTED_TO_INPUT - @classmethod

ADD_PROCESS_CONNECTED_TO_OUTPUT - @classmethod

ADD_PROCESS_MODEL_TO_PROTOCOL - @classmethod

ADD_PROCESS_TO_PROTOCOL - @classmethod

ADD_PROCESS_TO_PROTOCOL_ID - @classmethod

ADD_SINK_TO_PROCESS_OUPUT - @classmethod

Add a sink task to the protocol. And add connector from process to sink

Parameters:

Name	Type	Default value	Description
protocol_id	`str`
process_name	`str`
output_port_name	`str`

Return type:

ProtocolUpdate

ADD_SOURCE_TO_PROCESS_INPUT - @classmethod

Add a source task to the protocol. Configure it with the resource. And add connector from source to process

Parameters:

Name	Type	Default value	Description
protocol_id	`str`
resource_id	`str`
process_name	`str`
input_port_name	`str`

Return type:

ProtocolUpdate

ADD_SOURCE_TO_PROTOCOL_ID - @classmethod

Add a source task to the protocol. Configure it with the resource.

Parameters:

Name	Type	Default value	Description
protocol_id	`str`
resource_id	`str`

Return type:

ProtocolUpdate

ADD_VIEWER_TO_PROCESS_OUTPUT - @classmethod

CONFIGURE_PROCESS - @classmethod

CONFIGURE_PROCESS_MODEL - @classmethod

COPY_PROTOCOL - @classmethod

CREATE_COMMUNITY_LIVE_TASK - @classmethod

Parameters:

Name	Type	Default value	Description
process_id	`str`
form_data	`CommunityCreateLiveTaskDTO`

Return type:

CommunityLiveTaskVersionCreateResDTO

CREATE_COMMUNITY_LIVE_TASK_VERSION - @classmethod

Parameters:

Name	Type	Default value	Description
process_id	`str`
live_task_id	`str`

Return type:

CommunityLiveTaskVersionCreateResDTO

CREATE_EMPTY_PROTOCOL - @classmethod

Parameters:

Name	Type	Default value	Description
instance_name	`str`

Return type:

ProtocolModel

CREATE_PROTOCOL_MODEL_FROM_GRAPH - @classmethod

Parameters:

Name	Type	Default value	Description
graph	`ProtocolGraphConfigDTO`

Return type:

ProtocolModel

CREATE_PROTOCOL_MODEL_FROM_TEMPLATE - @classmethod

Parameters:

Name	Type	Default value	Description
protocol_template	`ProtocolTemplate`

Return type:

ProtocolModel

CREATE_PROTOCOL_MODEL_FROM_TYPE - @classmethod

Parameters:

Name	Type	Default value	Description
protocol_type	`Type`
instance_name	`str`
config_params	`Dict`

Return type:

ProtocolModel

CREATE_PROTOCOL_TEMPLATE_FROM_ID - @classmethod

Parameters:

Name	Type	Default value	Description
protocol_id	`str`
name	`str`
description	`dict`

Return type:

ProtocolTemplate

DELETE_CONNECTOR_OF_PROTOCOL - @classmethod

DELETE_DYNAMIC_INPUT_PORT_OF_PROCESS - @classmethod

Parameters:

Name	Type	Default value	Description
protocol_id	`str`
process_name	`str`
port_name	`str`

Return type:

ProtocolUpdate

DELETE_DYNAMIC_OUTPUT_PORT_OF_PROCESS - @classmethod

Parameters:

Name	Type	Default value	Description
protocol_id	`str`
process_name	`str`
port_name	`str`

Return type:

ProtocolUpdate

DELETE_INTERFACE_OF_PROTOCOL - @classmethod

Parameters:

Name	Type	Default value	Description
protocol_model	`ProtocolModel`
interface_name	`str`

Return type:

ProtocolUpdate

DELETE_INTERFACE_OF_PROTOCOL_ID - @classmethod

Parameters:

Name	Type	Default value	Description
protocol_id	`str`
interface_name	`str`

Return type:

ProtocolUpdate

DELETE_OUTERFACE_OF_PROTOCOL - @classmethod

Parameters:

Name	Type	Default value	Description
protocol_model	`ProtocolModel`
outerface_name	`str`

Return type:

ProtocolUpdate

DELETE_OUTERFACE_OF_PROTOCOL_ID - @classmethod

Parameters:

Name	Type	Default value	Description
protocol_id	`str`
outerface_name	`str`

Return type:

ProtocolUpdate

DELETE_PROCESS_OF_PROTOCOL - @classmethod

DELETE_PROCESS_OF_PROTOCOL_ID - @classmethod

Parameters:

Name	Type	Default value	Description
protocol_id	`str`
process_instance_name	`str`

Return type:

ProtocolUpdate

DUPLICATE_PROCESS_TO_PROTOCOL_ID - @classmethod

FORK_COMMUNITY_LIVE_TASK - @classmethod

Parameters:

Name	Type	Default value	Description
process_id	`str`
form_data	`CommunityCreateLiveTaskDTO`
live_task_version_id	`str`

Return type:

CommunityLiveTaskVersionCreateResDTO

GENERATE_PROTOCOL_TEMPLATE - @classmethod

Parameters:

Name	Type	Default value	Description
protocol_id	`str`

Return type:

ProtocolTemplate

GET_BY_ID_AND_CHECK - @classmethod

Parameters:

Name	Type	Default value	Description
id	`str`

Return type:

ProtocolModel

GET_COMMUNITY_AVAILABLE_LIVE_TASKS - @classmethod

GET_COMMUNITY_AVAILABLE_SPACE - @classmethod

GET_COMMUNITY_LIVE_TASK - @classmethod

Parameters:

Name	Type	Default value	Description
live_task_version_id	`str`

Return type:

CommunityLiveTaskDTO

RENAME_PROCESS - @classmethod

Parameters:

Name	Type	Default value	Description
protocol_id	`str`
process_instance_name	`str`
custom_name	`str`

Return type:

ProcessModel

RESET_PROCESS_OF_PROTOCOL - @classmethod

RUN_PROCESS - @classmethod

Parameters:

Name	Type	Default value	Description
protocol_id	`str`
process_instance_name	`str`

Return type:

ProtocolUpdate

SAVE_INTERFACE_LAYOUT - @classmethod

Parameters:

Name	Type	Default value	Description
protocol_id	`str`
interface_name	`str`
layout	`ProcessLayoutDTO`

SAVE_LAYOUT - @classmethod

Parameters:

Name	Type	Default value	Description
protocol_id	`str`
layout_dict	`ProtocolLayoutDTO`

SAVE_OUTERFACE_LAYOUT - @classmethod

Parameters:

Name	Type	Default value	Description
protocol_id	`str`
outerface_name	`str`
layout	`ProcessLayoutDTO`

SAVE_PROCESS_LAYOUT - @classmethod

Parameters:

Name	Type	Default value	Description
protocol_id	`str`
process_instance_name	`str`
layout	`ProcessLayoutDTO`

SET_PROCESS_MODEL_CONFIG_VALUE - @classmethod

UPDATE_DYNAMIC_INPUT_PORT_OF_PROCESS - @classmethod

Parameters:

Name	Type	Default value	Description
protocol_id	`str`
process_name	`str`
port_name	`str`
io_spec	`IOSpecDTO`

Return type:

ProtocolUpdate

UPDATE_DYNAMIC_OUTPUT_PORT_OF_PROCESS - @classmethod

Parameters:

Name	Type	Default value	Description
protocol_id	`str`
process_name	`str`
port_name	`str`
io_spec	`IOSpecDTO`

Return type:

ProtocolUpdate

Stories

Live tasks

Bricks

Documentation

ProtocolService

Functions