Skip to content

Status module

Reference to the status.py module.

status

Provides status enums for Nextmv application runs.

This module defines enumerations for representing the status of a run in a Nextmv application.

CLASS DESCRIPTION
StatusV2

Represents the status of a run.

StatusV2

Bases: str, Enum

Status of a run.

You can import the StatusV2 class directly from nextmv:

from nextmv import StatusV2

This enum represents the comprehensive set of possible states for a run in Nextmv.

ATTRIBUTE DESCRIPTION
canceled

Run was canceled.

TYPE: str

failed

Run failed.

TYPE: str

none

Run has no status.

TYPE: str

queued

Run is queued.

TYPE: str

running

Run is running.

TYPE: str

succeeded

Run succeeded.

TYPE: str

Examples:

>>> from nextmv.cloud import StatusV2
>>> run_status = StatusV2.queued
>>> print(f"The run status is: {run_status.value}")
The run status is: queued
>>> if run_status == StatusV2.succeeded:
...     print("Processing complete.")
... elif run_status in [StatusV2.queued, StatusV2.running]:
...     print("Processing in progress.")
... else:
...     print("Processing has not started or has ended with issues.")
Processing in progress.

canceled class-attribute instance-attribute

canceled = 'canceled'

Run was canceled.

failed class-attribute instance-attribute

failed = 'failed'

Run failed.

none class-attribute instance-attribute

none = 'none'

Run has no status.

queued class-attribute instance-attribute

queued = 'queued'

Run is queued.

running class-attribute instance-attribute

running = 'running'

Run is running.

succeeded class-attribute instance-attribute

succeeded = 'succeeded'

Run succeeded.