laborchestrator.sila_server.generated.pausecontroller package

Submodules

Module contents

exception laborchestrator.sila_server.generated.pausecontroller.InvalidCommandExecutionUUID(message: str | None = None)[source]

Bases: DefinedExecutionError

_abc_impl = <_abc._abc_data object>
exception laborchestrator.sila_server.generated.pausecontroller.InvalidCommandState(message: str | None = None)[source]

Bases: DefinedExecutionError

_abc_impl = <_abc._abc_data object>
exception laborchestrator.sila_server.generated.pausecontroller.OperationNotSupported(message: str | None = None)[source]

Bases: DefinedExecutionError

_abc_impl = <_abc._abc_data object>
class laborchestrator.sila_server.generated.pausecontroller.PauseControllerBase(parent_server: Server)[source]

Bases: FeatureImplementationBase, ABC

abstractmethod Pause(CommandExecutionUUID: str, *, metadata: MetadataDict) → Pause_Responses[source]

Pause the Command execution. The Command can then be resumed again. The Command Execution Status of the

Observable Command MUST not be affected.

param CommandExecutionUUID:

The Command Execution UUID according to the SiLA Standard.

param metadata:

The SiLA Client Metadata attached to the call

PausedCommands_on_subscription(*, metadata: MetadataDict) → Queue[List[str]] | None[source]

A List of Command Execution UUID that are in a paused state.

This method is called when a client subscribes to the observable property ‘PausedCommands’

Parameters:

metadata – The SiLA Client Metadata attached to the call

Returns:

Optional Queue that should be used for updating this property. If None, the default Queue will be used.

abstractmethod Resume(CommandExecutionUUID: str, *, metadata: MetadataDict) → Resume_Responses[source]

Resume the Command after it has been paused.

Parameters:

  • CommandExecutionUUID – The Command Execution UUID according to the SiLA Standard.

  • metadata – The SiLA Client Metadata attached to the call

_PausedCommands_current_value: List[UUID]
_PausedCommands_producer_queue: Queue[List[UUID] | Exception]
_abc_impl = <_abc._abc_data object>
abort_PausedCommands_subscriptions(error: Exception, queue: Queue[List[str]] | None = None) → None[source]

A List of Command Execution UUID that are in a paused state.

This method aborts subscriptions to the observable property ‘PausedCommands’.

Parameters:

  • error – The Exception to be sent to the subscribing client. If it is no DefinedExecutionError or UndefinedExecutionError, it will be wrapped in an UndefinedExecutionError.

  • queue – The queue to abort. If None, the default Queue will be used.

property current_PausedCommands: List[str]
parent_server: Server

SiLA Server serving this feature implementation

update_PausedCommands(PausedCommands: List[str], queue: Queue[List[str]] | None = None) → None[source]

A List of Command Execution UUID that are in a paused state.

This method updates the observable property ‘PausedCommands’.

Parameters:

queue – The queue to send updates to. If None, the default Queue will be used.

class laborchestrator.sila_server.generated.pausecontroller.PauseControllerClient[source]

Bases: object

Allows to pause or resume a currently running Observable Command. Pausing is the act of stopping the progress of the desired intent of a Command with the option of continuing the execution when resuming.

A SiLA Client SHOULD be able to pause or resume the Observable Commands at any time. Not every Observable Command might support this Feature. If not, an “OperationNotSupported” Execution Error MUST be thrown.

Pause(CommandExecutionUUID: UUID, *, metadata: Iterable[ClientMetadataInstance] | None = None) → Pause_Responses[source]

Pause the Command execution. The Command can then be resumed again. The Command Execution Status of the

Observable Command MUST not be affected.

PausedCommands: ClientObservableProperty[List[UUID]]

A List of Command Execution UUID that are in a paused state.

Resume(CommandExecutionUUID: UUID, *, metadata: Iterable[ClientMetadataInstance] | None = None) → Resume_Responses[source]

Resume the Command after it has been paused.

class laborchestrator.sila_server.generated.pausecontroller.Pause_Responses[source]

Bases: NamedTuple

_asdict()

Return a new dict which maps field names to their values.

_field_defaults = {}
_fields = ()
classmethod _make(iterable)

Make a new Pause_Responses object from a sequence or iterable

_replace(**kwds)

Return a new Pause_Responses object replacing specified fields with new values

class laborchestrator.sila_server.generated.pausecontroller.Resume_Responses[source]

Bases: NamedTuple

_asdict()

Return a new dict which maps field names to their values.

_field_defaults = {}
_fields = ()
classmethod _make(iterable)

Make a new Resume_Responses object from a sequence or iterable

_replace(**kwds)

Return a new Resume_Responses object replacing specified fields with new values

laborchestrator.sila_server.generated.pausecontroller.UUID

alias of str