Skip to main content

​
prefect.input.actions

​
Functions

​
ensure_flow_run_id 

ensure_flow_run_id(flow_run_id: Optional[UUID] = None) -> UUID

​
acreate_flow_run_input_from_model 

acreate_flow_run_input_from_model(key: str, model_instance: pydantic.BaseModel, flow_run_id: Optional[UUID] = None, sender: Optional[str] = None) -> None
Create a new flow run input from a Pydantic model asynchronously. Args:
  • key: the flow run input key
  • model_instance: a Pydantic model instance to store
  • flow_run_id: the flow run ID (defaults to current context)
  • sender: optional sender identifier

​
create_flow_run_input_from_model 

create_flow_run_input_from_model(key: str, model_instance: pydantic.BaseModel, flow_run_id: Optional[UUID] = None, sender: Optional[str] = None) -> None
Create a new flow run input from a Pydantic model. Args:
  • key: the flow run input key
  • model_instance: a Pydantic model instance to store
  • flow_run_id: the flow run ID (defaults to current context)
  • sender: optional sender identifier

​
acreate_flow_run_input 

acreate_flow_run_input(client: 'PrefectClient', key: str, value: Any, flow_run_id: Optional[UUID] = None, sender: Optional[str] = None) -> None
Create a new flow run input asynchronously. The given value will be serialized to JSON and stored as a flow run input value. Args:
  • key: the flow run input key
  • value: the flow run input value
  • flow_run_id: the flow run ID (defaults to current context)
  • sender: optional sender identifier

​
create_flow_run_input 

create_flow_run_input(key: str, value: Any, flow_run_id: Optional[UUID] = None, sender: Optional[str] = None) -> None
Create a new flow run input. The given value will be serialized to JSON and stored as a flow run input value. Args:
  • key: the flow run input key
  • value: the flow run input value
  • flow_run_id: the flow run ID (defaults to current context)
  • sender: optional sender identifier

​
afilter_flow_run_input 

afilter_flow_run_input(client: 'PrefectClient', key_prefix: str, limit: int = 1, exclude_keys: Optional[Set[str]] = None, flow_run_id: Optional[UUID] = None) -> 'list[FlowRunInput]'
Filter flow run inputs by key prefix asynchronously. Args:
  • key_prefix: prefix to filter keys by
  • limit: maximum number of results to return
  • exclude_keys: keys to exclude from results
  • flow_run_id: the flow run ID (defaults to current context)
Returns:
  • List of matching FlowRunInput objects

​
filter_flow_run_input 

filter_flow_run_input(key_prefix: str, limit: int = 1, exclude_keys: Optional[Set[str]] = None, flow_run_id: Optional[UUID] = None) -> 'list[FlowRunInput]'
Filter flow run inputs by key prefix. Args:
  • key_prefix: prefix to filter keys by
  • limit: maximum number of results to return
  • exclude_keys: keys to exclude from results
  • flow_run_id: the flow run ID (defaults to current context)
Returns:
  • List of matching FlowRunInput objects

​
aread_flow_run_input 

aread_flow_run_input(client: 'PrefectClient', key: str, flow_run_id: Optional[UUID] = None) -> Any
Read a flow run input asynchronously. Args:
  • key: the flow run input key
  • flow_run_id: the flow run ID (defaults to current context)
Returns:
  • The deserialized input value, or None if not found

​
read_flow_run_input 

read_flow_run_input(key: str, flow_run_id: Optional[UUID] = None) -> Any
Read a flow run input. Args:
  • key: the flow run input key
  • flow_run_id: the flow run ID (defaults to current context)
Returns:
  • The deserialized input value, or None if not found

​
adelete_flow_run_input 

adelete_flow_run_input(client: 'PrefectClient', key: str, flow_run_id: Optional[UUID] = None) -> None
Delete a flow run input asynchronously. Args:
  • key: the flow run input key
  • flow_run_id: the flow run ID (defaults to current context)

​
delete_flow_run_input 

delete_flow_run_input(key: str, flow_run_id: Optional[UUID] = None) -> None
Delete a flow run input. Args:
  • key: the flow run input key
  • flow_run_id: the flow run ID (defaults to current context)