`plynx.db.run_cancellation_manager`¶

Cancelation DB Object and utils

Module Contents¶

class plynx.db.run_cancellation_manager.RunCancellation[source]¶

Bases: plynx.db.db_object.DBObject

RunCancellation represents Run Cancellation event in the database.

DB_COLLECTION[source]¶

_id :ObjectId[source]¶

run_id :Optional[ObjectId][source]¶

class plynx.db.run_cancellation_manager.RunCancellationManager[source]¶

RunCancellationManager contains basic operations related to runs_cancellations collection.

run_id :ObjectId[source]¶

static cancel_run(run_id: ObjectId)[source]¶: Cancel Run. Args:

System Message: ERROR/3 (/home/docs/checkouts/readthedocs.org/user_builds/plynx/checkouts/latest/docs/_api/plynx/db/run_cancellation_manager/index.rst, line 51)
Unexpected indentation.

run_id (ObjectId) RunID

static get_run_cancellations()[source]¶: Get all Run Cancellation events

static remove(runs_cancellation_ids: List[ObjectId])[source]¶: Remove Run Cancellation events with given Ids Args:

System Message: ERROR/3 (/home/docs/checkouts/readthedocs.org/user_builds/plynx/checkouts/latest/docs/_api/plynx/db/run_cancellation_manager/index.rst, line 67)
Unexpected indentation.

runs_cancellation_ids (list of ObjectID) List of Run IDs to remove