organization_jobs_api

edgeimpulse_api v1.0.0

edgeimpulse_api.api.organization_jobs_api module

class edgeimpulse_api.api.organization_jobs_api.OrganizationJobsApi(api_client=None)

Bases: object

cancel_organization_job(organization_id: StrictInt, job_id: StrictInt, force_cancel: Optional[StrictStr] = None, **kwargs)

Cancel job

Cancel a running job.

• Parameters

  • organization_id (int) – Organization ID (required)

  • job_id (int) – Job ID (required)

  • force_cancel (str) – If set to ‘true’, we won’t wait for the job cluster to cancel the job, and will mark the job as finished.

  • 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

download_organization_jobs_logs(organization_id: StrictInt, job_id: StrictInt, limit: Optional[StrictInt] = None, log_level: Optional[StrictStr] = None, **kwargs)

Download logs

Download the logs for a job (as a text file).

• Parameters

  • organization_id (int) – Organization ID (required)

  • job_id (int) – Job ID (required)

  • limit (int) – Maximum number of results

  • log_level (str) – Log level (error, warn, info, debug)

  • 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

  str

get_organization_job_status(organization_id: StrictInt, job_id: StrictInt, **kwargs)

Get job status

Get the status for a job.

• Parameters

  • organization_id (int) – Organization ID (required)

  • job_id (int) – Job ID (required)

  • 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

  GetJobResponse

get_organization_jobs_logs(organization_id: StrictInt, job_id: StrictInt, limit: Optional[StrictInt] = None, log_level: Optional[StrictStr] = None, **kwargs)

Get logs

Get the logs for a job.

• Parameters

  • organization_id (int) – Organization ID (required)

  • job_id (int) – Job ID (required)

  • limit (int) – Maximum number of results

  • log_level (str) – Log level (error, warn, info, debug)

  • 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

  LogStdoutResponse

get_organization_socket_token(organization_id: StrictInt, **kwargs)

Get socket token for an organization

Get a token to authenticate with the web socket interface.

• Parameters

  • organization_id (int) – Organization ID (required)

  • 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

  SocketTokenResponse

list_active_organization_jobs(organization_id: StrictInt, root_only: Optional[StrictBool] = None, **kwargs)

List active jobs

Get all active jobs for this organization

• Parameters

  • organization_id (int) – Organization ID (required)

  • root_only (bool) – Whether to exclude jobs with a parent ID (so jobs started as part of another job)

  • 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

  ListJobsResponse

list_all_organization_jobs(organization_id: StrictInt, start_date: Optional[datetime] = None, end_date: Optional[datetime] = None, limit: Optional[StrictInt] = None, offset: Optional[StrictInt] = None, exclude_pipeline_transform_jobs: Optional[StrictBool] = None, root_only: Optional[StrictBool] = None, **kwargs)

List all jobs

Get all jobs for this organization

• Parameters

  • organization_id (int) – Organization ID (required)

  • start_date (datetime) – Start date

  • end_date (datetime) – End date

  • limit (int) – Maximum number of results

  • offset (int) – Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.

  • exclude_pipeline_transform_jobs (bool) – Whether to exclude pipeline / transformation jobs

  • root_only (bool) – Whether to exclude jobs with a parent ID (so jobs started as part of another job)

  • 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

  ListJobsResponse

list_finished_organization_jobs(organization_id: StrictInt, start_date: Optional[datetime] = None, end_date: Optional[datetime] = None, limit: Optional[StrictInt] = None, offset: Optional[StrictInt] = None, root_only: Optional[StrictBool] = None, **kwargs)

List finished jobs

Get all finished jobs for this organization

• Parameters

  • organization_id (int) – Organization ID (required)

  • start_date (datetime) – Start date

  • end_date (datetime) – End date

  • limit (int) – Maximum number of results

  • offset (int) – Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.

  • root_only (bool) – Whether to exclude jobs with a parent ID (so jobs started as part of another job)

  • 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

  ListJobsResponse