prefect.server.api.clients

Classes

BaseClient ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L30" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

OrchestrationClient ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L66" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Methods:

create_flow_run ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L85" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

create_flow_run(self, deployment_id: UUID, flow_run_create: DeploymentFlowRunCreate) -> Response

delete_flow_run ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L96" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

delete_flow_run(self, flow_run_id: UUID) -> Response

pause_deployment ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L109" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

pause_deployment(self, deployment_id: UUID) -> Response

pause_work_pool ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L130" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

pause_work_pool(self, work_pool_name: str) -> Response

pause_work_queue ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L159" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

pause_work_queue(self, work_queue_id: UUID) -> Response

read_block_document_raw ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L171" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

read_block_document_raw(self, block_document_id: UUID, include_secrets: bool = True) -> Response

read_concurrency_limit_v2_raw ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L221" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

read_concurrency_limit_v2_raw(self, concurrency_limit_id: UUID) -> Response

read_deployment ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L70" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

read_deployment(self, deployment_id: UUID) -> Optional[DeploymentResponse]

read_deployment_raw ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L67" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

read_deployment_raw(self, deployment_id: UUID) -> Response

read_flow_raw ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L82" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

read_flow_raw(self, flow_id: UUID) -> Response

read_flow_run_raw ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L93" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

read_flow_run_raw(self, flow_run_id: UUID) -> Response

read_task_run_raw ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L99" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

read_task_run_raw(self, task_run_id: UUID) -> Response

read_work_pool ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L146" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

read_work_pool(self, work_pool_id: UUID) -> Optional[WorkPool]

read_work_pool_raw ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L140" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

read_work_pool_raw(self, work_pool_id: UUID) -> Response

read_work_queue_raw ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L153" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

read_work_queue_raw(self, work_queue_id: UUID) -> Response

read_work_queue_status_raw ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L156" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

read_work_queue_status_raw(self, work_queue_id: UUID) -> Response

read_workspace_variables ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L184" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

read_workspace_variables(self, names: Optional[List[str]] = None) -> Dict[str, StrictVariableValue]

request ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/orchestration/base.py#L22" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

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 ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L114" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

resume_deployment(self, deployment_id: UUID) -> Response

resume_flow_run ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L102" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

resume_flow_run(self, flow_run_id: UUID) -> OrchestrationResult

resume_work_pool ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L135" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

resume_work_pool(self, work_pool_name: str) -> Response

resume_work_queue ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L165" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

resume_work_queue(self, work_queue_id: UUID) -> Response

set_flow_run_state ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L119" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

set_flow_run_state(self, flow_run_id: UUID, state: StateCreate, force: bool = False) -> Response

WorkPoolsOrchestrationClient ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L229" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Methods:

read_work_pool ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L233" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

read_work_pool(self, work_pool_name: str) -> WorkPool

Reads information for a given work pool Args: work_pool_name: The name of the work pool to for which to get information. Returns: Information about the requested work pool.

request ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/orchestration/base.py#L22" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

request(self, method: HTTP_METHODS, path: 'ServerRoutes', params: dict[str, Any] | None = None, path_params: dict[str, Any] | None = None, **kwargs: Any) -> 'Response'