organization_pipelines_api

edgeimpulse_api v1.0.0

edgeimpulse_api.api.organization_pipelines_api module

class edgeimpulse_api.api.organization_pipelines_api.OrganizationPipelinesApi(api_client=None)

Bases: object

create_organization_pipeline(organization_id: StrictInt, organization_update_pipeline_body: OrganizationUpdatePipelineBody, **kwargs)

Create pipeline

Create an organizational pipelines

• Parameters

  • organization_id (int) – Organization ID (required)

  • organization_update_pipeline_body (OrganizationUpdatePipelineBody) – (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

  CreatePipelineResponse

delete_organization_pipeline(organization_id: StrictInt, pipeline_id: StrictInt, **kwargs)

Delete pipeline

Delete an organizational pipelines

• Parameters

  • organization_id (int) – Organization ID (required)

  • pipeline_id (int) – Pipeline 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

  GenericApiResponse

get_organization_pipeline(organization_id: StrictInt, pipeline_id: StrictInt, **kwargs)

Get pipeline

Retrieve an organizational pipelines

• Parameters

  • organization_id (int) – Organization ID (required)

  • pipeline_id (int) – Pipeline 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

  GetOrganizationPipelinesResponse

list_archived_organization_pipelines(organization_id: StrictInt, project_id: Optional[StrictInt] = None, **kwargs)

List archived pipelines

Retrieve all archived organizational pipelines

• Parameters

  • organization_id (int) – Organization ID (required)

  • project_id (int) – If set, filters on pipelines which are attached to this project.

  • 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

  ListOrganizationPipelinesResponse

list_organization_pipelines(organization_id: StrictInt, project_id: Optional[StrictInt] = None, **kwargs)

List pipelines

Retrieve all organizational pipelines

• Parameters

  • organization_id (int) – Organization ID (required)

  • project_id (int) – If set, filters on pipelines which are attached to this project.

  • 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

  ListOrganizationPipelinesResponse

run_organization_pipeline(organization_id: StrictInt, pipeline_id: StrictInt, ignore_last_successful_run: Optional[StrictBool] = None, **kwargs)

Run pipelines

Run an organizational pipeline

• Parameters

  • organization_id (int) – Organization ID (required)

  • pipeline_id (int) – Pipeline ID (required)

  • ignore_last_successful_run (bool) – If set then EI_LAST_SUCCESSFUL_RUN is not set. You can use this to re-run a pipeline from scratch.

  • 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

  RunOrganizationPipelineResponse

update_organization_pipeline(organization_id: StrictInt, pipeline_id: StrictInt, organization_update_pipeline_body: OrganizationUpdatePipelineBody, **kwargs)

Update pipeline

Update an organizational pipelines

• Parameters

  • organization_id (int) – Organization ID (required)

  • pipeline_id (int) – Pipeline ID (required)

  • organization_update_pipeline_body (OrganizationUpdatePipelineBody) – (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

  GenericApiResponse