def save_user_defined_process(
self,
user_defined_process_id: str,
process_graph: dict,
parameters: List[Union[dict, Parameter]] = None,
public: bool = False,
summary: str = None,
description: str = None) -> RESTUserDefinedProcess:
"""
Saves a process graph and its metadata in the backend as a user-defined process for the authenticated user.
:param user_defined_process_id: unique identifier for the user-defined process
:param process_graph: a process graph
:param parameters: a list of parameters
:param public: visible to other users?
:param summary: A short summary of what the process does.
:param description: Detailed description to explain the entity. CommonMark 0.29 syntax MAY be used for rich text representation.
:return: a RESTUserDefinedProcess instance
"""
if user_defined_process_id in set(p["id"]
for p in self.list_processes()):
warnings.warn(
"Defining user-defined process {u!r} with same id as a pre-defined process"
.format(u=user_defined_process_id))
udp = RESTUserDefinedProcess(
user_defined_process_id=user_defined_process_id, connection=self)
udp.store(process_graph=process_graph,
parameters=parameters,
public=public,
summary=summary,
description=description)
return udp
def user_defined_process(self, user_defined_process_id: str) -> RESTUserDefinedProcess:
"""
Get the user-defined process based on its id. The process with the given id should already exist.
:param user_defined_process_id: the id of the user-defined process
:return: a RESTUserDefinedProcess instance
"""
return RESTUserDefinedProcess(user_defined_process_id=user_defined_process_id, connection=self)
def save_user_defined_process(
self, user_defined_process_id: str, process_graph: dict,
parameters: List[Union[dict, Parameter]] = None, public: bool = False) -> RESTUserDefinedProcess:
"""
Saves a process graph and its metadata in the backend as a user-defined process for the authenticated user.
:param user_defined_process_id: unique identifier for the user-defined process
:param process_graph: a process graph
:param parameters: a list of parameters
:param public: visible to other users?
:return: a RESTUserDefinedProcess instance
"""
if user_defined_process_id in set(p["id"] for p in self.list_processes()):
warnings.warn("Defining user-defined process {u!r} with same id as a pre-defined process".format(
u=user_defined_process_id))
udp = RESTUserDefinedProcess(user_defined_process_id=user_defined_process_id, connection=self)
udp.store(process_graph=process_graph, parameters=parameters, public=public)
return udp