health_api

edgeimpulse_api v1.0.0

edgeimpulse_api.api.health_api module

class edgeimpulse_api.api.health_api.HealthApi(api_client=None)

Bases: object

api_health(requester: Optional[StrictStr] = None, **kwargs)

Get studio api containers health

Get studio api containers health.

• Parameters

  • requester (str) – Health check requester

  • async_req (bool*, *optional) – Whether to execute the request asynchronously.

  • _preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• Returns

  Returns the result object. If the method is called asynchronously, returns the request thread.

• Return type

  GenericApiResponse

health(requester: Optional[StrictStr] = None, **kwargs)

Get studio web containers health

Get studio web containers health.

• Parameters

  • requester (str) – Health check requester

  • async_req (bool*, *optional) – Whether to execute the request asynchronously.

  • _preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• Returns

  Returns the result object. If the method is called asynchronously, returns the request thread.

• Return type

  GenericApiResponse