genvid.toolbox.LinksAPI

class genvid.toolbox.LinksAPI(parent_api: BaseHttpApiTool, **kwargs)

Bases: BaseHttpApiTool

The links api. See Bastion API and Cluster API

New in version 1.15.0.

NAME = 'links-api'

The name of the logger for this tool. Must be redefined in children.

get_base_url(timeout=0.0) → str

Get the base URL.

get_links(id, category, timeout=0.0)

Get the links.

Get the URI links to the multiple applications by category. Current categories are global, monitor and project.

Parameters:

• name –

• category – Filter the results by category

New in version 1.15.0.

get_link_definitions(timeout=0.0) → dict

Get the list of all link definitions.

Parameters:

timeout – The timeout in seconds.

New in version 1.15.0.

get_link_definition(link_id: str, timeout=0.0) → dict

Get a link definitions.

Parameters:

• link_id – The link ID.

• timeout – The timeout in seconds.

New in version 1.15.0.

add_link_definition(link_id: str, link: dict, timeout=0.0) → dict

Create a link definitions.

Parameters:

• link_id – The job ID.

• link – The link definition.

• timeout – The timeout in seconds.

New in version 1.15.0.

add_link_definitions(linkdefs: dict, timeout=0.0) → dict

Create a link definitions.

Parameters:

• link_id – The job ID.

• link – The link definition.

• timeout – The timeout in seconds.

New in version 1.45.0.

delete_link_definitions(timeout=0.0) → dict

Delete all link definitions.

Parameters:

timeout – The timeout in seconds.

New in version 1.15.0.

delete_link_definition(link_id: str, timeout=0.0) → dict

Delete a link definitions.

Parameters:

• link_id – The link ID.

• timeout – The timeout in seconds.

New in version 1.15.0.

class api_links.LinksAPI

Implementation of genvid.toolbox.LinksAPI