Skip to main content

Module job_api

Module job_api 

Source

Enums§

BatchReRunJobsError
struct for typed errors of method batch_re_run_jobs
CancelPersistentQueuedJobsError
struct for typed errors of method cancel_persistent_queued_jobs
CancelQueuedJobError
struct for typed errors of method cancel_queued_job
CancelSelectionError
struct for typed errors of method cancel_selection
CancelSuspendedJobGetError
struct for typed errors of method cancel_suspended_job_get
CancelSuspendedJobPostError
struct for typed errors of method cancel_suspended_job_post
CountCompletedJobsError
struct for typed errors of method count_completed_jobs
CountJobsByTagError
struct for typed errors of method count_jobs_by_tag
CreateJobSignatureError
struct for typed errors of method create_job_signature
DeleteCompletedJobError
struct for typed errors of method delete_completed_job
DeleteJobsError
struct for typed errors of method delete_jobs
ExportCompletedJobsError
struct for typed errors of method export_completed_jobs
ExportQueuedJobsError
struct for typed errors of method export_queued_jobs
ForceCancelQueuedJobError
struct for typed errors of method force_cancel_queued_job
GetApprovalInfoError
struct for typed errors of method get_approval_info
GetCompletedCountError
struct for typed errors of method get_completed_count
GetCompletedJobError
struct for typed errors of method get_completed_job
GetCompletedJobLogsTailError
struct for typed errors of method get_completed_job_logs_tail
GetCompletedJobResultError
struct for typed errors of method get_completed_job_result
GetCompletedJobResultMaybeError
struct for typed errors of method get_completed_job_result_maybe
GetCompletedJobTimingError
struct for typed errors of method get_completed_job_timing
GetDbClockError
struct for typed errors of method get_db_clock
GetDbtResumableError
struct for typed errors of method get_dbt_resumable
GetDbtResumableForScriptError
struct for typed errors of method get_dbt_resumable_for_script
GetDbtRunGraphError
struct for typed errors of method get_dbt_run_graph
GetFlowAllLogsError
struct for typed errors of method get_flow_all_logs
GetFlowAllLogsStructuredError
struct for typed errors of method get_flow_all_logs_structured
GetFlowAllResultsError
struct for typed errors of method get_flow_all_results
GetFlowDebugInfoError
struct for typed errors of method get_flow_debug_info
GetFlowUserStateError
struct for typed errors of method get_flow_user_state
GetJobArgsError
struct for typed errors of method get_job_args
GetJobError
struct for typed errors of method get_job
GetJobLogsError
struct for typed errors of method get_job_logs
GetJobOtelTracesError
struct for typed errors of method get_job_otel_traces
GetJobUpdatesError
struct for typed errors of method get_job_updates
GetJobUpdatesSseError
struct for typed errors of method get_job_updates_sse
GetJobViewTokenError
struct for typed errors of method get_job_view_token
GetLogFileFromStoreError
struct for typed errors of method get_log_file_from_store
GetQueueCountError
struct for typed errors of method get_queue_count
GetQueuePositionError
struct for typed errors of method get_queue_position
GetResumeUrlsError
struct for typed errors of method get_resume_urls
GetRootJobIdError
struct for typed errors of method get_root_job_id
GetRunProgressError
struct for typed errors of method get_run_progress
GetScheduledForError
struct for typed errors of method get_scheduled_for
GetSlackApprovalPayloadError
struct for typed errors of method get_slack_approval_payload
GetStartedAtByIdsError
struct for typed errors of method get_started_at_by_ids
GetSuspendedJobFlowError
struct for typed errors of method get_suspended_job_flow
GetTeamsApprovalPayloadError
struct for typed errors of method get_teams_approval_payload
GetWacApprovalUrlsError
struct for typed errors of method get_wac_approval_urls
ImportCompletedJobsError
struct for typed errors of method import_completed_jobs
ImportQueuedJobsError
struct for typed errors of method import_queued_jobs
ListAssetDispatchEdgesError
struct for typed errors of method list_asset_dispatch_edges
ListCompletedJobsError
struct for typed errors of method list_completed_jobs
ListDispatchEventsError
struct for typed errors of method list_dispatch_events
ListExtendedJobsError
struct for typed errors of method list_extended_jobs
ListFilteredJobsUuidsError
struct for typed errors of method list_filtered_jobs_uuids
ListFilteredQueueUuidsError
struct for typed errors of method list_filtered_queue_uuids
ListJobsError
struct for typed errors of method list_jobs
ListQueueError
struct for typed errors of method list_queue
ListSelectedJobGroupsError
struct for typed errors of method list_selected_job_groups
ResolveCompletedJobsError
struct for typed errors of method resolve_completed_jobs
RestartFlowAtStepError
struct for typed errors of method restart_flow_at_step
ResultByIdError
struct for typed errors of method result_by_id
ResumeSuspendedError
struct for typed errors of method resume_suspended
ResumeSuspendedFlowAsOwnerError
struct for typed errors of method resume_suspended_flow_as_owner
ResumeSuspendedJobGetError
struct for typed errors of method resume_suspended_job_get
ResumeSuspendedJobPostError
struct for typed errors of method resume_suspended_job_post
RunAndStreamFlowByPathError
struct for typed errors of method run_and_stream_flow_by_path
RunAndStreamFlowByPathGetError
struct for typed errors of method run_and_stream_flow_by_path_get
RunAndStreamFlowByVersionError
struct for typed errors of method run_and_stream_flow_by_version
RunAndStreamFlowByVersionGetError
struct for typed errors of method run_and_stream_flow_by_version_get
RunAndStreamScriptByHashError
struct for typed errors of method run_and_stream_script_by_hash
RunAndStreamScriptByHashGetError
struct for typed errors of method run_and_stream_script_by_hash_get
RunAndStreamScriptByPathError
struct for typed errors of method run_and_stream_script_by_path
RunAndStreamScriptByPathGetError
struct for typed errors of method run_and_stream_script_by_path_get
RunCodeWorkflowTaskError
struct for typed errors of method run_code_workflow_task
RunDynamicSelectError
struct for typed errors of method run_dynamic_select
RunFlowByPathError
struct for typed errors of method run_flow_by_path
RunFlowByVersionError
struct for typed errors of method run_flow_by_version
RunFlowDependenciesAsyncError
struct for typed errors of method run_flow_dependencies_async
RunFlowPreviewAndWaitResultError
struct for typed errors of method run_flow_preview_and_wait_result
RunFlowPreviewError
struct for typed errors of method run_flow_preview
RunRawScriptDependenciesAsyncError
struct for typed errors of method run_raw_script_dependencies_async
RunRawScriptDependenciesError
struct for typed errors of method run_raw_script_dependencies
RunScriptByHashError
struct for typed errors of method run_script_by_hash
RunScriptByHashInlineError
struct for typed errors of method run_script_by_hash_inline
RunScriptByPathError
struct for typed errors of method run_script_by_path
RunScriptByPathInlineError
struct for typed errors of method run_script_by_path_inline
RunScriptPreviewAndWaitResultError
struct for typed errors of method run_script_preview_and_wait_result
RunScriptPreviewError
struct for typed errors of method run_script_preview
RunScriptPreviewInlineError
struct for typed errors of method run_script_preview_inline
RunWaitResultFlowByPathError
struct for typed errors of method run_wait_result_flow_by_path
RunWaitResultFlowByVersionError
struct for typed errors of method run_wait_result_flow_by_version
RunWaitResultFlowByVersionGetError
struct for typed errors of method run_wait_result_flow_by_version_get
RunWaitResultScriptByPathError
struct for typed errors of method run_wait_result_script_by_path
RunWaitResultScriptByPathGetError
struct for typed errors of method run_wait_result_script_by_path_get
SetFlowUserStateError
struct for typed errors of method set_flow_user_state
UnresolveCompletedJobsError
struct for typed errors of method unresolve_completed_jobs

Functions§

batch_re_run_jobs
cancel_persistent_queued_jobs
cancel_queued_job
cancel_selection
cancel_suspended_job_get
cancel_suspended_job_post
count_completed_jobs
count_jobs_by_tag
create_job_signature
delete_completed_job
delete_jobs
export_completed_jobs
export_queued_jobs
force_cancel_queued_job
get_approval_info
Get approval info for a suspended flow/WAC job. Returns form schema, approval rules, and whether the current user can approve. Either a valid token query parameter or an authenticated session is required.
get_completed_count
get_completed_job
get_completed_job_logs_tail
get_completed_job_result
get_completed_job_result_maybe
get_completed_job_timing
get_db_clock
get_dbt_resumable
One failed run is saved per script per execution principal, so a retry resumes that one — not necessarily the run being looked at. Answers about THIS run alone: its own id when a retry submitted by this caller would resume it, null otherwise (a later run holds the state, the run left nothing to rebuild, or the caller’s runs execute as another principal). Authorized through the job, like run_progress.
get_dbt_resumable_for_script
A retry requires dbt_retry_job, and the run form has no job id to hand. Returns the one the caller’s own retry would land on — the saved failure for the principal the run would execute as, which is the script’s author for an on_behalf_of script and the caller otherwise — and only when that run is one the caller may read. Null when there is nothing to resume, or nothing this caller may be told about.
get_dbt_run_graph
The workspace asset graph with its dbt half pinned to what a single run built. Only a dynamic descriptor (a {{ }} placeholder in vars) leaves a per-run snapshot; without one for this job the pinned version’s own graph answers, so a run page may use this route unconditionally. Authorized through the job, the same gate as run_progress — pinning to a run is job-scoped, which is why assets/graph cannot do it.
get_flow_all_logs
get_flow_all_logs_structured
get_flow_all_results
get_flow_debug_info
get_flow_user_state
get_job
get_job_args
get_job_logs
get_job_otel_traces
get_job_updates
get_job_updates_sse
get_job_view_token
Returns a stateless {job_id}.{hmac} token that grants an authenticated workspace member read access to this job (and its flow subtree) via a view_token query param or X-View-Token header. Only callable by a user who can already read the job.
get_log_file_from_store
get_queue_count
get_queue_position
get_resume_urls
get_root_job_id
get_run_progress
Live materialization state for the relations a single job writes, keyed by relation. Polled while a run is in flight so a graph can move a node as its model completes. Authorized through the job, so a caller who may not read it is refused rather than told the run has no progress. An empty list means the job exists and has recorded nothing yet, or is unknown to this workspace.
get_scheduled_for
get_slack_approval_payload
get_started_at_by_ids
get_suspended_job_flow
get_teams_approval_payload
get_wac_approval_urls
import_completed_jobs
import_queued_jobs
list_asset_dispatch_edges
Returns the dispatched asset-trigger edges (producer job → child job) whose subscriber lives under path_start. Lets a pipeline view reconstruct the cascade tree of a folder by job id and group connected runs. Visibility follows the producer job’s RLS.
list_completed_jobs
list_dispatch_events
Returns the chronological log of decisions the asset-trigger dispatcher made after this producer job completed. Each row is one (subscriber, asset write) decision: dispatched (with child_job_id), join_pending (with received_inputs / required_inputs / partition), or skipped (with reason). Rows are reaped automatically when the producer’s v2_job row is deleted by the retention sweep.
list_extended_jobs
list_filtered_jobs_uuids
list_filtered_queue_uuids
list_jobs
list_queue
list_selected_job_groups
resolve_completed_jobs
Marks failed jobs as handled so triage surfaces stop showing them as failures. The job status itself is unchanged. Returns the ids actually resolved: ids that are not visible to the caller or did not fail are silently skipped.
restart_flow_at_step
result_by_id
resume_suspended
Resume or cancel a suspended flow/WAC job. Uses approval rules to determine authorization. Either a valid approval_token or an authenticated session is required.
resume_suspended_flow_as_owner
resume_suspended_job_get
resume_suspended_job_post
run_and_stream_flow_by_path
run_and_stream_flow_by_path_get
run_and_stream_flow_by_version
run_and_stream_flow_by_version_get
run_and_stream_script_by_hash
run_and_stream_script_by_hash_get
run_and_stream_script_by_path
run_and_stream_script_by_path_get
run_code_workflow_task
run_dynamic_select
run_flow_by_path
run_flow_by_version
run_flow_dependencies_async
run_flow_preview
run_flow_preview_and_wait_result
run_raw_script_dependencies
run_raw_script_dependencies_async
run_script_by_hash
run_script_by_hash_inline
run_script_by_path
run_script_by_path_inline
run_script_preview
run_script_preview_and_wait_result
run_script_preview_inline
run_wait_result_flow_by_path
run_wait_result_flow_by_version
run_wait_result_flow_by_version_get
run_wait_result_script_by_path
run_wait_result_script_by_path_get
set_flow_user_state
unresolve_completed_jobs