api
clients
Methods:
Methods:
Was this page helpful?
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
prefect.server.api.clientsBaseClient OrchestrationClient create_flow_run create_flow_run(self, deployment_id: UUID, flow_run_create: DeploymentFlowRunCreate) -> Response
delete_flow_run delete_flow_run(self, flow_run_id: UUID) -> Response
pause_deployment pause_deployment(self, deployment_id: UUID) -> Response
pause_work_pool pause_work_pool(self, work_pool_name: str) -> Response
pause_work_queue pause_work_queue(self, work_queue_id: UUID) -> Response
read_block_document_raw read_block_document_raw(self, block_document_id: UUID, include_secrets: bool = True) -> Response
read_concurrency_limit_v2_raw read_concurrency_limit_v2_raw(self, concurrency_limit_id: UUID) -> Response
read_deployment read_deployment(self, deployment_id: UUID) -> Optional[DeploymentResponse]
read_deployment_raw read_deployment_raw(self, deployment_id: UUID) -> Response
read_flow_raw read_flow_raw(self, flow_id: UUID) -> Response
read_flow_run_raw read_flow_run_raw(self, flow_run_id: UUID) -> Response
read_task_run_raw read_task_run_raw(self, task_run_id: UUID) -> Response
read_work_pool read_work_pool(self, work_pool_id: UUID) -> Optional[WorkPool]
read_work_pool_raw read_work_pool_raw(self, work_pool_id: UUID) -> Response
read_work_queue_raw read_work_queue_raw(self, work_queue_id: UUID) -> Response
read_work_queue_status_raw read_work_queue_status_raw(self, work_queue_id: UUID) -> Response
read_workspace_variables read_workspace_variables(self, names: Optional[List[str]] = None) -> Dict[str, StrictVariableValue]
request request(self, method: HTTP_METHODS, path: 'ServerRoutes', params: dict[str, Any] | None = None, path_params: dict[str, Any] | None = None, **kwargs: Any) -> 'Response'
resume_deployment resume_deployment(self, deployment_id: UUID) -> Response
resume_flow_run resume_flow_run(self, flow_run_id: UUID) -> OrchestrationResult
resume_work_pool resume_work_pool(self, work_pool_name: str) -> Response
resume_work_queue resume_work_queue(self, work_queue_id: UUID) -> Response
set_flow_run_state set_flow_run_state(self, flow_run_id: UUID, state: StateCreate, force: bool = False) -> Response
WorkPoolsOrchestrationClient read_work_pool read_work_pool(self, work_pool_name: str) -> WorkPool
request request(self, method: HTTP_METHODS, path: 'ServerRoutes', params: dict[str, Any] | None = None, path_params: dict[str, Any] | None = None, **kwargs: Any) -> 'Response'
Was this page helpful?