Skip to main content

AppStatus

Lifecycle state of a run’s Kubernetes application.

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

Kind of application behind a run.

Values

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

BatchKind

What a scheduled run’s batchTime marks: a scheduled time, or a pause or schedule edit.

Values

BatchKind
'gap'
BatchKind
'tick'

DataFormat

Format of a metric’s data points.

Values

DataFormat
'BYTES'
DataFormat
'CURRENCY'
DataFormat
'NUMBER'
DataFormat
'PERCENTAGE'

DependencyFileType

File type of a file dependency.

Values

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

DependencyType

Where a dependency comes from.

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'

FailureClass

Why a run did not succeed.

Values

FailureClass
'CONFIG_REJECTED'
FailureClass
'PLATFORM'
FailureClass
'QUOTA_REJECTED'
FailureClass
'TIMEOUT'
FailureClass
'USER_CODE'

FileEntryType

Whether a listing entry is a file or a folder.

Values

FileEntryType
'FILE'
FileEntryType
'FOLDER'

is_terminal_status

Return True if status is a known terminal state. Accepts a JobStatus, a raw string, or None. An unknown value is treated as non-terminal, so callers keep polling rather than stop early on a new transitional state. RunView.is_terminal also knows the server’s own answer.

Parameters

str | None
required

JobStatus

Status of a job run.

Values

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

is_terminal

Return True if this status represents a finished run.

NoComputeReason

Why a run finished without running.

Values

NoComputeReason
'cancelled'
NoComputeReason
'epoch_gap'
NoComputeReason
'inputs_rejected'
NoComputeReason
'missed'
NoComputeReason
'overlap'

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'

RunSource

What started a run: a person, a schedule, or a rerun.

Values

RunSource
'manual'
RunSource
'rerun'
RunSource
'schedule'

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'

StorageSourceType

Kind of storage source.

Values

StorageSourceType
'INTEGRATION'
StorageSourceType
'MANAGED'
StorageSourceType
'USER_FILES'

TaskKind

How a task runs: as a Union workflow or as a script.

Values

TaskKind
'scripttask'
TaskKind
'uniontask'

TaskRunState

State of a task run.

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.

is_finished

Return True once the run has reached a state it will not leave. UNKNOWN and a state this SDK predates are neither active nor finished, so waiting on them keeps polling rather than stopping early.

WorkloadMetric

Metric names reported for a run’s workload.

Values

WorkloadMetric
'CONSUMED_SPATIAL_UNITS'
WorkloadMetric
'COST_USD'
WorkloadMetric
'CPU_UTILIZATION_PERCENT'
WorkloadMetric
'GPU_MEMORY_UTILIZATION_PERCENT'
WorkloadMetric
'GPU_UTILIZATION_PERCENT'
WorkloadMetric
'MEMORY_UTILIZATION_PERCENT'