yr.get_instance

Contents

yr.get_instance#

yr.get_instance(name: str, namespace: str = '', timeout: int = 60) → InstanceProxy[source]#

Get an instance handle based on the name and namespace of the named instance. The interface call will block until the instance handle is obtained or a timeout occurs.

Parameters:

  • name (str) – The name of the instance (instance ID).

  • namespace (str) – The namespace.

  • timeout (int) – The timeout in seconds.

Returns:

A Python named instance handle. Data type is StatefulInstance.

Raises:

  • TypeError – If the parameter types are incorrect.

  • RuntimeError – If the instance does not exist.

  • TimeoutError – If a timeout occurs.

Examples

>>> yr.get_instance("name")
Contents