citrine.informatics.workflows.analysis_workflow module
- class citrine.informatics.workflows.analysis_workflow.AnalysisWorkflow(*, name: str, description: str, snapshot_id: UUID | str | None = None, plots: List[dict] = [])
Bases:
EngineResourceWithoutStatus[AnalysisWorkflow],WorkflowAn analysis workflow stored on the platform.
Note that plots are not fully supported. They’re captured as raw JSON in order to facilitate cloning an existing workflow, but no facilities are provided to validate them in the client.
- access_control_dict() dict
Return an access control entity representation of this resource. Internal use only.
- classmethod build(data: dict) Self
Build an instance of this object from given data.
- dump() dict
Dump this instance.
- failed() bool
Whether the backend process has completed unsuccessfully.
- in_progress() bool
Whether the backend process is in progress.
- succeeded() bool
Whether the backend process has completed successfully.
- archive_time = None
date and time at which the resource was archived, if it has been archived
- Type:
Optional[datetime]
- archived_by = None
id of the user who archived the resource, if it has been archived
- Type:
Optional[UUID]
- create_time = None
date and time at which the resource was created
- Type:
Optional[datetime]
- created_by = None
id of the user who created the resource
- Type:
Optional[UUID]
- description = None
- property is_archived
whether the resource is archived (hidden but not deleted).
- Type:
bool
- latest_build = None
- name = None
- project_id: UUID | None = None
Unique ID of the project that contains this workflow.
- Type:
Optional[UUID]
- snapshot_id = None
- property status: str
An alias for ‘latest_build.status’, to allow its usage with ‘wait_while_validating.
- uid = None
Citrine Platform unique identifier
- Type:
Optional[UUID]
- update_time = None
date and time at which the resource was most recently updated, if it has been updated
- Type:
Optional[datetime]
- updated_by = None
id of the user who most recently updated the resource, if it has been updated
- Type:
Optional[UUID]
- class citrine.informatics.workflows.analysis_workflow.AnalysisWorkflowUpdatePayload(uid: UUID | str, *, name: str | None = None, description: str | None = None)
Bases:
Resource[AnalysisWorkflowUpdatePayload]An object capturing the analysis workflow upload payload.
Making this a separate payload makes it explicit that you can only update name and description. Additionally, unlike in AnalysisWorkflow, both are optional, to allow changing one without changing the other.
- access_control_dict() dict
Return an access control entity representation of this resource. Internal use only.
- classmethod build(data: dict) Self
Build an instance of this object from given data.
- dump() dict
Dump this instance.
- description = None
- name = None
- uid = None
- class citrine.informatics.workflows.analysis_workflow.LatestBuild
Bases:
Resource[LatestBuild]Info on the latest analysis workflow build.
- access_control_dict() dict
Return an access control entity representation of this resource. Internal use only.
- classmethod build(data: dict) Self
Build an instance of this object from given data.
- dump() dict
Dump this instance.
- failures = []
- query = None
- status = None