get_instance#

Client.get_instance(name: str, timeout: Optional[float] = None) Instance#

Get a remote product instance by name.

Parameters:
name: str

Name of the instance to get. This name is assigned by the server and always start with instances/. You should not rely on any static value. For example, the name assigned to the instance might be instances/mapdl-a25g813.

timeoutfloat, optional

Maximum time in seconds for the request. The default is None.

Returns:
Instance

A remote instance.

Raises:
InstanceNotFoundError

The instance does not exist.