em.workflow.v1#
Classes:
-
EdsAcquisitionMode–Enum indicating the acquisition mode.
-
VacuumParameter–List of parameters that can be called on the Vacuum.
-
WorkflowState–WorkflowState.
-
EdsSpectrumAcquisitionSettings–EDS spectrum acquisition setting.
-
EmRegionOfInterest–The EM region of interest settings.
-
CreateWorkflowServiceAddAbsoluteTiltingActionRequest–The CreateWorkflowServiceAddAbsoluteTiltingActionRequest class.
-
CreateWorkflowServiceAddAbsoluteTiltingActionResponse–ActionResponse response.
-
CreateWorkflowServiceAddAcquireNavCamImageActionRequest–The CreateWorkflowServiceAddAcquireNavCamImageActionRequest class.
-
CreateWorkflowServiceAddAcquireNavCamImageActionResponse–ActionResponse response.
-
CreateWorkflowServiceAddAcquireStoreImageActionRequest–The CreateWorkflowServiceAddAcquireStoreImageActionRequest class.
-
CreateWorkflowServiceAddAcquireStoreImageActionResponse–ActionResponse response.
-
CreateWorkflowServiceAddChangeBeamStateActionRequest–The CreateWorkflowServiceAddChangeBeamStateActionRequest class.
-
CreateWorkflowServiceAddChangeBeamStateActionResponse–ActionResponse response.
-
CreateWorkflowServiceAddChangeCurrentActionRequest–The CreateWorkflowServiceAddChangeCurrentActionRequest class.
-
CreateWorkflowServiceAddChangeCurrentActionResponse–ActionResponse response.
-
CreateWorkflowServiceAddChangeEhtActionRequest–The CreateWorkflowServiceAddChangeEhtActionRequest class.
-
CreateWorkflowServiceAddChangeEhtActionResponse–ActionResponse response.
-
CreateWorkflowServiceAddEdsAcquisitionSettingsParameterActionRequest–The CreateWorkflowServiceAddEdsAcquisitionSettingsParameterActionRequest class.
-
CreateWorkflowServiceAddEdsAcquisitionSettingsParameterActionResponse–ActionResponse response.
-
CreateWorkflowServiceAddFocusAndFovActionRequest–The CreateWorkflowServiceAddFocusAndFovActionRequest class.
-
CreateWorkflowServiceAddFocusAndFovActionResponse–ActionResponse response.
-
CreateWorkflowServiceAddGoToStoredPositionActionRequest–The CreateWorkflowServiceAddGoToStoredPositionActionRequest class.
-
CreateWorkflowServiceAddGoToStoredPositionActionResponse–ActionResponse response.
-
CreateWorkflowServiceAddInitializeActionRequest–The CreateWorkflowServiceAddInitializeActionRequest class.
-
CreateWorkflowServiceAddInitializeActionResponse–ActionResponse response.
-
CreateWorkflowServiceAddMoveStageRelativeActionRequest–The CreateWorkflowServiceAddMoveStageRelativeActionRequest class.
-
CreateWorkflowServiceAddMoveStageRelativeActionResponse–ActionResponse response.
-
CreateWorkflowServiceAddPositionControlledTiltActionRequest–The CreateWorkflowServiceAddPositionControlledTiltActionRequest class.
-
CreateWorkflowServiceAddPositionControlledTiltActionResponse–ActionResponse response.
-
CreateWorkflowServiceAddRestoreFibProbeActionRequest–The CreateWorkflowServiceAddRestoreFibProbeActionRequest class.
-
CreateWorkflowServiceAddRestoreFibProbeActionResponse–ActionResponse response.
-
CreateWorkflowServiceAddSetFibProbeActionRequest–The CreateWorkflowServiceAddSetFibProbeActionRequest class.
-
CreateWorkflowServiceAddSetFibProbeActionResponse–ActionResponse response.
-
CreateWorkflowServiceAddSetFibWithValuesActionRequest–The CreateWorkflowServiceAddSetFibWithValuesActionRequest class.
-
CreateWorkflowServiceAddSetFibWithValuesActionResponse–ActionResponse response.
-
CreateWorkflowServiceAddSetVacuumParameterActionRequest–The CreateWorkflowServiceAddSetVacuumParameterActionRequest class.
-
CreateWorkflowServiceAddSetVacuumParameterActionResponse–ActionResponse response.
-
CreateWorkflowServiceAddSpotParameterActionRequest–The CreateWorkflowServiceAddSpotParameterActionRequest class.
-
CreateWorkflowServiceAddSpotParameterActionResponse–ActionResponse response.
-
CreateWorkflowServiceAddStoreFibProbeActionRequest–The CreateWorkflowServiceAddStoreFibProbeActionRequest class.
-
CreateWorkflowServiceAddStoreFibProbeActionResponse–ActionResponse response.
-
CreateWorkflowServiceAddTouchAlarmGeneratorActionRequest–The CreateWorkflowServiceAddTouchAlarmGeneratorActionRequest class.
-
CreateWorkflowServiceAddTouchAlarmGeneratorActionResponse–ActionResponse response.
-
CreateWorkflowServiceAddVacuumCommandActionRequest–The CreateWorkflowServiceAddVacuumCommandActionRequest class.
-
CreateWorkflowServiceAddVacuumCommandActionResponse–ActionResponse response.
-
RunWorkflowServiceBreakRequest–The RunWorkflowServiceBreakRequest class.
-
RunWorkflowServiceBreakResponse–The RunWorkflowServiceBreakResponse class.
-
RunWorkflowServiceDefineAndRunCompleteWorkflowRequest–The RunWorkflowServiceDefineAndRunCompleteWorkflowRequest class.
-
RunWorkflowServiceDefineAndRunCompleteWorkflowResponse–Response object of the RunWorkflow method.
-
RunWorkflowServiceGetWorkflowByIdRequest–The RunWorkflowServiceGetWorkflowByIdRequest class.
-
RunWorkflowServiceGetWorkflowByIdResponse–Response object of the GetWorkflow method.
-
RunWorkflowServiceGetWorkflowStateRequest–The RunWorkflowServiceGetWorkflowStateRequest class.
-
RunWorkflowServiceGetWorkflowStateResponse–Response object of the RunWorkflowApi.
-
RunWorkflowServiceNextRequest–The RunWorkflowServiceNextRequest class.
-
RunWorkflowServiceNextResponse–The RunWorkflowServiceNextResponse class.
-
RunWorkflowServicePauseRequest–The RunWorkflowServicePauseRequest class.
-
RunWorkflowServicePauseResponse–The RunWorkflowServicePauseResponse class.
-
RunWorkflowServiceRegisterOnActionExecutionIdChangedRequest–The RunWorkflowServiceRegisterOnActionExecutionIdChangedRequest class.
-
RunWorkflowServiceRegisterOnActionExecutionIdChangedResponse–ActionExecutionId response.
-
RunWorkflowServiceRegisterOnWorkflowStateChangedRequest–The RunWorkflowServiceRegisterOnWorkflowStateChangedRequest class.
-
RunWorkflowServiceRegisterOnWorkflowStateChangedResponse–Response object of the RunWorkflowApi.
-
RunWorkflowServiceResumeRequest–The RunWorkflowServiceResumeRequest class.
-
RunWorkflowServiceResumeResponse–The RunWorkflowServiceResumeResponse class.
-
RunWorkflowServiceRunWorkflowRequest–The RunWorkflowServiceRunWorkflowRequest class.
-
RunWorkflowServiceRunWorkflowResponse–Response object of the RunWorkflow method.
-
RunWorkflowServiceSetNormalModeRequest–The RunWorkflowServiceSetNormalModeRequest class.
-
RunWorkflowServiceSetNormalModeResponse–The RunWorkflowServiceSetNormalModeResponse class.
-
RunWorkflowServiceSetStepModeRequest–The RunWorkflowServiceSetStepModeRequest class.
-
RunWorkflowServiceSetStepModeResponse–The RunWorkflowServiceSetStepModeResponse class.
-
RunWorkflowServiceStartRequest–The RunWorkflowServiceStartRequest class.
-
RunWorkflowServiceStartResponse–The RunWorkflowServiceStartResponse class.
-
RunWorkflowServiceStepRequest–The RunWorkflowServiceStepRequest class.
-
RunWorkflowServiceStepResponse–The RunWorkflowServiceStepResponse class.
-
RunWorkflowServiceStopEmergencyRequest–The RunWorkflowServiceStopEmergencyRequest class.
-
RunWorkflowServiceStopEmergencyResponse–The RunWorkflowServiceStopEmergencyResponse class.
-
RunWorkflowServiceStopRequest–The RunWorkflowServiceStopRequest class.
-
RunWorkflowServiceStopResponse–The RunWorkflowServiceStopResponse class.
-
WorkflowAdminServiceDeleteWorkflowByIdRequest–The WorkflowAdminServiceDeleteWorkflowByIdRequest class.
-
WorkflowAdminServiceDeleteWorkflowByIdResponse–The WorkflowAdminServiceDeleteWorkflowByIdResponse class.
-
WorkflowAdminServiceGetAvailableWorkflowIdsRequest–The WorkflowAdminServiceGetAvailableWorkflowIdsRequest class.
-
WorkflowAdminServiceGetAvailableWorkflowIdsResponse–Response object of the GetAvailableWorkflowsIds method.
Bases: Enum
Enum indicating the acquisition mode.
Attributes:
-
UNSPECIFIED–Default enum value.
-
AUTO–Auto selection of acquisition mode which is Counts.
-
LIVE_TIME–Acquire EDS data for a period of live time. This is the time for which the system is processing counts into the spectrum.
-
COUNTS–Acquisition continues until enough counts are collected in the spectrum.
class-attribute
instance-attribute
#
AUTO = 1
Auto selection of acquisition mode which is Counts. Acquisition continues until enough counts are collected in the spectrum.
class-attribute
instance-attribute
#
LIVE_TIME = 2
Acquire EDS data for a period of live time. This is the time for which the system is processing counts into the spectrum.
class-attribute
instance-attribute
#
COUNTS = 3
Acquisition continues until enough counts are collected in the spectrum.
Bases: Enum
List of parameters that can be called on the Vacuum.
Attributes:
-
UNSPECIFIED–Default enum value.
-
VARIABLE_PRESSURE_TARGET–Variable pressure.
Bases: Enum
WorkflowState.
Attributes:
-
UNSPECIFIED–Default value.
-
RUN_ACTIVE–Execution running.
-
RUN_PAUSED–Execution paused.
-
RUN_COMPLETED–Execution completed.
-
RUN_FAILED–Execution failed.
-
RUN_UNKNOWN–Unknown status, e.g. no run so far.
class-attribute
instance-attribute
#
RUN_UNKNOWN = 5
Unknown status, e.g. no run so far.
dataclass
#
EdsSpectrumAcquisitionSettings(acquisition_counts: int = betterproto.int32_field(1), acquisition_time: float = betterproto.double_field(2), acquisition_mode: EdsAcquisitionMode = betterproto.enum_field(3))
Bases: Message
EDS spectrum acquisition setting.
Attributes:
-
acquisition_counts(int) –The acquisition counts.
-
acquisition_time(float) –The acquisition time in seconds.
-
acquisition_mode(EdsAcquisitionMode) –A value indicating whether the acquisition mode (live time or counts).
class-attribute
instance-attribute
#
acquisition_counts: int = int32_field(1)
The acquisition counts.
class-attribute
instance-attribute
#
acquisition_time: float = double_field(2)
The acquisition time in seconds.
class-attribute
instance-attribute
#
acquisition_mode: EdsAcquisitionMode = enum_field(3)
A value indicating whether the acquisition mode (live time or counts).
dataclass
#
EmRegionOfInterest(position_x: float = betterproto.double_field(1), position_y: float = betterproto.double_field(2), width: float = betterproto.double_field(3), height: float = betterproto.double_field(4))
Bases: Message
The EM region of interest settings.
Attributes:
-
position_x(float) –The X-coordinate of the region's position.
-
position_y(float) –The Y-coordinate of the region's position.
-
width(float) –The width of the region.
-
height(float) –The height of the region.
class-attribute
instance-attribute
#
position_x: float = double_field(1)
The X-coordinate of the region's position.
class-attribute
instance-attribute
#
position_y: float = double_field(2)
The Y-coordinate of the region's position.
class-attribute
instance-attribute
#
height: float = double_field(4)
The height of the region.
dataclass
#
CreateWorkflowServiceAddAbsoluteTiltingActionRequest(workflow_id: str = betterproto.string_field(1), tilt_angle: float = betterproto.double_field(2))
Bases: Message
The CreateWorkflowServiceAddAbsoluteTiltingActionRequest class.
Attributes:
-
workflow_id(str) –Identifier of the workflow to which action should be added.
-
tilt_angle(float) –The angle in degrees to which the tilting should occur. Defaults to 0 if not specified.
class-attribute
instance-attribute
#
workflow_id: str = string_field(1)
Identifier of the workflow to which action should be added.
class-attribute
instance-attribute
#
tilt_angle: float = double_field(2)
The angle in degrees to which the tilting should occur. Defaults to 0 if not specified.
dataclass
#
CreateWorkflowServiceAddAbsoluteTiltingActionResponse(action_id: str = betterproto.string_field(1))
dataclass
#
CreateWorkflowServiceAddAcquireNavCamImageActionRequest(workflow_id: str = betterproto.string_field(1), em_region_of_interest: EmRegionOfInterest = betterproto.message_field(2), file_name: str = betterproto.string_field(3))
Bases: Message
The CreateWorkflowServiceAddAcquireNavCamImageActionRequest class.
Attributes:
-
workflow_id(str) –Identifier of the workflow to which action should be added.
-
em_region_of_interest(EmRegionOfInterest) –An ZenApi.EM.Workflow.V1.EmRegionOfInterest object specifying the region of interest for the NavCam image acquisition.
-
file_name(str) –The name of the file where the acquired NavCam image will be saved.
class-attribute
instance-attribute
#
workflow_id: str = string_field(1)
Identifier of the workflow to which action should be added.
class-attribute
instance-attribute
#
em_region_of_interest: EmRegionOfInterest = message_field(2)
An ZenApi.EM.Workflow.V1.EmRegionOfInterest object specifying the region of interest for the NavCam image acquisition.
class-attribute
instance-attribute
#
file_name: str = string_field(3)
The name of the file where the acquired NavCam image will be saved.
dataclass
#
CreateWorkflowServiceAddAcquireNavCamImageActionResponse(action_id: str = betterproto.string_field(1))
dataclass
#
CreateWorkflowServiceAddAcquireStoreImageActionRequest(workflow_id: str = betterproto.string_field(1), em_region_of_interest: EmRegionOfInterest = betterproto.message_field(2), image_key: str = betterproto.string_field(3), position_name: str = betterproto.string_field(4), xoffset: float = betterproto.double_field(5), yoffset: float = betterproto.double_field(6), file_name: str = betterproto.string_field(7))
Bases: Message
The CreateWorkflowServiceAddAcquireStoreImageActionRequest class.
Attributes:
-
workflow_id(str) –Identifier of the workflow to which action should be added.
-
em_region_of_interest(EmRegionOfInterest) –An ZenApi.EM.Workflow.V1.EmRegionOfInterest object specifying the region of interest for the image acquisition.
-
image_key(str) –A unique key identifier for the image to be stored.
-
position_name(str) –An optional name for the position associated with the image acquisition. Default is an empty string.
-
xoffset(float) –An optional X-coordinate offset for the image acquisition. Default is System.Double.NaN.
-
yoffset(float) –An optional Y-coordinate offset for the image acquisition. Default is System.Double.NaN.
-
file_name(str) –An optional file name for storing the acquired image. Default is an empty string.
class-attribute
instance-attribute
#
workflow_id: str = string_field(1)
Identifier of the workflow to which action should be added.
class-attribute
instance-attribute
#
em_region_of_interest: EmRegionOfInterest = message_field(2)
An ZenApi.EM.Workflow.V1.EmRegionOfInterest object specifying the region of interest for the image acquisition.
class-attribute
instance-attribute
#
image_key: str = string_field(3)
A unique key identifier for the image to be stored.
class-attribute
instance-attribute
#
position_name: str = string_field(4)
An optional name for the position associated with the image acquisition. Default is an empty string.
class-attribute
instance-attribute
#
xoffset: float = double_field(5)
An optional X-coordinate offset for the image acquisition. Default is System.Double.NaN.
class-attribute
instance-attribute
#
yoffset: float = double_field(6)
An optional Y-coordinate offset for the image acquisition. Default is System.Double.NaN.
class-attribute
instance-attribute
#
file_name: str = string_field(7)
An optional file name for storing the acquired image. Default is an empty string.
dataclass
#
CreateWorkflowServiceAddAcquireStoreImageActionResponse(action_id: str = betterproto.string_field(1))
dataclass
#
CreateWorkflowServiceAddChangeBeamStateActionRequest(workflow_id: str = betterproto.string_field(1), desired_state: BeamState = betterproto.enum_field(2))
Bases: Message
The CreateWorkflowServiceAddChangeBeamStateActionRequest class.
Attributes:
-
workflow_id(str) –Identifier of the workflow to which action should be added.
-
desired_state(BeamState) –The desired state of the beam, specified as a ZenApi.EM.Hardware.V1.BeamState enumeration.
class-attribute
instance-attribute
#
workflow_id: str = string_field(1)
Identifier of the workflow to which action should be added.
class-attribute
instance-attribute
#
desired_state: BeamState = enum_field(2)
The desired state of the beam, specified as a ZenApi.EM.Hardware.V1.BeamState enumeration.
dataclass
#
CreateWorkflowServiceAddChangeBeamStateActionResponse(action_id: str = betterproto.string_field(1))
dataclass
#
CreateWorkflowServiceAddChangeCurrentActionRequest(workflow_id: str = betterproto.string_field(1), target_current: float = betterproto.double_field(2))
Bases: Message
The CreateWorkflowServiceAddChangeCurrentActionRequest class.
Attributes:
-
workflow_id(str) –Identifier of the workflow to which action should be added.
-
target_current(float) –The target current level to which the current should be adjusted.
class-attribute
instance-attribute
#
workflow_id: str = string_field(1)
Identifier of the workflow to which action should be added.
class-attribute
instance-attribute
#
target_current: float = double_field(2)
The target current level to which the current should be adjusted.
dataclass
#
CreateWorkflowServiceAddChangeCurrentActionResponse(action_id: str = betterproto.string_field(1))
dataclass
#
CreateWorkflowServiceAddChangeEhtActionRequest(workflow_id: str = betterproto.string_field(1), target_voltage: float = betterproto.double_field(2))
Bases: Message
The CreateWorkflowServiceAddChangeEhtActionRequest class.
Attributes:
-
workflow_id(str) –Identifier of the workflow to which action should be added.
-
target_voltage(float) –The target voltage level to which the EHT should be changed.
dataclass
#
CreateWorkflowServiceAddChangeEhtActionResponse(action_id: str = betterproto.string_field(1))
dataclass
#
CreateWorkflowServiceAddEdsAcquisitionSettingsParameterActionRequest(workflow_id: str = betterproto.string_field(1), acquisition_settings: EdsSpectrumAcquisitionSettings = betterproto.message_field(2))
Bases: Message
The CreateWorkflowServiceAddEdsAcquisitionSettingsParameterActionRequest class.
Attributes:
-
workflow_id(str) –The unique identifier of the workflow to which the EDS acquisition settings action will be appended.
-
acquisition_settings(EdsSpectrumAcquisitionSettings) –The EDS acquisition settings to be applied, provided as an ZenApi.EM.Workflow.V1.EdsSpectrumAcquisitionSettings interface.
class-attribute
instance-attribute
#
workflow_id: str = string_field(1)
The unique identifier of the workflow to which the EDS acquisition settings action will be appended.
class-attribute
instance-attribute
#
acquisition_settings: EdsSpectrumAcquisitionSettings = message_field(2)
The EDS acquisition settings to be applied, provided as an ZenApi.EM.Workflow.V1.EdsSpectrumAcquisitionSettings interface.
dataclass
#
CreateWorkflowServiceAddEdsAcquisitionSettingsParameterActionResponse(action_id: str = betterproto.string_field(1))
dataclass
#
CreateWorkflowServiceAddFocusAndFovActionRequest(workflow_id: str = betterproto.string_field(1), focus: float = betterproto.double_field(2), fov: float = betterproto.double_field(3), is_sem: bool = betterproto.bool_field(4))
Bases: Message
The CreateWorkflowServiceAddFocusAndFovActionRequest class.
Attributes:
-
workflow_id(str) –Identifier of the workflow to which action should be added.
-
focus(float) –The focus value to be set.
-
fov(float) –The field of view value to be set.
-
is_sem(bool) –A boolean indicating whether the setting is for a SEM (true) or not (false).
class-attribute
instance-attribute
#
workflow_id: str = string_field(1)
Identifier of the workflow to which action should be added.
class-attribute
instance-attribute
#
focus: float = double_field(2)
The focus value to be set.
class-attribute
instance-attribute
#
fov: float = double_field(3)
The field of view value to be set.
class-attribute
instance-attribute
#
is_sem: bool = bool_field(4)
A boolean indicating whether the setting is for a SEM (true) or not (false).
dataclass
#
CreateWorkflowServiceAddFocusAndFovActionResponse(action_id: str = betterproto.string_field(1))
dataclass
#
CreateWorkflowServiceAddGoToStoredPositionActionRequest(workflow_id: str = betterproto.string_field(1), id: int = betterproto.int32_field(2))
Bases: Message
The CreateWorkflowServiceAddGoToStoredPositionActionRequest class.
Attributes:
-
workflow_id(str) –Identifier of the workflow to which action should be added.
-
id(int) –Id of the stage position stored.
dataclass
#
CreateWorkflowServiceAddGoToStoredPositionActionResponse(action_id: str = betterproto.string_field(1))
dataclass
#
CreateWorkflowServiceAddInitializeActionRequest(workflow_id: str = betterproto.string_field(1))
Bases: Message
The CreateWorkflowServiceAddInitializeActionRequest class.
Attributes:
-
workflow_id(str) –Identifier of the workflow to which action should be added.
class-attribute
instance-attribute
#
workflow_id: str = string_field(1)
Identifier of the workflow to which action should be added.
dataclass
#
CreateWorkflowServiceAddInitializeActionResponse(action_id: str = betterproto.string_field(1))
dataclass
#
CreateWorkflowServiceAddMoveStageRelativeActionRequest(workflow_id: str = betterproto.string_field(1), axis_to_move: List[StageAxis] = betterproto.message_field(2))
Bases: Message
The CreateWorkflowServiceAddMoveStageRelativeActionRequest class.
Attributes:
-
workflow_id(str) –Identifier of the workflow to which action should be added.
-
axis_to_move(List[StageAxis]) –The stage axis that should move.
class-attribute
instance-attribute
#
workflow_id: str = string_field(1)
Identifier of the workflow to which action should be added.
class-attribute
instance-attribute
#
axis_to_move: List[StageAxis] = message_field(2)
The stage axis that should move. The position is in meters.
dataclass
#
CreateWorkflowServiceAddMoveStageRelativeActionResponse(action_id: str = betterproto.string_field(1))
dataclass
#
CreateWorkflowServiceAddPositionControlledTiltActionRequest(workflow_id: str = betterproto.string_field(1), start_angle: float = betterproto.double_field(2), target_angle: float = betterproto.double_field(3), large_step: float = betterproto.double_field(4), small_step: float = betterproto.double_field(5))
Bases: Message
The CreateWorkflowServiceAddPositionControlledTiltActionRequest class.
Attributes:
-
workflow_id(str) –Identifier of the workflow to which action should be added.
-
start_angle(float) –The starting angle in degrees for the tilt action.
-
target_angle(float) –The target angle in degrees the tilt action aims to reach.
-
large_step(float) –The size of the large step in degrees for tilting.
-
small_step(float) –The size of the small step in degrees for finer tilting adjustments.
class-attribute
instance-attribute
#
workflow_id: str = string_field(1)
Identifier of the workflow to which action should be added.
class-attribute
instance-attribute
#
start_angle: float = double_field(2)
The starting angle in degrees for the tilt action.
class-attribute
instance-attribute
#
target_angle: float = double_field(3)
The target angle in degrees the tilt action aims to reach.
class-attribute
instance-attribute
#
large_step: float = double_field(4)
The size of the large step in degrees for tilting.
class-attribute
instance-attribute
#
small_step: float = double_field(5)
The size of the small step in degrees for finer tilting adjustments.
dataclass
#
CreateWorkflowServiceAddPositionControlledTiltActionResponse(action_id: str = betterproto.string_field(1))
dataclass
#
CreateWorkflowServiceAddRestoreFibProbeActionRequest(workflow_id: str = betterproto.string_field(1), fib_probe_storage_name: str = betterproto.string_field(2))
Bases: Message
The CreateWorkflowServiceAddRestoreFibProbeActionRequest class.
Attributes:
-
workflow_id(str) –Identifier of the workflow to which action should be added.
-
fib_probe_storage_name(str) –The name of the storage location from which the FIB probe state will be restored.
class-attribute
instance-attribute
#
workflow_id: str = string_field(1)
Identifier of the workflow to which action should be added.
class-attribute
instance-attribute
#
fib_probe_storage_name: str = string_field(2)
The name of the storage location from which the FIB probe state will be restored.
dataclass
#
CreateWorkflowServiceAddRestoreFibProbeActionResponse(action_id: str = betterproto.string_field(1))
dataclass
#
CreateWorkflowServiceAddSetFibProbeActionRequest(workflow_id: str = betterproto.string_field(1), probe_name: str = betterproto.string_field(2))
Bases: Message
The CreateWorkflowServiceAddSetFibProbeActionRequest class.
Attributes:
-
workflow_id(str) –Identifier of the workflow to which action should be added.
-
probe_name(str) –The name of the FIB probe to be set.
dataclass
#
CreateWorkflowServiceAddSetFibProbeActionResponse(action_id: str = betterproto.string_field(1))
dataclass
#
CreateWorkflowServiceAddSetFibWithValuesActionRequest(workflow_id: str = betterproto.string_field(1), voltage: str = betterproto.string_field(2), current: str = betterproto.string_field(3))
Bases: Message
The CreateWorkflowServiceAddSetFibWithValuesActionRequest class.
Attributes:
-
workflow_id(str) –Identifier of the workflow to which action should be added.
-
voltage(str) –The voltage value to set for the FIB.
-
current(str) –The current value to set for the FIB.
class-attribute
instance-attribute
#
workflow_id: str = string_field(1)
Identifier of the workflow to which action should be added.
class-attribute
instance-attribute
#
voltage: str = string_field(2)
The voltage value to set for the FIB.
class-attribute
instance-attribute
#
current: str = string_field(3)
The current value to set for the FIB.
dataclass
#
CreateWorkflowServiceAddSetFibWithValuesActionResponse(action_id: str = betterproto.string_field(1))
dataclass
#
CreateWorkflowServiceAddSetVacuumParameterActionRequest(workflow_id: str = betterproto.string_field(1), vacuum_parameter: VacuumParameter = betterproto.enum_field(2), value: float = betterproto.double_field(3))
Bases: Message
The CreateWorkflowServiceAddSetVacuumParameterActionRequest class.
Attributes:
-
workflow_id(str) –Identifier of the workflow to which action should be added.
-
vacuum_parameter(VacuumParameter) –The vacuum parameter to be set, specified as a ZenApi.EM.Workflow.V1.VacuumParameter enumeration.
-
value(float) –The value to which the specified vacuum parameter should be set.
class-attribute
instance-attribute
#
workflow_id: str = string_field(1)
Identifier of the workflow to which action should be added.
class-attribute
instance-attribute
#
vacuum_parameter: VacuumParameter = enum_field(2)
The vacuum parameter to be set, specified as a ZenApi.EM.Workflow.V1.VacuumParameter enumeration.
class-attribute
instance-attribute
#
value: float = double_field(3)
The value to which the specified vacuum parameter should be set.
dataclass
#
CreateWorkflowServiceAddSetVacuumParameterActionResponse(action_id: str = betterproto.string_field(1))
dataclass
#
CreateWorkflowServiceAddSpotParameterActionRequest(workflow_id: str = betterproto.string_field(1), spot_id: str = betterproto.string_field(2), position_x: float = betterproto.double_field(3), position_y: float = betterproto.double_field(4))
Bases: Message
The CreateWorkflowServiceAddSpotParameterActionRequest class.
Attributes:
-
workflow_id(str) –Identifier of the workflow to which action should be added.
-
spot_id(str) –The identifier of the spot to be configured.
-
position_x(float) –The X-coordinate of the beam position for the spot.
-
position_y(float) –The Y-coordinate of the beam position for the spot.
class-attribute
instance-attribute
#
workflow_id: str = string_field(1)
Identifier of the workflow to which action should be added.
class-attribute
instance-attribute
#
spot_id: str = string_field(2)
The identifier of the spot to be configured.
class-attribute
instance-attribute
#
position_x: float = double_field(3)
The X-coordinate of the beam position for the spot.
class-attribute
instance-attribute
#
position_y: float = double_field(4)
The Y-coordinate of the beam position for the spot.
dataclass
#
CreateWorkflowServiceAddSpotParameterActionResponse(action_id: str = betterproto.string_field(1))
dataclass
#
CreateWorkflowServiceAddStoreFibProbeActionRequest(workflow_id: str = betterproto.string_field(1), fib_probe_storage_name: str = betterproto.string_field(2))
Bases: Message
The CreateWorkflowServiceAddStoreFibProbeActionRequest class.
Attributes:
-
workflow_id(str) –Identifier of the workflow to which action should be added.
-
fib_probe_storage_name(str) –The name for the storage location of the FIB probe state.
class-attribute
instance-attribute
#
workflow_id: str = string_field(1)
Identifier of the workflow to which action should be added.
class-attribute
instance-attribute
#
fib_probe_storage_name: str = string_field(2)
The name for the storage location of the FIB probe state.
dataclass
#
CreateWorkflowServiceAddStoreFibProbeActionResponse(action_id: str = betterproto.string_field(1))
dataclass
#
CreateWorkflowServiceAddTouchAlarmGeneratorActionRequest(workflow_id: str = betterproto.string_field(1), disable_alarm: bool = betterproto.bool_field(2))
Bases: Message
The CreateWorkflowServiceAddTouchAlarmGeneratorActionRequest class.
Attributes:
-
workflow_id(str) –Identifier of the workflow to which action should be added.
-
disable_alarm(bool) –A boolean indicating whether to disable (true) or enable (false) the touch alarm.
class-attribute
instance-attribute
#
workflow_id: str = string_field(1)
Identifier of the workflow to which action should be added.
class-attribute
instance-attribute
#
disable_alarm: bool = bool_field(2)
A boolean indicating whether to disable (true) or enable (false) the touch alarm.
dataclass
#
CreateWorkflowServiceAddTouchAlarmGeneratorActionResponse(action_id: str = betterproto.string_field(1))
dataclass
#
CreateWorkflowServiceAddVacuumCommandActionRequest(workflow_id: str = betterproto.string_field(1), command: str = betterproto.string_field(2))
Bases: Message
The CreateWorkflowServiceAddVacuumCommandActionRequest class.
Attributes:
-
workflow_id(str) –Identifier of the workflow to which action should be added.
-
command(str) –The vacuum command to be sent.
dataclass
#
CreateWorkflowServiceAddVacuumCommandActionResponse(action_id: str = betterproto.string_field(1))
dataclass
#
RunWorkflowServiceBreakRequest(break_elements: str = betterproto.string_field(1))
Bases: Message
The RunWorkflowServiceBreakRequest class.
Attributes:
-
break_elements(str) –List of elements, that shall be skipped.
class-attribute
instance-attribute
#
break_elements: str = string_field(1)
List of elements, that shall be skipped.
dataclass
#
RunWorkflowServiceBreakResponse()
Bases: Message
The RunWorkflowServiceBreakResponse class.
dataclass
#
RunWorkflowServiceDefineAndRunCompleteWorkflowRequest(workflow_definition: str = betterproto.string_field(1))
Bases: Message
The RunWorkflowServiceDefineAndRunCompleteWorkflowRequest class.
Attributes:
-
workflow_definition(str) –Complete and consistent definition of the workflow which should be executed.
class-attribute
instance-attribute
#
workflow_definition: str = string_field(1)
Complete and consistent definition of the workflow which should be executed.
dataclass
#
RunWorkflowServiceDefineAndRunCompleteWorkflowResponse(task_success: bool = betterproto.bool_field(1))
Bases: Message
Response object of the RunWorkflow method.
Attributes:
-
task_success(bool) –A value indicating whether the task to run workflow succeeded or not.
class-attribute
instance-attribute
#
task_success: bool = bool_field(1)
A value indicating whether the task to run workflow succeeded or not.
dataclass
#
RunWorkflowServiceGetWorkflowByIdRequest(workflow_id: str = betterproto.string_field(1))
Bases: Message
The RunWorkflowServiceGetWorkflowByIdRequest class.
Attributes:
-
workflow_id(str) –Identifier of the workflow which should be returned.
class-attribute
instance-attribute
#
workflow_id: str = string_field(1)
Identifier of the workflow which should be returned.
dataclass
#
RunWorkflowServiceGetWorkflowByIdResponse(workflow: str = betterproto.string_field(1))
dataclass
#
RunWorkflowServiceGetWorkflowStateRequest()
Bases: Message
The RunWorkflowServiceGetWorkflowStateRequest class.
dataclass
#
RunWorkflowServiceGetWorkflowStateResponse(workflow_state: WorkflowState = betterproto.enum_field(1))
Bases: Message
Response object of the RunWorkflowApi.
Attributes:
-
workflow_state(WorkflowState) –A Workflow state value.
class-attribute
instance-attribute
#
workflow_state: WorkflowState = enum_field(1)
A Workflow state value.
dataclass
#
RunWorkflowServiceNextRequest()
Bases: Message
The RunWorkflowServiceNextRequest class.
dataclass
#
RunWorkflowServiceNextResponse()
Bases: Message
The RunWorkflowServiceNextResponse class.
dataclass
#
RunWorkflowServicePauseRequest()
Bases: Message
The RunWorkflowServicePauseRequest class.
dataclass
#
RunWorkflowServicePauseResponse()
Bases: Message
The RunWorkflowServicePauseResponse class.
dataclass
#
RunWorkflowServiceRegisterOnActionExecutionIdChangedRequest()
Bases: Message
The RunWorkflowServiceRegisterOnActionExecutionIdChangedRequest class.
dataclass
#
RunWorkflowServiceRegisterOnActionExecutionIdChangedResponse(action_id: str = betterproto.string_field(1))
dataclass
#
RunWorkflowServiceRegisterOnWorkflowStateChangedRequest()
Bases: Message
The RunWorkflowServiceRegisterOnWorkflowStateChangedRequest class.
dataclass
#
RunWorkflowServiceRegisterOnWorkflowStateChangedResponse(workflow_state: WorkflowState = betterproto.enum_field(1))
Bases: Message
Response object of the RunWorkflowApi.
Attributes:
-
workflow_state(WorkflowState) –A Workflow state value.
class-attribute
instance-attribute
#
workflow_state: WorkflowState = enum_field(1)
A Workflow state value.
dataclass
#
RunWorkflowServiceResumeRequest()
Bases: Message
The RunWorkflowServiceResumeRequest class.
dataclass
#
RunWorkflowServiceResumeResponse()
Bases: Message
The RunWorkflowServiceResumeResponse class.
dataclass
#
RunWorkflowServiceRunWorkflowRequest(workflow_id: str = betterproto.string_field(1))
Bases: Message
The RunWorkflowServiceRunWorkflowRequest class.
Attributes:
-
workflow_id(str) –Identifier of the workflow which should be executed.
class-attribute
instance-attribute
#
workflow_id: str = string_field(1)
Identifier of the workflow which should be executed.
dataclass
#
RunWorkflowServiceRunWorkflowResponse(task_success: bool = betterproto.bool_field(1))
Bases: Message
Response object of the RunWorkflow method.
Attributes:
-
task_success(bool) –A value indicating whether the task to run workflow succeeded or not.
class-attribute
instance-attribute
#
task_success: bool = bool_field(1)
A value indicating whether the task to run workflow succeeded or not.
dataclass
#
RunWorkflowServiceSetNormalModeRequest()
Bases: Message
The RunWorkflowServiceSetNormalModeRequest class.
dataclass
#
RunWorkflowServiceSetNormalModeResponse()
Bases: Message
The RunWorkflowServiceSetNormalModeResponse class.
dataclass
#
RunWorkflowServiceSetStepModeRequest()
Bases: Message
The RunWorkflowServiceSetStepModeRequest class.
dataclass
#
RunWorkflowServiceSetStepModeResponse()
Bases: Message
The RunWorkflowServiceSetStepModeResponse class.
dataclass
#
RunWorkflowServiceStartRequest()
Bases: Message
The RunWorkflowServiceStartRequest class.
dataclass
#
RunWorkflowServiceStartResponse()
Bases: Message
The RunWorkflowServiceStartResponse class.
dataclass
#
RunWorkflowServiceStepRequest()
Bases: Message
The RunWorkflowServiceStepRequest class.
dataclass
#
RunWorkflowServiceStepResponse()
Bases: Message
The RunWorkflowServiceStepResponse class.
dataclass
#
RunWorkflowServiceStopEmergencyRequest()
Bases: Message
The RunWorkflowServiceStopEmergencyRequest class.
dataclass
#
RunWorkflowServiceStopEmergencyResponse()
Bases: Message
The RunWorkflowServiceStopEmergencyResponse class.
dataclass
#
RunWorkflowServiceStopRequest()
Bases: Message
The RunWorkflowServiceStopRequest class.
dataclass
#
RunWorkflowServiceStopResponse()
Bases: Message
The RunWorkflowServiceStopResponse class.
dataclass
#
WorkflowAdminServiceDeleteWorkflowByIdRequest(workflow_id: str = betterproto.string_field(1))
Bases: Message
The WorkflowAdminServiceDeleteWorkflowByIdRequest class.
Attributes:
-
workflow_id(str) –Identifier of the workflow which should be deleted.
class-attribute
instance-attribute
#
workflow_id: str = string_field(1)
Identifier of the workflow which should be deleted.
dataclass
#
WorkflowAdminServiceDeleteWorkflowByIdResponse()
Bases: Message
The WorkflowAdminServiceDeleteWorkflowByIdResponse class.
dataclass
#
WorkflowAdminServiceGetAvailableWorkflowIdsRequest()
Bases: Message
The WorkflowAdminServiceGetAvailableWorkflowIdsRequest class.
dataclass
#
WorkflowAdminServiceGetAvailableWorkflowIdsResponse(workflow_ids: List[str] = betterproto.string_field(1))
Bases: Message
Response object of the GetAvailableWorkflowsIds method.
Attributes:
-
workflow_ids(List[str]) –A value with workflow xml.
class-attribute
instance-attribute
#
workflow_ids: List[str] = string_field(1)
A value with workflow xml.