taskgraphs.registration

cloud.taskgraphs.registration

Functions

Name	Description
delete	Deletes the given task graph.
load	Retrieves the given task graph from the server.
register	Registers the graph constructed by the TaskGraphBuilder.
update	Updates the registered task graph at the given location.

delete

cloud.taskgraphs.registration.delete(name_or_nsname, *, namespace=None)

Deletes the given task graph.

This deregisters the graph and also removes the graph array from storage.

Parameters

Name	Type	Description	Default
name_or_nsname	str	The graph’s identifier, either in the form namespace/name, or just name to use the namespace param.	required
namespace	Optional[str]	If set, the namespace of the graph. If name_or_nsname is of the form namespace/name, must be None. If name_or_nsname is just a name and this is None, will use the current user’s namespace.	None

load

cloud.taskgraphs.registration.load(name_or_nsname, *, namespace=None)

Retrieves the given task graph from the server.

Parameters

Name	Type	Description	Default
name_or_nsname	str	The graph’s identifier, either in the form namespace/name, or just name to use the namespace param.	required
namespace	Optional[str]	If set, the namespace of the graph. If name_or_nsname is of the form namespace/name, must be None. If name_or_nsname is just a name and this is None, will use the current user’s namespace.	None

register

cloud.taskgraphs.registration.register(graph, name=None, *, namespace=None)

Registers the graph constructed by the TaskGraphBuilder.

Parameters

Name	Type	Description	Default
graph	builder.TaskGraphBuilder	The graph to register.	required
name	Optional[str]	The name to register the graph with. By default, will use the name specified in graph. This must be a bare name, with no namespace (i.e. my-graph, not me/my-graph).	None
namespace	Optional[str]	The namespace, if not your own, to register the graph in.	None

update

cloud.taskgraphs.registration.update(graph, old_name=None, *, namespace=None)

Updates the registered task graph at the given location.

Parameters

Name	Type	Description	Default
graph	builder.TaskGraphBuilder	The new graph to replace the old value.	required
old_name	Optional[str]	The name of the graph to rename from, if present. If graph is to be renamed, the new name of the graph must appear in graph.name.	None
namespace	Optional[str]	The namespace, if not your own, where the graph will be updated.	None