laborchestrator.sila_server.generated.cancelcontroller.cancelcontroller_client module

class laborchestrator.sila_server.generated.cancelcontroller.cancelcontroller_client.CancelControllerClient

Bases: object

This feature offers commands to cancel/terminate Commands. Cancellation is the act of stopping the running Command execution(s), irrevocably. The SiLA Server SHOULD be able to be in a state where any further commands can be issued after a cancellation.

CancelAll(*, metadata: Iterable[ClientMetadataInstance] | None = None) → CancelAll_Responses

Cancels all currently running Observable and Unobservable Commands running on this SiLA Server.

The SiLA Server MUST throw an Execution Error indicating ‘cancellation’ as the reason for the Command not being able to finish successfully.

CancelCommand(CommandExecutionUUID: UUID, *, metadata: Iterable[ClientMetadataInstance] | None = None) → CancelCommand_Responses

Cancel a specified currently running Observable Command or cancel all currently running Observable Commands .

For any canceled Observable Command the SiLA Server MUST update the Command Execution Status to “Command Finished with Error”. The SiLA Server MUST throw a descriptive error message indicating cancellation as the reason for the Command execution not being able to finish successfully for any canceled Command.