qhana_plugin_runner.registry_client.types module

class qhana_plugin_runner.registry_client.types.ApiLink

Bases: dict

doc: str

href: str

name: str

rel: Sequence[str]

resourceKey: Dict[str, str]

resourceType: str

schema: str

class qhana_plugin_runner.registry_client.types.ApiLinkBase

Bases: TypedDict

href: str

rel: Sequence[str]

resourceType: str

class qhana_plugin_runner.registry_client.types.ApiObject

Bases: dict

self: ApiLink

class qhana_plugin_runner.registry_client.types.ApiResponse(data: ApiObject, links: Sequence[ApiLink], keyed_links: Sequence[KeyedApiLink] = (), embedded: 'Optional[Dict[str, ApiResponse]]' = None)

Bases: object

data: ApiObject

embedded: Dict[str, ApiResponse] | None = None

get_links_by_rel(rel: str | Sequence[str], resource_type: str | None = None)

is_collection_resource() → bool

keyed_links: Sequence[KeyedApiLink] = ()

links: Sequence[ApiLink]

matches_rel(rel: str | Sequence[str], resource_type: str | None = None) → bool

property self: str

class qhana_plugin_runner.registry_client.types.BaseApiObject

Bases: TypedDict

self: ApiLink

class qhana_plugin_runner.registry_client.types.KeyedApiLink

Bases: dict

doc: str

href: str

key: Sequence[str]

name: str

queryKey: Sequence[str]

rel: Sequence[str]

resourceKey: Dict[str, str]

resourceType: str

schema: str

qhana_plugin_runner.registry_client.types.match_api_link(link: ApiLink, rel: Set[str], resource_type: str | None = None)