pip_services3_components.connect.IDiscovery module

pip_services3_components.connect.IDicovery

Discovery service interface

copyright

Conceptual Vision Consulting LLC 2018-2019, see AUTHORS for more details.

license

MIT, see LICENSE for more details.

class pip_services3_components.connect.IDiscovery.IDiscovery

Bases: abc.ABC

Interface for discovery services which are used to store and resolve connection parameters to connect to external services.

register(correlation_id: Optional[str], key: str, connection: pip_services3_components.connect.ConnectionParams.ConnectionParams) → pip_services3_components.connect.ConnectionParams.ConnectionParams

Registers connection parameters into the discovery service.

Parameters

  • correlation_id – (optional) transaction id to trace execution through call chain.

  • key – a key to uniquely identify the connection parameters.

  • connection – a connection to be registered.

Returns

the registered connection parameters.

resolve_all(correlation_id: Optional[str], key: str) → List[pip_services3_components.connect.ConnectionParams.ConnectionParams]

Resolves all connection parameters by their key.

Parameters

  • correlation_id – (optional) transaction id to trace execution through call chain.

  • key – a key to uniquely identify the connections.

Returns

a list with resolved connections.

resolve_one(correlation_id: Optional[str], key: str) → pip_services3_components.connect.ConnectionParams.ConnectionParams

Resolves a single connection parameters by its key.

Parameters

  • correlation_id – (optional) transaction id to trace execution through call chain.

  • key – a key to uniquely identify the connection.

Returns

a resolved connection.