preview

Classes:

DeleteJobPreview	Job from a delete request that will be deleted or unlinked.
DeleteProjectPreview	Preview of a project delete operation, including jobs and workspaces that will be deleted.
DeleteProjectWorkspacePreview	Preview of a workspace within a project to be deleted.
DeleteWorkspacePreview	Preview of a workspace delete operation, including jobs that will be deleted or unlinked and those that will be kept.
KeepJobPreview	Job from a delete request that cannot be deleted and the reasons for it.

class DeleteJobPreview

Job from a delete request that will be deleted or unlinked.

Attributes:

project_uid
status
title
type
uid
workspace_uids

project_uid: str

status: str

title: str

type: str

uid: str

workspace_uids: List[str]

class DeleteProjectPreview

Preview of a project delete operation, including jobs and workspaces that will be deleted.

Attributes:

jobs
workspaces

jobs: List[DeleteJobPreview]

workspaces: List[DeleteProjectWorkspacePreview]

class DeleteProjectWorkspacePreview

Preview of a workspace within a project to be deleted.

Attributes:

project_uid
title
uid

project_uid: str

title: str | None

uid: str

class DeleteWorkspacePreview

Preview of a workspace delete operation, including jobs that will be deleted or unlinked and those that will be kept. If there any kept jobs, the workspace will not be marked as deleted.

Attributes:

delete	Jobs to be deleted.
jobs
keep	Jobs that cannot be deleted, either because they are final or have descendants.
unlink	Jobs to be unlinked.

delete: List[DeleteJobPreview]

Jobs to be deleted.

jobs: List[DeleteJobPreview]

keep: List[KeepJobPreview]

Jobs that cannot be deleted, either because they are final or have descendants.

unlink: List[DeleteJobPreview]

Jobs to be unlinked.

class KeepJobPreview

Job from a delete request that cannot be deleted and the reasons for it.

Attributes:

descendant_job_uids	This job's descendant UIDs that cannot be deleted.
descendant_workspace_uids	Workspaces that contain this job's descendants that cannot be deleted.
project_uid
reason	Reason for not deleting this job, either "final" because it or one if its descendants is marked a final, or "descendants" because it has children that are not or cannot be deleted.
status
title
type
uid
workspace_uids

descendant_job_uids: List[str]

This job’s descendant UIDs that cannot be deleted.

descendant_workspace_uids: List[str]

Workspaces that contain this job’s descendants that cannot be deleted.

project_uid: str

reason: Literal['final', 'descendants']

Reason for not deleting this job, either “final” because it or one if its descendants is marked a final, or “descendants” because it has children that are not or cannot be deleted.

status: str

title: str

type: str

uid: str

workspace_uids: List[str]