organization_pipelines_api module#

class edgeimpulse_api.api.organization_pipelines_api.OrganizationPipelinesApi(api_client=None)[source]#

Bases: object

create_organization_pipeline(
organization_id: StrictInt[StrictInt],
organization_update_pipeline_body: OrganizationUpdatePipelineBody,
**kwargs,
) → CreatePipelineResponse[source]#

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[StrictInt],
pipeline_id: StrictInt[StrictInt],
**kwargs,
) → GenericApiResponse[source]#

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[StrictInt],
pipeline_id: StrictInt[StrictInt],
**kwargs,
) → GetOrganizationPipelinesResponse[source]#

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[StrictInt],
project_id: StrictInt | None[StrictInt | None] = None,
**kwargs,
) → ListOrganizationPipelinesResponse[source]#

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[StrictInt],
project_id: StrictInt | None[StrictInt | None] = None,
**kwargs,
) → ListOrganizationPipelinesResponse[source]#

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[StrictInt],
pipeline_id: StrictInt[StrictInt],
ignore_last_successful_run: StrictBool | None[StrictBool | None] = None,
**kwargs,
) → RunOrganizationPipelineResponse[source]#

Run pipeline

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

stop_organization_pipeline(
organization_id: StrictInt[StrictInt],
pipeline_id: StrictInt[StrictInt],
**kwargs,
) → GenericApiResponse[source]#

Stop a running pipeline

Stops the pipeline, and marks it as failed.

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

update_organization_pipeline(
organization_id: StrictInt[StrictInt],
pipeline_id: StrictInt[StrictInt],
organization_update_pipeline_body: OrganizationUpdatePipelineBody,
**kwargs,
) → GenericApiResponse[source]#

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