<!-- Source: https://docs.squirro.com/en/latest/api/squirro_client.topic.PipelineStatusMixin.html -->
# PipelineStatusMixin

**`class PipelineStatusMixin`**

Bases: [`object`](https://docs.python.org/3.11/library/functions.html#object)

Methods SummaryMethods Documentation

**`get_pipeline_status(sections=None, source_ids=None, cluster_aware=None)`**

Returns all or the specified status sections of the ingester status.

Parameters

- `sections` – optional, list of sections to return.
- `source_ids` – optional, list of source ids to filter the response
- `cluster_aware` – optional, bool to determine whether to aggregate
  the pipeline status across all nodes in the Squirro cluster or not

Returns

A status dictionary.

**`get_projects_status()`**

Get number of batches, failed batches, and items that exist in Ingester’s queue, per project.

Returns

dict, projects status response

**`get_sources_status()`**

Get number of batches, failed batches, and items that exist in Ingester’s queue, per data source.

Returns

dict, sources status response

**`perform_pipeline_action(action, action_config=None)`**

Performs an ingester action.

Parameters

- `action` – string, action to perform
- `action_config` – optional dict, data to be passed to the action

Returns

A status dictionary.

Currently, only the action “reset” is supported. It does not take
any action_config and will delete the full ingester backlog.
