# Flow Run
prefect.backend.flow_run.FlowRunView(flow_run_id, name, flow_id, labels, parameters, context, state, states, updated_at, run_config, task_runs=None)[source]
A view of Flow Run data stored in the Prefect API.
Provides lazy loading of Task Runs from the flow run.
This object is designed to be an immutable view of the data stored in the Prefect backend API at the time it is created. However, each time a task run is retrieved the latest data for that task will be pulled since they are loaded lazily. Finished task runs will be cached in this object to reduce the amount of network IO.
flow_run_id: The uuid of the flow run
name: The name of the flow run
flow_id: The uuid of the flow this run is associated with
state: The state of the flow run
labels: The labels assigned to this flow run
parameters: Parameter overrides for this flow run
context: Context overrides for this flow run
updated_at: When this flow run was last updated in the backend
RunConfigthis flow run was configured with
states: A sorted list of past states the flow run has been in
task_runs: An iterable of task run metadata to cache in this view
prefect.backend.flow_run.FlowRunView.from_flow_run_id(flow_run_id, load_static_tasks=False, _cached_task_runs=None)[source]
Get an instance of this class filled with information by querying for the given flow run id
Get all task runs for this flow run in a single query. Finished task run data is cached so future lookups do not query the backend.
Flow metadata for the flow associated with this flow run. Retrieved from the API on first call then cached for future calls.
Get the a new copy of this object with the latest data from the API. Cached
Get logs for this flow run from
prefect.backend.flow_run.FlowRunView.get_task_run(task_slug=None, task_run_id=None, map_index=None)[source]
Get information about a task run from this flow run. Lookup is available by one of the arguments. If the task information is not available locally already, we will query the database for it. If multiple arguments are provided, we will validate that they are consistent with each other.
Get all task run ids associated with this flow run. Lazily loaded at call time then cached for future calls.
prefect.backend.flow_run.watch_flow_run(flow_run_id, stream_states=True, stream_logs=True, max_duration=datetime.timedelta(seconds=43200))[source]
Watch execution of a flow run displaying state changes. This function will yield
This documentation was auto-generated from commit e6bd04a
on September 7, 2022 at 21:06 UTC