gws_core

Introduction
Getting Started
Developer guide
Release
Architecture
CLI
Technical documentations
Version

ProtocolService

Functions
add_agent_to_protocol_id_by_agent_version_id @classmethod
add_community_agent_version_to_protocol_id @classmethod
add_connector_to_protocol @classmethod
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
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
protocol_model : ProtocolModel
connectors : List
Return type : ProtocolUpdate
add_dynamic_input_port_to_process @classmethod
protocol_id : str
process_name : str
io_spec_dto : IOSpecDTO
Return type : ProtocolUpdate
add_dynamic_output_port_to_process @classmethod
protocol_id : str
process_name : str
io_spec_dto : IOSpecDTO
Return type : ProtocolUpdate
add_dynamic_param_spec_of_process @classmethod
protocol_id : str
process_name : str
config_spec_name : str
param_name : str
spec_dto : ParamSpecDTO
Return type : ProtocolUpdate
add_empty_protocol_to_protocol @classmethod
add_empty_protocol_to_protocol_id @classmethod
add_input_resource_to_process_input @classmethod

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

protocol_id : str
resource_id : str
process_name : str
input_port_name : str
Return type : ProtocolUpdate
add_input_resource_to_protocol_id @classmethod

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

protocol_id : str
resource_id : str
Return type : ProtocolUpdate
add_interface_to_protocol @classmethod
protocol_model : ProtocolModel
name : str
target_process_name : str
target_port_name : str
Return type : ProtocolUpdate
add_interface_to_protocol_id @classmethod
protocol_model_id : str
target_process_name : str
target_port_name : str
Return type : ProtocolUpdate
add_outerface_to_protocol @classmethod
protocol_model : ProtocolModel
name : str
source_process_name : str
source_port_name : str
Return type : ProtocolUpdate
add_outerface_to_protocol_id @classmethod
protocol_id : str
source_process_name : str
source_port_name : str
Return type : ProtocolUpdate
add_output_task_to_process_ouput @classmethod

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

protocol_id : str
process_name : str
output_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_scenario_template_to_protocol @classmethod
add_viewer_to_process_output @classmethod
configure_process @classmethod
configure_process_model @classmethod
copy_protocol @classmethod
create_community_agent @classmethod
process_id : str
form_data : CommunityCreateAgentDTO
Return type : CommunityAgentVersionCreateResDTO
create_community_agent_version @classmethod
process_id : str
agent_id : str
Return type : CommunityAgentVersionCreateResDTO
create_empty_protocol @classmethod
instance_name : str
Return type : ProtocolModel
create_protocol_model_from_graph @classmethod
graph : ProtocolGraphConfigDTO
Return type : ProtocolModel
create_protocol_model_from_template @classmethod
scenario_template : ScenarioTemplate
Return type : ProtocolModel
create_protocol_model_from_type @classmethod
protocol_type : Type
instance_name : str
config_params : Dict
Return type : ProtocolModel
create_scenario_template_from_id @classmethod
protocol_id : str
name : str
description : RichTextDTO
Return type : ScenarioTemplate
delete_connector_of_protocol @classmethod
delete_dynamic_input_port_of_process @classmethod
protocol_id : str
process_name : str
port_name : str
Return type : ProtocolUpdate
delete_dynamic_output_port_of_process @classmethod
protocol_id : str
process_name : str
port_name : str
Return type : ProtocolUpdate
delete_interface_of_protocol @classmethod
protocol_model : ProtocolModel
interface_name : str
Return type : ProtocolUpdate
delete_interface_of_protocol_id @classmethod
protocol_id : str
interface_name : str
Return type : ProtocolUpdate
delete_outerface_of_protocol @classmethod
protocol_model : ProtocolModel
outerface_name : str
Return type : ProtocolUpdate
delete_outerface_of_protocol_id @classmethod
protocol_id : str
outerface_name : str
Return type : ProtocolUpdate
delete_process_of_protocol @classmethod
delete_process_of_protocol_id @classmethod
protocol_id : str
process_instance_name : str
Return type : ProtocolUpdate
duplicate_process_to_protocol_id @classmethod
fork_community_agent @classmethod
process_id : str
form_data : CommunityCreateAgentDTO
agent_version_id : str
Return type : CommunityAgentVersionCreateResDTO
generate_scenario_template @classmethod
protocol_id : str
Return type : ScenarioTemplate
get_by_id_and_check @classmethod
id : str
Return type : ProtocolModel
get_community_agent @classmethod
agent_version_id : str
Return type : CommunityAgentDTO
get_community_available_agents @classmethod
get_community_available_space @classmethod
get_dynamic_param_allowed_param_spec_types @classmethod
protocol_id : str
process_name : str
Return type : Dict
remove_dynamic_param_spec_of_process @classmethod
protocol_id : str
process_name : str
config_spec_name : str
param_name : str
Return type : ProtocolUpdate
rename_and_update_dynamic_param_spec_of_process @classmethod
protocol_id : str
process_name : str
config_spec_name : str
param_name : str
new_param_name : str
spec_dto : ParamSpecDTO
Return type : ProtocolUpdate
rename_process @classmethod
protocol_id : str
process_instance_name : str
custom_name : str
Return type : ProcessModel
reset_process_of_protocol @classmethod
run_process @classmethod
protocol_id : str
process_instance_name : str
Return type : ProtocolUpdate
save_interface_layout @classmethod
protocol_id : str
interface_name : str
layout : ProcessLayoutDTO
save_layout @classmethod
protocol_id : str
layout_dict : ProtocolLayoutDTO
save_outerface_layout @classmethod
protocol_id : str
outerface_name : str
layout : ProcessLayoutDTO
save_process_layout @classmethod
protocol_id : str
process_instance_name : str
layout : ProcessLayoutDTO
set_process_model_config_value @classmethod
update_code_params_visitility @classmethod
update_dynamic_input_port_of_process @classmethod
protocol_id : str
process_name : str
port_name : str
io_spec : IOSpecDTO
Return type : ProtocolUpdate
update_dynamic_output_port_of_process @classmethod
protocol_id : str
process_name : str
port_name : str
io_spec : IOSpecDTO
Return type : ProtocolUpdate
update_dynamic_param_spec_of_process @classmethod
protocol_id : str
process_name : str
config_spec_name : str
param_name : str
spec_dto : ParamSpecDTO
Return type : ProtocolUpdate
update_process_style @classmethod
protocol_id : Any
process_instance_name : str
style : TypingStyle
Return type : ProcessModel