Skip to main content

Link

This class defines a protocol for creating dynamic links within the system. It specifies a contract for generating task log links based on various contextual parameters, allowing for templated URLs that are resolved by the backend.

Attributes

AttributeTypeDescription
namestrThe name of the link, used as a display label.
icon_uriOptional[str] = ""An optional URI for an icon associated with the link, which can be displayed alongside the link name.

Methods


@classmethod
def get_link(
run_name: str,
project: str,
domain: str,
context: Dict[str, str],
parent_action_name: str,
action_name: str,
pod_name: str,
kwargs: Any
) - > str

Returns a task log link given the action. Link can have template variables that are replaced by the backend.

Parameters

NameTypeDescription
run_namestrThe name of the run.
projectstrThe project name.
domainstrThe domain name.
contextDict[str, str]Additional context for generating the link.
parent_action_namestrThe name of the parent action.
action_namestrThe name of the action.
pod_namestrThe name of the pod.
kwargsAnyAdditional keyword arguments.

Returns

TypeDescription
strThe generated link.