Status Module¶
This section documents the status components of the Nextmv Cloud API.
Provides status enums for Nextmv Cloud runs.
This module defines enumerations for representing the status of a run in
Nextmv Cloud. It includes a deprecated Status enum and the current StatusV2
enum.
| CLASS | DESCRIPTION |
|---|---|
Status |
Deprecated status of a run. |
StatusV2 |
Represents the status of a run. |
Bases: str, Enum
Warning
Status is deprecated, use StatusV2 instead.
Status of a run.
You can import the Status class directly from cloud:
This enum represents the possible states of a run. It is deprecated and
StatusV2 should be used for new implementations.
| ATTRIBUTE | DESCRIPTION |
|---|---|
failed |
Run failed.
TYPE:
|
running |
Run is running.
TYPE:
|
succeeded |
Run succeeded.
TYPE:
|
Examples:
>>> from nextmv.cloud import Status
>>> current_status = Status.running
>>> if current_status == Status.succeeded:
... print("Run completed successfully.")
... elif current_status == Status.failed:
... print("Run failed.")
... else:
... print(f"Run is currently {current_status.value}.")
Run is currently running.
Bases: str, Enum
Status of a run.
You can import the StatusV2 class directly from cloud:
This enum represents the comprehensive set of possible states for a run in Nextmv Cloud.
| ATTRIBUTE | DESCRIPTION |
|---|---|
canceled |
Run was canceled.
TYPE:
|
failed |
Run failed.
TYPE:
|
none |
Run has no status.
TYPE:
|
queued |
Run is queued.
TYPE:
|
running |
Run is running.
TYPE:
|
succeeded |
Run succeeded.
TYPE:
|
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.