laborchestrator.sila_server.generated.laborchestratorservice package

Submodules

Module contents

class laborchestrator.sila_server.generated.laborchestratorservice.GetStatus_Responses(ProcessStatus)[source]

Bases: NamedTuple

ProcessStatus: str

Status of the process

_asdict()

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

_field_defaults = {}
_fields = ('ProcessStatus',)
classmethod _make(iterable)

Make a new GetStatus_Responses object from a sequence or iterable

_replace(**kwds)

Return a new GetStatus_Responses object replacing specified fields with new values

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

Bases: DefinedExecutionError

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

Bases: DefinedExecutionError

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

Bases: FeatureImplementationBase, ABC

abstractmethod GetStatus(ProcessName: str, *, metadata: MetadataDict) → GetStatus_Responses[source]

Returns the status of the specified process

Parameters:

  • ProcessName – Name of the process

  • metadata – The SiLA Client Metadata attached to the call

Returns:

  • ProcessStatus: Status of the process

abstractmethod LoadLabConfiguration(LabConfigurationName: str, *, metadata: MetadataDict) → LoadLabConfiguration_Responses[source]

Load a Lab Configuration from Database

Parameters:

  • LabConfigurationName – Name of Lab Configuration to be loaded from the (LARA) database

  • metadata – The SiLA Client Metadata attached to the call

abstractmethod LoadLabConfigurationFile(LabConfigurationFileName: str, *, metadata: MetadataDict) → LoadLabConfigurationFile_Responses[source]

Load a Lab Configuration from YAML file

Parameters:

  • LabConfigurationFileName – Filename of Lab Configuration to be loaded - in YAML format.

  • metadata – The SiLA Client Metadata attached to the call

abstractmethod LoadProcess(LabProcessName: str, *, metadata: MetadataDict) → LoadProcess_Responses[source]

Load a pythonLab Process

Parameters:

  • LabProcessName – Name of the Labprocess in the LARA database

  • metadata – The SiLA Client Metadata attached to the call

abstractmethod LoadProcessFile(LabProcessFileName: str, *, metadata: MetadataDict) → LoadProcessFile_Responses[source]

Load a pythonLab Process file

Parameters:

  • LabProcessFileName – Filenname of the Labprocess

  • metadata – The SiLA Client Metadata attached to the call

Returns:

  • Name: Unique name given to the process. Can be used to reference this process.

abstractmethod StartProcess(ProcessName: str, *, metadata: MetadataDict) → StartProcess_Responses[source]

Starts a given process

Parameters:

  • ProcessName – Name of the process to start

  • metadata – The SiLA Client Metadata attached to the call

abstractmethod StopProcess(ProcessName: str, *, metadata: MetadataDict) → StopProcess_Responses[source]

Stops a given process

Parameters:

  • ProcessName – Name of the process to stop

  • metadata – The SiLA Client Metadata attached to the call

_abc_impl = <_abc._abc_data object>
parent_server: Server

SiLA Server serving this feature implementation

class laborchestrator.sila_server.generated.laborchestratorservice.LabOrchestratorServiceClient[source]

Bases: object

This feature controls the Lab Orchestrator

GetStatus(ProcessName: str, *, metadata: Iterable[ClientMetadataInstance] | None = None) → GetStatus_Responses[source]

Returns the status of the specified process

LoadLabConfiguration(LabConfigurationName: str, *, metadata: Iterable[ClientMetadataInstance] | None = None) → LoadLabConfiguration_Responses[source]

Load a Lab Configuration from Database

LoadLabConfigurationFile(LabConfigurationFileName: str, *, metadata: Iterable[ClientMetadataInstance] | None = None) → LoadLabConfigurationFile_Responses[source]

Load a Lab Configuration from YAML file

LoadProcess(LabProcessName: str, *, metadata: Iterable[ClientMetadataInstance] | None = None) → LoadProcess_Responses[source]

Load a pythonLab Process

LoadProcessFile(LabProcessFileName: str, *, metadata: Iterable[ClientMetadataInstance] | None = None) → LoadProcessFile_Responses[source]

Load a pythonLab Process file

StartProcess(ProcessName: str, *, metadata: Iterable[ClientMetadataInstance] | None = None) → StartProcess_Responses[source]

Starts a given process

StopProcess(ProcessName: str, *, metadata: Iterable[ClientMetadataInstance] | None = None) → StopProcess_Responses[source]

Stops a given process

class laborchestrator.sila_server.generated.laborchestratorservice.LoadLabConfigurationFile_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 LoadLabConfigurationFile_Responses object from a sequence or iterable

_replace(**kwds)

Return a new LoadLabConfigurationFile_Responses object replacing specified fields with new values

class laborchestrator.sila_server.generated.laborchestratorservice.LoadLabConfiguration_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 LoadLabConfiguration_Responses object from a sequence or iterable

_replace(**kwds)

Return a new LoadLabConfiguration_Responses object replacing specified fields with new values

class laborchestrator.sila_server.generated.laborchestratorservice.LoadProcessFile_Responses(Name)[source]

Bases: NamedTuple

Name: str

Unique name given to the process. Can be used to reference this process.

_asdict()

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

_field_defaults = {}
_fields = ('Name',)
classmethod _make(iterable)

Make a new LoadProcessFile_Responses object from a sequence or iterable

_replace(**kwds)

Return a new LoadProcessFile_Responses object replacing specified fields with new values

class laborchestrator.sila_server.generated.laborchestratorservice.LoadProcess_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 LoadProcess_Responses object from a sequence or iterable

_replace(**kwds)

Return a new LoadProcess_Responses object replacing specified fields with new values

laborchestrator.sila_server.generated.laborchestratorservice.ProcessStatus

alias of str

class laborchestrator.sila_server.generated.laborchestratorservice.StartProcess_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 StartProcess_Responses object from a sequence or iterable

_replace(**kwds)

Return a new StartProcess_Responses object replacing specified fields with new values

class laborchestrator.sila_server.generated.laborchestratorservice.StopProcess_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 StopProcess_Responses object from a sequence or iterable

_replace(**kwds)

Return a new StopProcess_Responses object replacing specified fields with new values