Skip to main content

AppStatus

Lifecycle status of the Kube app backing a run (OpenAPI AppStatus).

Values

AppStatus
'DEPLOY_FAILED'
AppStatus
'DEPLOYED'
AppStatus
'DEPLOYING'
AppStatus
'DESTROY_FAILED'
AppStatus
'DESTROY_REQUESTED'
AppStatus
'DESTROYED'
AppStatus
'DESTROYING'
AppStatus
'INIT_FAILED'
AppStatus
'INITIALIZING'
AppStatus
'PENDING'
AppStatus
'PREPARE_FAILED'
AppStatus
'PREPARING'
AppStatus
'READY'
AppStatus
'REQUESTED'

AppType

Kube app types attached to a run (OpenAPI AppType).

Values

AppType
'JUPYTER'
AppType
'RUN'
AppType
'SQL_SESSION'

DependencyFileType

File types for FILE dependencies (from OpenAPI DependencyFileType).

Values

DependencyFileType
'JAR'
DependencyFileType
'OTHER'
DependencyFileType
'PYTHON_WHEEL'
DependencyFileType
'ZIP'

DependencyType

Dependency source types (OpenAPI DependencySourceType).

Values

DependencyType
'FILE'
DependencyType
'PYPI'

Drive

Files drives a caller can address through Wherobots().files. MY_FILES is the caller’s personal file area in one region. A shared drive would be a new member here plus one branch in the drive resolver.

Values

Drive
'my_files'

is_terminal_status

Return True if status is a known terminal state. Accepts a JobStatus, a raw string (e.g. an API-added status the SDK doesn’t yet know about), or None. Unknown strings are treated as non-terminal — conservative so callers keep polling rather than bailing early on a new running/transitional state.

Parameters

JobStatus | str | None
required

JobStatus

Job run status values (from OpenAPI RunStatus).

Values

JobStatus
'CANCELLED'
JobStatus
'COMPLETED'
JobStatus
'FAILED'
JobStatus
'PENDING'
JobStatus
'RUNNING'

is_terminal

Return True if this status represents a finished run.

Region

Known AWS regions for Wherobots deployments. Region is a free-form string in the Wherobots API — this enum lists regions that exist today for convenience, but the API may add new regions at any time. SDK call sites that accept a region (e.g. WherobotsJob(region=...)) always accept a plain string as well, so unknown regions are never blocked client-side.

Values

Region
'aws-ap-south-1'
Region
'aws-eu-west-1'
Region
'aws-us-east-1'
Region
'aws-us-west-2'

Runtime

Available Wherobots compute runtime sizes. The values match the lowercase RuntimeId strings accepted by the API. This enum is a convenience subset — the API also accepts legacy uppercase values (TINY, SMALL, MEDIUM, LARGE, XLARGE, XXLARGE) and may add new runtimes at any time. Where the SDK accepts a runtime argument (e.g. WherobotsJob(runtime=...)) it also accepts a plain string, so unknown runtimes are never blocked client-side.

Values

Runtime
'2x-large'
Runtime
'2x-large-hicpu'
Runtime
'2x-large-himem'
Runtime
'2x-large-matcher'
Runtime
'large'
Runtime
'large-himem'
Runtime
'medium'
Runtime
'medium-himem'
Runtime
'micro'
Runtime
'4x-large'
Runtime
'4x-large-himem'
Runtime
'small'
Runtime
'tiny'
Runtime
'x-large'
Runtime
'x-large-hicpu'
Runtime
'x-large-himem'
Runtime
'x-large-matcher'

TaskRunState

Task run states (OpenAPI TaskRunState).

Values

TaskRunState
'CANCELLED'
TaskRunState
'CANCELLING'
TaskRunState
'FAILED'
TaskRunState
'MISSED'
TaskRunState
'PENDING'
TaskRunState
'REJECTED'
TaskRunState
'RUNNING'
TaskRunState
'SKIPPED'
TaskRunState
'SUBMITTED'
TaskRunState
'SUCCEEDED'
TaskRunState
'TIMED_OUT'
TaskRunState
'UNKNOWN'

is_active

Return True while the run may still change state.