Skip to main content

Link

This class defines a protocol for generating task log links based on specific execution metadata such as run, project, and action names. It provides a standardized interface for retrieving URIs that can include template variables for backend replacement. Implementations must provide the logic for constructing these links using the provided context and identifiers.

Attributes

AttributeTypeDescription
namestrThe display name of the link used for identification and labeling in the user interface.
icon_uriOptional[str] = ""The URI pointing to an icon image associated with the link, defaulting to an empty string if no icon is specified.

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 unique identifier for the specific execution run
projectstrThe name of the project associated with the task
domainstrThe domain name under which the task is categorized
contextDict[str, str]A dictionary of additional key-value pairs used to provide context for link generation
parent_action_namestrThe name of the parent action in the execution hierarchy
action_namestrThe name of the specific action for which the link is being generated
pod_namestrThe name of the Kubernetes pod where the task execution occurred
**kwargsAnyAdditional keyword arguments for extensibility and custom link parameters

Returns

TypeDescription
strThe generated link string, potentially containing template variables for backend replacement