​
prefect.runtime.flow_run

Access attributes of the current flow run dynamically. Note that if a flow run cannot be discovered, all attributes will return empty values. You can mock the runtime attributes for testing purposes by setting environment variables prefixed with PREFECT__RUNTIME__FLOW_RUN. Available attributes:
  • id: the flow run’s unique ID
  • tags: the flow run’s set of tags
  • scheduled_start_time: the flow run’s expected scheduled start time; defaults to now if not present
  • name: the name of the flow run
  • flow_name: the name of the flow
  • flow_version: the version of the flow
  • parameters: the parameters that were passed to this run; note that these do not necessarily include default values set on the flow function, only the parameter values explicitly passed for the run
  • parent_flow_run_id: the ID of the flow run that triggered this run, if any
  • parent_deployment_id: the ID of the deployment that triggered this run, if any
  • run_count: the number of times this flow run has been run

​
Functions

​
get_id 

get_id() -> Optional[str]

​
get_tags 

get_tags() -> List[str]

​
get_run_count 

get_run_count() -> int

​
get_name 

get_name() -> Optional[str]

​
get_flow_name 

get_flow_name() -> Optional[str]

​
get_flow_version 

get_flow_version() -> Optional[str]

​
get_scheduled_start_time 

get_scheduled_start_time() -> DateTime

​
get_parameters 

get_parameters() -> Dict[str, Any]

​
get_parent_flow_run_id 

get_parent_flow_run_id() -> Optional[str]

​
get_parent_deployment_id 

get_parent_deployment_id() -> Optional[str]

​
get_root_flow_run_id 

get_root_flow_run_id() -> str

​
get_flow_run_api_url 

get_flow_run_api_url() -> Optional[str]

​
get_flow_run_ui_url 

get_flow_run_ui_url() -> Optional[str]

​
get_job_variables 

get_job_variables() -> Optional[Dict[str, Any]]