citrine.resources.generative_design_execution module

Resources that represent both individual and collections of design workflow executions.

class citrine.resources.generative_design_execution.GenerativeDesignExecutionCollection(project_id: UUID, session: Session)

Bases: Collection[GenerativeDesignExecution]

A collection of GenerativeDesignExecutions.

build(data: dict) → GenerativeDesignExecution

Build an individual GenerativeDesignExecution.

delete(uid: UUID | str) → Response

Generative Design Executions cannot be deleted or archived.

get(uid: UUID | str) → ResourceType

Get a particular element of the collection.

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

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: GenerativeDesignExecution) → GenerativeDesignExecution

Cannot register an execution.

trigger(generative_design_execution_input: GenerativeDesignInput) → GenerativeDesignExecution

Trigger a Generative Design execution.

update(model: GenerativeDesignExecution) → GenerativeDesignExecution

Cannot update an execution.