​

prefect_kubernetes.jobs

​

Functions

​

create_namespaced_job

create_namespaced_job(kubernetes_credentials: KubernetesCredentials, new_job: Union[V1Job, Dict[str, Any]], namespace: Optional[str] = 'default', **kube_kwargs: Dict[str, Any]) -> V1Job

• kubernetes_credentials: KubernetesCredentials block holding authentication needed to generate the required API client.
• new_job: A Kubernetes V1Job specification.
• namespace: The Kubernetes namespace to create this job in.
• **kube_kwargs: Optional extra keyword arguments to pass to the Kubernetes API (e.g. {"pretty"\: "...", "dry_run"\: "..."}).

• A Kubernetes V1Job object.

​

delete_namespaced_job

delete_namespaced_job(kubernetes_credentials: KubernetesCredentials, job_name: str, delete_options: Optional[V1DeleteOptions] = None, namespace: Optional[str] = 'default', **kube_kwargs: Dict[str, Any]) -> V1Status

• kubernetes_credentials: KubernetesCredentials block holding authentication needed to generate the required API client.
• job_name: The name of a job to delete.
• delete_options: A Kubernetes V1DeleteOptions object.
• namespace: The Kubernetes namespace to delete this job in.
• **kube_kwargs: Optional extra keyword arguments to pass to the Kubernetes API (e.g. {"pretty"\: "...", "dry_run"\: "..."}).

• A Kubernetes V1Status object.

​

list_namespaced_job

list_namespaced_job(kubernetes_credentials: KubernetesCredentials, namespace: Optional[str] = 'default', **kube_kwargs: Dict[str, Any]) -> V1JobList

• kubernetes_credentials: KubernetesCredentials block holding authentication needed to generate the required API client.
• namespace: The Kubernetes namespace to list jobs from.
• **kube_kwargs: Optional extra keyword arguments to pass to the Kubernetes API (e.g. {"pretty"\: "...", "dry_run"\: "..."}).

• A Kubernetes V1JobList object.

​

patch_namespaced_job

patch_namespaced_job(kubernetes_credentials: KubernetesCredentials, job_name: str, job_updates: V1Job, namespace: Optional[str] = 'default', **kube_kwargs: Dict[str, Any]) -> V1Job

• kubernetes_credentials: KubernetesCredentials block holding authentication needed to generate the required API client.
• job_name: The name of a job to patch.
• job_updates: A Kubernetes V1Job specification.
• namespace: The Kubernetes namespace to patch this job in.
• **kube_kwargs: Optional extra keyword arguments to pass to the Kubernetes API (e.g. {"pretty"\: "...", "dry_run"\: "..."}).

• ValueError: if job_name is None.

• A Kubernetes V1Job object.

​

read_namespaced_job

read_namespaced_job(kubernetes_credentials: KubernetesCredentials, job_name: str, namespace: Optional[str] = 'default', **kube_kwargs: Dict[str, Any]) -> V1Job

• kubernetes_credentials: KubernetesCredentials block holding authentication needed to generate the required API client.
• job_name: The name of a job to read.
• namespace: The Kubernetes namespace to read this job in.
• **kube_kwargs: Optional extra keyword arguments to pass to the Kubernetes API (e.g. {"pretty"\: "...", "dry_run"\: "..."}).

• ValueError: if job_name is None.

• A Kubernetes V1Job object.

​

replace_namespaced_job

replace_namespaced_job(kubernetes_credentials: KubernetesCredentials, job_name: str, new_job: V1Job, namespace: Optional[str] = 'default', **kube_kwargs: Dict[str, Any]) -> V1Job

• kubernetes_credentials: KubernetesCredentials block holding authentication needed to generate the required API client.
• job_name: The name of a job to replace.
• new_job: A Kubernetes V1Job specification.
• namespace: The Kubernetes namespace to replace this job in.
• **kube_kwargs: Optional extra keyword arguments to pass to the Kubernetes API (e.g. {"pretty"\: "...", "dry_run"\: "..."}).

• A Kubernetes V1Job object.

​

read_namespaced_job_status

read_namespaced_job_status(kubernetes_credentials: KubernetesCredentials, job_name: str, namespace: Optional[str] = 'default', **kube_kwargs: Dict[str, Any]) -> V1Job

• kubernetes_credentials: KubernetesCredentials block holding authentication needed to generate the required API client.
• job_name: The name of a job to fetch status for.
• namespace: The Kubernetes namespace to fetch status of job in.
• **kube_kwargs: Optional extra keyword arguments to pass to the Kubernetes API (e.g. {"pretty"\: "...", "dry_run"\: "..."}).

• A Kubernetes V1JobStatus object.

​

Classes

​

KubernetesJobRun

​

afetch_result

afetch_result(self) -> Dict[str, Any]

• The logs from each of the pods in the job.

• ValueError: If this method is called when the job has a non-terminal state.

​

await_for_completion

await_for_completion(self, print_func: Optional[Callable] = None)

• RuntimeError: If the Kubernetes job fails.
• KubernetesJobTimeoutError: If the Kubernetes job times out.

​

fetch_result

fetch_result(self) -> Dict[str, Any]

• The logs from each of the pods in the job.

• ValueError: If this method is called when the job has a non-terminal state.

​

v1_job_model

v1_job_model(self) -> dict[str, Any]

​

wait_for_completion

wait_for_completion(self, print_func: Optional[Callable] = None)

• RuntimeError: If the Kubernetes job fails.
• KubernetesJobTimeoutError: If the Kubernetes job times out.

​

KubernetesJob

​

atrigger

atrigger(self)

​

from_yaml_file

from_yaml_file(cls: Type[Self], manifest_path: Union[Path, str], **kwargs) -> Self

• manifest_path: The YAML file to create the KubernetesJob from.

• A KubernetesJob object.

​

trigger

trigger(self)