citrine.informatics.executions.sample_design_space_execution module
- class citrine.informatics.executions.sample_design_space_execution.SampleDesignSpaceExecution
Bases:
Resource[SampleDesignSpaceExecution],ExecutionThe execution of a Sample Design Space task.
Possible statuses are INPROGRESS, SUCCEEDED, and FAILED. Additional fields
status_descriptionandstatus_detailprovide more information.- 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.
- result(*, result_id: UUID) SampleSearchSpaceResultCandidate
Fetch a Sample Design Space Result for the particular UID.
- results(*, page: int | None = None, per_page: int = 100) Iterable[SampleSearchSpaceResultCandidate]
Fetch the Sample Design Space Results for the particular execution, paginated.
- succeeded() bool
Whether the backend process has completed successfully.
- 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]
- design_space_id: UUID | None = None
- project_id: UUID | None = None
- status = None
short description of the execution’s status
- Type:
Optional[str]
- status_description = None
more detailed description of the execution’s status
- Type:
Optional[str]
- status_detail = []
a list of structured status info, containing the message and level
- Type:
List[StatusDetail]
- uid: UUID = None
Unique identifier of the execution
- Type:
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]