package org.apache.amber.engine.architecture.rpc

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc ConsoleMessageTriggered (ConsoleMessageTriggeredRequest, EmptyReturn)

  controllerservice.proto:38

• rpc ControllerInitiateQueryStatistics (QueryStatisticsRequest, EmptyReturn)

  controllerservice.proto:46

• rpc DebugCommand (DebugCommandRequest, EmptyReturn)

  controllerservice.proto:36

• rpc EvaluatePythonExpression (EvaluatePythonExpressionRequest, EvaluatePythonExpressionResponse)

  controllerservice.proto:37

• rpc LinkWorkers (LinkWorkersRequest, EmptyReturn)

  controllerservice.proto:45

• rpc PauseWorkflow (EmptyRequest, EmptyReturn)

  controllerservice.proto:42

• rpc PortCompleted (PortCompletedRequest, EmptyReturn)

  controllerservice.proto:39

• rpc PropagateEmbeddedControlMessage (PropagateEmbeddedControlMessageRequest, PropagateEmbeddedControlMessageResponse)

  controllerservice.proto:34

• rpc ResumeWorkflow (EmptyRequest, EmptyReturn)

  controllerservice.proto:41

• rpc RetrieveWorkflowState (EmptyRequest, RetrieveWorkflowStateResponse)

  controllerservice.proto:33

• rpc RetryWorkflow (RetryWorkflowRequest, EmptyReturn)

  controllerservice.proto:47

• rpc StartWorkflow (EmptyRequest, StartWorkflowResponse)

  controllerservice.proto:40

• rpc TakeGlobalCheckpoint (TakeGlobalCheckpointRequest, TakeGlobalCheckpointResponse)

  controllerservice.proto:35

• rpc WorkerExecutionCompleted (EmptyRequest, EmptyReturn)

  controllerservice.proto:44

• rpc WorkerStateUpdated (WorkerStateUpdatedRequest, EmptyReturn)

  controllerservice.proto:43

• rpc SendChain (Chain, StringResponse)

  testerservice.proto:42

• rpc SendCollect (Collect, StringResponse)

  testerservice.proto:39

• rpc SendErrorCommand (ErrorCommand, StringResponse)

  testerservice.proto:37

• rpc SendGenerateNumber (GenerateNumber, IntResponse)

  testerservice.proto:40

• rpc SendMultiCall (MultiCall, StringResponse)

  testerservice.proto:41

• rpc SendNested (Nested, StringResponse)

  testerservice.proto:35

• rpc SendPass (Pass, StringResponse)

  testerservice.proto:36

• rpc SendPing (Ping, IntResponse)

  testerservice.proto:33

• rpc SendPong (Pong, IntResponse)

  testerservice.proto:34

• rpc SendRecursion (Recursion, StringResponse)

  testerservice.proto:38

RPC Service

• rpc AddInputChannel (AddInputChannelRequest, EmptyReturn)

  workerservice.proto:33

• rpc AddPartitioning (AddPartitioningRequest, EmptyReturn)

  workerservice.proto:34

• rpc AssignPort (AssignPortRequest, EmptyReturn)

  workerservice.proto:35

• rpc DebugCommand (DebugCommandRequest, EmptyReturn)

  workerservice.proto:50

• rpc EndChannel (EmptyRequest, EmptyReturn)

  workerservice.proto:49

• rpc EndWorker (EmptyRequest, EmptyReturn)

  workerservice.proto:47

• rpc EvaluatePythonExpression (EvaluatePythonExpressionRequest, EvaluatedValue)

  workerservice.proto:51

• rpc FinalizeCheckpoint (FinalizeCheckpointRequest, FinalizeCheckpointResponse)

  workerservice.proto:36

• rpc FlushNetworkBuffer (EmptyRequest, EmptyReturn)

  workerservice.proto:37

• rpc InitializeExecutor (InitializeExecutorRequest, EmptyReturn)

  workerservice.proto:38

• rpc NoOperation (EmptyRequest, EmptyReturn)

  workerservice.proto:52

• rpc OpenExecutor (EmptyRequest, EmptyReturn)

  workerservice.proto:39

• rpc PauseWorker (EmptyRequest, WorkerStateResponse)

  workerservice.proto:40

• rpc PrepareCheckpoint (PrepareCheckpointRequest, EmptyReturn)

  workerservice.proto:41

• rpc QueryStatistics (EmptyRequest, WorkerMetricsResponse)

  workerservice.proto:42

• rpc ResumeWorker (EmptyRequest, WorkerStateResponse)

  workerservice.proto:43

• rpc RetrieveState (EmptyRequest, EmptyReturn)

  workerservice.proto:44

• rpc RetryCurrentTuple (EmptyRequest, EmptyReturn)

  workerservice.proto:45

• rpc StartChannel (EmptyRequest, EmptyReturn)

  workerservice.proto:48

• rpc StartWorker (EmptyRequest, WorkerStateResponse)

  workerservice.proto:46

Messages for the commands

Used as request type in: WorkerService.AddInputChannel

Used as field type in: ControlRequest

• optional core.ChannelIdentity channelId = 1

• optional core.PortIdentity portId = 2

Used as request type in: WorkerService.AddPartitioning

Used as field type in: ControlRequest

• optional core.PhysicalLink tag = 1

• optional sendsemantics.Partitioning partitioning = 2

Used as request type in: WorkerService.AssignPort

Used as field type in: ControlRequest

• optional core.PortIdentity portId = 1

• bool input = 2

• map<string, string> schema = 3

• repeated string storageUris = 4

• repeated sendsemantics.Partitioning partitionings = 5

Used in: ControlInvocation

• optional core.ActorVirtualIdentity sender = 1

• optional core.ActorVirtualIdentity receiver = 2

Chain message

Used as request type in: RPCTester.SendChain

Used as field type in: ControlRequest

• repeated core.ActorVirtualIdentity nexts = 1

Collect message

Used as request type in: RPCTester.SendCollect

Used as field type in: ControlRequest

• repeated core.ActorVirtualIdentity workers = 1

Used in: ConsoleMessageTriggeredRequest, common.OperatorConsole

• string worker_id = 1

• optional google.protobuf.Timestamp timestamp = 2

• ConsoleMessageType msg_type = 3

• string source = 4

• string title = 5

• string message = 6

Used as request type in: ControllerService.ConsoleMessageTriggered

Used as field type in: ControlRequest

• optional ConsoleMessage consoleMessage = 1

Used in: ConsoleMessage

• PRINT = 0

• ERROR = 1

• COMMAND = 2

• DEBUGGER = 3

Used in: ControlReturn

• string errorMessage = 1

• string errorDetails = 2

• string stackTrace = 3

• ErrorLanguage language = 4

Used in: EmbeddedControlMessage, common.DirectControlMessagePayloadV2

• string methodName = 1

• optional ControlRequest command = 2

• optional AsyncRPCContext context = 3

• int64 commandId = 4

Used in: ControlInvocation, PropagateEmbeddedControlMessageRequest

• oneof sealed_value

  • PropagateEmbeddedControlMessageRequest propagateEmbeddedControlMessageRequest = 1

    request for controller

  • TakeGlobalCheckpointRequest takeGlobalCheckpointRequest = 2

  • DebugCommandRequest debugCommandRequest = 3

  • EvaluatePythonExpressionRequest evaluatePythonExpressionRequest = 4

  • ModifyLogicRequest modifyLogicRequest = 5

  • RetryWorkflowRequest retryWorkflowRequest = 6

  • ConsoleMessageTriggeredRequest consoleMessageTriggeredRequest = 8

  • PortCompletedRequest portCompletedRequest = 9

  • WorkerStateUpdatedRequest workerStateUpdatedRequest = 10

  • LinkWorkersRequest linkWorkersRequest = 11

  • AddInputChannelRequest addInputChannelRequest = 50

    request for worker

  • AddPartitioningRequest addPartitioningRequest = 51

  • AssignPortRequest assignPortRequest = 52

  • FinalizeCheckpointRequest finalizeCheckpointRequest = 53

  • InitializeExecutorRequest initializeExecutorRequest = 54

  • UpdateExecutorRequest updateExecutorRequest = 55

  • EmptyRequest emptyRequest = 56

  • PrepareCheckpointRequest prepareCheckpointRequest = 57

  • QueryStatisticsRequest queryStatisticsRequest = 58

  • Ping ping = 100

    request for testing

  • Pong pong = 101

  • Nested nested = 102

  • Pass pass = 103

  • ErrorCommand errorCommand = 104

  • Recursion recursion = 105

  • Collect collect = 106

  • GenerateNumber generateNumber = 107

  • MultiCall multiCall = 108

  • Chain chain = 109

The generic return message

Used in: PropagateEmbeddedControlMessageResponse, ReturnInvocation

• oneof sealed_value

  Oneof block for various return types

  • RetrieveWorkflowStateResponse retrieveWorkflowStateResponse = 1

    controller responses

  • PropagateEmbeddedControlMessageResponse propagateEmbeddedControlMessageResponse = 2

  • TakeGlobalCheckpointResponse takeGlobalCheckpointResponse = 3

  • EvaluatePythonExpressionResponse evaluatePythonExpressionResponse = 4

  • StartWorkflowResponse startWorkflowResponse = 5

  • WorkerStateResponse workerStateResponse = 50

    worker responses

  • WorkerMetricsResponse workerMetricsResponse = 51

  • FinalizeCheckpointResponse finalizeCheckpointResponse = 52

  • ControlError controlError = 101

    common responses

  • EmptyReturn emptyReturn = 102

  • StringResponse stringResponse = 103

  • IntResponse intResponse = 104

Used as request type in: ControllerService.DebugCommand, WorkerService.DebugCommand

Used as field type in: ControlRequest

• string workerId = 1

• string cmd = 2

• optional core.EmbeddedControlMessageIdentity id = 1

• EmbeddedControlMessageType ecm_type = 2

• repeated core.ChannelIdentity scope = 3

• map<string, ControlInvocation> commandMapping = 4

Used in: EmbeddedControlMessage, PropagateEmbeddedControlMessageRequest

• ALL_ALIGNMENT = 0

• NO_ALIGNMENT = 1

• PORT_ALIGNMENT = 2

Used as request type in: ControllerService.PauseWorkflow, ControllerService.ResumeWorkflow, ControllerService.RetrieveWorkflowState, ControllerService.StartWorkflow, ControllerService.WorkerExecutionCompleted, WorkerService.EndChannel, WorkerService.EndWorker, WorkerService.FlushNetworkBuffer, WorkerService.NoOperation, WorkerService.OpenExecutor, WorkerService.PauseWorker, WorkerService.QueryStatistics, WorkerService.ResumeWorker, WorkerService.RetrieveState, WorkerService.RetryCurrentTuple, WorkerService.StartChannel, WorkerService.StartWorker

Used as field type in: ControlRequest

(message has no fields)

Used as response type in: ControllerService.ConsoleMessageTriggered, ControllerService.ControllerInitiateQueryStatistics, ControllerService.DebugCommand, ControllerService.LinkWorkers, ControllerService.PauseWorkflow, ControllerService.PortCompleted, ControllerService.ResumeWorkflow, ControllerService.RetryWorkflow, ControllerService.WorkerExecutionCompleted, ControllerService.WorkerStateUpdated, WorkerService.AddInputChannel, WorkerService.AddPartitioning, WorkerService.AssignPort, WorkerService.DebugCommand, WorkerService.EndChannel, WorkerService.EndWorker, WorkerService.FlushNetworkBuffer, WorkerService.InitializeExecutor, WorkerService.NoOperation, WorkerService.OpenExecutor, WorkerService.PrepareCheckpoint, WorkerService.RetrieveState, WorkerService.RetryCurrentTuple, WorkerService.StartChannel

Used as field type in: ControlReturn

(message has no fields)

ErrorCommand message

Used as request type in: RPCTester.SendErrorCommand

Used as field type in: ControlRequest

(message has no fields)

Used in: ControlError

• PYTHON = 0

• SCALA = 1

Used as request type in: ControllerService.EvaluatePythonExpression, WorkerService.EvaluatePythonExpression

Used as field type in: ControlRequest

• string expression = 1

• string operatorId = 2

Used as response type in: ControllerService.EvaluatePythonExpression

Used as field type in: ControlReturn

• repeated EvaluatedValue values = 1

Used as response type in: WorkerService.EvaluatePythonExpression

Used as field type in: EvaluatePythonExpressionResponse, common.EvaluatedValueList

• optional TypedValue value = 1

• repeated TypedValue attributes = 2

Used as request type in: WorkerService.FinalizeCheckpoint

Used as field type in: ControlRequest

• optional core.EmbeddedControlMessageIdentity checkpointId = 1

• string writeTo = 2

Used as response type in: WorkerService.FinalizeCheckpoint

Used as field type in: ControlReturn

• int64 size = 1

GenerateNumber message

Used as request type in: RPCTester.SendGenerateNumber

Used as field type in: ControlRequest

(message has no fields)

Used as request type in: WorkerService.InitializeExecutor

Used as field type in: ControlRequest

• int32 totalWorkerCount = 1

• optional core.OpExecInitInfo opExecInitInfo = 2

• bool isSource = 3

Used as response type in: RPCTester.SendGenerateNumber, RPCTester.SendPing, RPCTester.SendPong

Used as field type in: ControlReturn

• int32 value = 1

Used as request type in: ControllerService.LinkWorkers

Used as field type in: ControlRequest

• optional core.PhysicalLink link = 1

Used in: ControlRequest, WorkflowReconfigureRequest

• repeated UpdateExecutorRequest updateRequest = 1

MultiCall message

Used as request type in: RPCTester.SendMultiCall

Used as field type in: ControlRequest

• repeated core.ActorVirtualIdentity seq = 1

Nested message

Used as request type in: RPCTester.SendNested

Used as field type in: ControlRequest

• int32 k = 1

Pass message

Used as request type in: RPCTester.SendPass

Used as field type in: ControlRequest

• string value = 1

Ping message

Used as request type in: RPCTester.SendPing

Used as field type in: ControlRequest

• int32 i = 1

• int32 end = 2

• optional core.ActorVirtualIdentity to = 3

Pong message

Used as request type in: RPCTester.SendPong

Used as field type in: ControlRequest

• int32 i = 1

• int32 end = 2

• optional core.ActorVirtualIdentity to = 3

Used as request type in: ControllerService.PortCompleted

Used as field type in: ControlRequest

• optional core.PortIdentity portId = 1

• bool input = 2

Used as request type in: WorkerService.PrepareCheckpoint

Used as field type in: ControlRequest

• optional core.EmbeddedControlMessageIdentity checkpointId = 1

• bool estimationOnly = 2

Used as request type in: ControllerService.PropagateEmbeddedControlMessage

Used as field type in: ControlRequest

• repeated core.PhysicalOpIdentity sourceOpToStartProp = 1

• optional core.EmbeddedControlMessageIdentity id = 2

• EmbeddedControlMessageType ecm_type = 3

• repeated core.PhysicalOpIdentity scope = 4

• repeated core.PhysicalOpIdentity targetOps = 5

• optional ControlRequest command = 6

• string methodName = 7

Used as response type in: ControllerService.PropagateEmbeddedControlMessage

Used as field type in: ControlReturn

• map<string, ControlReturn> returns = 1

Used as request type in: ControllerService.ControllerInitiateQueryStatistics

Used as field type in: ControlRequest

• repeated core.ActorVirtualIdentity filterByWorkers = 1

Recursion message

Used as request type in: RPCTester.SendRecursion

Used as field type in: ControlRequest

• int32 i = 1

Used as response type in: ControllerService.RetrieveWorkflowState

Used as field type in: ControlReturn

• map<string, string> state = 1

Used as request type in: ControllerService.RetryWorkflow

Used as field type in: ControlRequest

• repeated core.ActorVirtualIdentity workers = 1

Used in: common.DirectControlMessagePayloadV2

• int64 commandId = 1

• optional ControlReturn returnValue = 2

Used as response type in: ControllerService.StartWorkflow

Used as field type in: ControlReturn

• WorkflowAggregatedState workflowState = 1

Used as response type in: RPCTester.SendChain, RPCTester.SendCollect, RPCTester.SendErrorCommand, RPCTester.SendMultiCall, RPCTester.SendNested, RPCTester.SendPass, RPCTester.SendRecursion

Used as field type in: ControlReturn

• string value = 1

Used as request type in: ControllerService.TakeGlobalCheckpoint

Used as field type in: ControlRequest

• bool estimationOnly = 1

• optional core.EmbeddedControlMessageIdentity checkpointId = 2

• string destination = 3

Used as response type in: ControllerService.TakeGlobalCheckpoint

Used as field type in: ControlReturn

• int64 totalSize = 1

Used in: EvaluatedValue

• string expression = 1

• string value_ref = 2

• string value_str = 3

• string value_type = 4

• bool expandable = 5

Used in: ControlRequest, ModifyLogicRequest

• optional core.PhysicalOpIdentity targetOpId = 1

• optional google.protobuf.Any newExecutor = 2

• optional google.protobuf.Any stateTransferFunc = 3

Used as response type in: WorkerService.QueryStatistics

Used as field type in: ControlReturn

• optional worker.WorkerMetrics metrics = 1

Used as response type in: WorkerService.PauseWorker, WorkerService.ResumeWorker, WorkerService.StartWorker

Used as field type in: ControlReturn

• worker.WorkerState state = 1

Used as request type in: ControllerService.WorkerStateUpdated

Used as field type in: ControlRequest

• worker.WorkerState state = 1

Used in: StartWorkflowResponse, common.ExecutionMetadataStore, common.OperatorMetrics

• UNINITIALIZED = 0

• READY = 1

• RUNNING = 2

• PAUSING = 3

• PAUSED = 4

• RESUMING = 5

• COMPLETED = 6

• FAILED = 7

• UNKNOWN = 8

• KILLED = 9

• TERMINATED = 10

• optional ModifyLogicRequest reconfiguration = 1

• string reconfigurationId = 2