Login
Back to bricks list
Introduction Version

ProtocolService

Functions

ADD_COMMUNITY_LIVE_TASK_VERSION_TO_PROTOCOL_ID - @classmethod
ADD_CONNECTOR_TO_PROTOCOL - @classmethod
Parameters:
NameTypeDefault valueDescription
protocol_modelProtocolModel
from_process_namestr
from_port_namestr
to_process_namestr
to_port_namestr
Return type:
ProtocolUpdate
ADD_CONNECTOR_TO_PROTOCOL_ID - @classmethod
Parameters:
NameTypeDefault valueDescription
protocol_idstr
from_process_namestr
from_port_namestr
to_process_namestr
to_port_namestr
Return type:
ProtocolUpdate
ADD_CONNECTORS_TO_PROTOCOL - @classmethod
Parameters:
NameTypeDefault valueDescription
protocol_modelProtocolModel
connectorsList
Return type:
ProtocolUpdate
ADD_DYNAMIC_INPUT_PORT_TO_PROCESS - @classmethod
Parameters:
NameTypeDefault valueDescription
protocol_idstr
process_namestr
io_spec_dtoIOSpecDTO
Return type:
ProtocolUpdate
ADD_DYNAMIC_OUTPUT_PORT_TO_PROCESS - @classmethod
Parameters:
NameTypeDefault valueDescription
protocol_idstr
process_namestr
io_spec_dtoIOSpecDTO
Return type:
ProtocolUpdate
ADD_EMPTY_PROTOCOL_TO_PROTOCOL - @classmethod
ADD_INTERFACE_TO_PROTOCOL - @classmethod
Parameters:
NameTypeDefault valueDescription
protocol_modelProtocolModel
namestr
target_process_namestr
target_port_namestr
Return type:
ProtocolUpdate
ADD_OUTERFACE_TO_PROTOCOL - @classmethod
Parameters:
NameTypeDefault valueDescription
protocol_modelProtocolModel
namestr
source_process_namestr
source_port_namestr
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:
NameTypeDefault valueDescription
protocol_idstr
process_namestr
output_port_namestr
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:
NameTypeDefault valueDescription
protocol_idstr
resource_idstr
process_namestr
input_port_namestr
Return type:
ProtocolUpdate
ADD_SOURCE_TO_PROTOCOL_ID - @classmethod

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

Parameters:
NameTypeDefault valueDescription
protocol_idstr
resource_idstr
Return type:
ProtocolUpdate
ADD_VIEWER_TO_PROCESS_OUTPUT - @classmethod
CONFIGURE_PROCESS - @classmethod
COPY_PROTOCOL - @classmethod
CREATE_COMMUNITY_LIVE_TASK - @classmethod
Parameters:
NameTypeDefault valueDescription
process_idstr
form_dataCommunityCreateLiveTaskDTO
Return type:
CommunityLiveTaskVersionCreateResDTO
CREATE_COMMUNITY_LIVE_TASK_VERSION - @classmethod
Parameters:
NameTypeDefault valueDescription
process_idstr
live_task_idstr
Return type:
CommunityLiveTaskVersionCreateResDTO
CREATE_EMPTY_PROTOCOL - @classmethod
Parameters:
NameTypeDefault valueDescription
instance_namestr
Return type:
ProtocolModel
CREATE_PROTOCOL_MODEL_FROM_GRAPH - @classmethod
Parameters:
NameTypeDefault valueDescription
graphProtocolConfigDTO
Return type:
ProtocolModel
CREATE_PROTOCOL_MODEL_FROM_TEMPLATE - @classmethod
Parameters:
NameTypeDefault valueDescription
protocol_templateProtocolTemplate
Return type:
ProtocolModel
CREATE_PROTOCOL_MODEL_FROM_TYPE - @classmethod
Parameters:
NameTypeDefault valueDescription
protocol_typeType
instance_namestr
config_paramsDict
Return type:
ProtocolModel
CREATE_PROTOCOL_TEMPLATE_FROM_ID - @classmethod
Parameters:
NameTypeDefault valueDescription
protocol_idstr
namestr
descriptiondict
Return type:
ProtocolTemplate
DELETE_CONNECTOR_OF_PROTOCOL - @classmethod
DELETE_DYNAMIC_INPUT_PORT_OF_PROCESS - @classmethod
Parameters:
NameTypeDefault valueDescription
protocol_idstr
process_namestr
port_namestr
Return type:
ProtocolUpdate
DELETE_DYNAMIC_OUTPUT_PORT_OF_PROCESS - @classmethod
Parameters:
NameTypeDefault valueDescription
protocol_idstr
process_namestr
port_namestr
Return type:
ProtocolUpdate
DELETE_INTERFACE_OF_PROTOCOL - @classmethod
Parameters:
NameTypeDefault valueDescription
protocol_modelProtocolModel
interface_namestr
Return type:
ProtocolUpdate
DELETE_INTERFACE_OF_PROTOCOL_ID - @classmethod
Parameters:
NameTypeDefault valueDescription
protocol_idstr
interface_namestr
Return type:
ProtocolUpdate
DELETE_OUTERFACE_OF_PROTOCOL - @classmethod
Parameters:
NameTypeDefault valueDescription
protocol_modelProtocolModel
outerface_namestr
Return type:
ProtocolUpdate
DELETE_OUTERFACE_OF_PROTOCOL_ID - @classmethod
Parameters:
NameTypeDefault valueDescription
protocol_idstr
outerface_namestr
Return type:
ProtocolUpdate
DELETE_PROCESS_OF_PROTOCOL - @classmethod
DELETE_PROCESS_OF_PROTOCOL_ID - @classmethod
Parameters:
NameTypeDefault valueDescription
protocol_idstr
process_instance_namestr
Return type:
ProtocolUpdate
DUPLICATE_PROCESS_TO_PROTOCOL_ID - @classmethod
FORK_COMMUNITY_LIVE_TASK - @classmethod
Parameters:
NameTypeDefault valueDescription
process_idstr
form_dataCommunityCreateLiveTaskDTO
live_task_version_idstr
Return type:
CommunityLiveTaskVersionCreateResDTO
GENERATE_PROTOCOL_TEMPLATE - @classmethod
Parameters:
NameTypeDefault valueDescription
protocol_idstr
Return type:
ProtocolTemplate
GET_BY_ID_AND_CHECK - @classmethod
Parameters:
NameTypeDefault valueDescription
idstr
Return type:
ProtocolModel
GET_COMMUNITY_AVAILABLE_LIVE_TASKS - @classmethod
GET_COMMUNITY_AVAILABLE_SPACE - @classmethod
GET_COMMUNITY_LIVE_TASK - @classmethod
Parameters:
NameTypeDefault valueDescription
live_task_version_idstr
Return type:
CommunityLiveTaskDTO
RENAME_PROCESS - @classmethod
Parameters:
NameTypeDefault valueDescription
protocol_idstr
process_instance_namestr
custom_namestr
Return type:
ProcessModel
RESET_PROCESS_OF_PROTOCOL - @classmethod
RUN_PROCESS - @classmethod
Parameters:
NameTypeDefault valueDescription
protocol_idstr
process_instance_namestr
Return type:
ProtocolUpdate
SAVE_INTERFACE_LAYOUT - @classmethod
Parameters:
NameTypeDefault valueDescription
protocol_idstr
interface_namestr
layoutProcessLayoutDTO
SAVE_LAYOUT - @classmethod
Parameters:
NameTypeDefault valueDescription
protocol_idstr
layout_dictProtocolLayoutDTO
SAVE_OUTERFACE_LAYOUT - @classmethod
Parameters:
NameTypeDefault valueDescription
protocol_idstr
outerface_namestr
layoutProcessLayoutDTO
SAVE_PROCESS_LAYOUT - @classmethod
Parameters:
NameTypeDefault valueDescription
protocol_idstr
process_instance_namestr
layoutProcessLayoutDTO
UPDATE_DYNAMIC_INPUT_PORT_OF_PROCESS - @classmethod
Parameters:
NameTypeDefault valueDescription
protocol_idstr
process_namestr
port_namestr
io_specIOSpecDTO
Return type:
ProtocolUpdate
UPDATE_DYNAMIC_OUTPUT_PORT_OF_PROCESS - @classmethod
Parameters:
NameTypeDefault valueDescription
protocol_idstr
process_namestr
port_namestr
io_specIOSpecDTO
Return type:
ProtocolUpdate