citrine.resources.analysis_workflow module

class citrine.resources.analysis_workflow.AnalysisWorkflowCollection(session: Session, *, team_id: UUID)

Bases: Collection[AnalysisWorkflow]

Represents the collection of all analysis workflows for a team.

Parameters:

team_id (UUID) – the UUID of the team

archive(uid: UUID | str) → AnalysisWorkflow

Archive an analysis workflow, hiding it from default listings.

build(data: dict) → AnalysisWorkflow

Build an individual analysis workflow from a dictionary.

Parameters:

data (dict) – A dictionary representing the analysis workflow.

Returns:

The analysis workflow created from data.

Return type:

AnalysisWorkflow

delete(uid: UUID | str)

Analysis workflows cannot be deleted at this time.

get(uid: UUID | str) → ResourceType

Get a particular element of the collection.

list(*, per_page: int = 20) → Iterator[AnalysisWorkflow]

List acttive analysis workflows.

list_all(*, per_page: int = 20) → Iterator[AnalysisWorkflow]

List all analysis workflows.

list_archived(*, per_page: int = 20) → Iterator[AnalysisWorkflow]

List archived analysis workflows.

rebuild(uid: UUID | str) → AnalysisWorkflow

Rebuild the data source underlying the analysis workflow.

register(model: CreationType) → CreationType

Create a new element of the collection by registering an existing resource.

restore(uid: UUID | str) → AnalysisWorkflow

Restore an analysis workflow, showing it in default listings.

update(uid: UUID | str, *, name: str | None = None, description: str | None = None) → AnalysisWorkflow

Update the name and/or description of the analysis workflow.