citrine.resources.sample_design_space_execution module

Resources that represent both individual and collections of sample design space executions.

class citrine.resources.sample_design_space_execution.SampleDesignSpaceExecutionCollection(project_id: UUID, design_space_id: UUID, session: Session)

Bases: Collection[SampleDesignSpaceExecution]

A collection of SampleDesignSpaceExecutions.

build(data: dict) → SampleDesignSpaceExecution

Build an individual SampleDesignSpaceExecution.

delete(uid: UUID | str) → Response

Sample Design Space Executions cannot be deleted or archived.

get(uid: UUID | str) → ResourceType

Get a particular element of the collection.

list(*, per_page: int = 10) → Iterator[SampleDesignSpaceExecution]

Paginate over the elements of the collection.

Leaving page and per_page as default values will yield all elements in the collection, paginating over all available pages.

Parameters:

per_page (int, optional) – Max number of results to return per page. Default is 100. This parameter is used when making requests to the backend service. If the page parameter is specified it limits the maximum number of elements in the response.

Returns:

Resources in this collection.

Return type:

Iterator[ResourceType]

register(model: SampleDesignSpaceExecution) → SampleDesignSpaceExecution

Cannot register an execution.

trigger(sample_design_space_input: SampleDesignSpaceInput) → SampleDesignSpaceExecution

Trigger a sample design space execution.

update(model: SampleDesignSpaceExecution) → SampleDesignSpaceExecution

Cannot update an execution.