Note

This is a public alpha release, and therefore features and functionality may change and the software and documentation may contain technical bugs or other issues. If you discover any issues please consider registering a GitHub issue.

datasources.connectors.entity module

This module contains connectors for receiving data via Cisco’s Entity API.

class datasources.connectors.entity.CiscoEntityConnector(location: str, api_key: Union[str, NoneType] = None, auth: Union[Callable, NoneType] = None, metadata: Union[Mapping[KT, VT_co], NoneType] = None)

Bases: datasources.connectors.base.DataCatalogueConnector

Data connector for retrieving data or metadata from Cisco’s Entity API.

dataset_connector_class

alias of datasources.connectors.base.DataSetConnector

get_datasets(params: Union[Mapping[str, str], NoneType] = None) → List[str]

Get the list of datasets provided by this catalogue.

Parameters:params – Query parameters to pass to data source API Returns:List of datasets provided by this catalogue

get_metadata(params: Union[Mapping[str, str], NoneType] = None)

Get metadata from this source using the appropriate API.

Parameters:params – Optional query parameter filters Returns:Requested metadata

items(params=None) → ItemsView[KT, VT_co]

Get key-value pairs of dataset ID to dataset connector for datasets contained within this catalogue.

Parameters:params – Query parameters to be passed through to the data source API Returns:Dictionary ItemsView over datasets