tvalentyn commented on code in PR #39293:
URL: https://github.com/apache/beam/pull/39293#discussion_r3631455374
##########
model/fn-execution/src/main/proto/org/apache/beam/model/fn_execution/v1/beam_fn_api.proto:
##########
@@ -869,6 +865,9 @@ service BeamFnData {
* State API
*/
+// A request sent by the SDK harness to the runner to get, append, or clear
Review Comment:
nit: we should not repeat things that are self-evident and can become stale
overtime. We could say something general `to manipulate state` perhaps.
##########
model/fn-execution/src/main/proto/org/apache/beam/model/fn_execution/v1/beam_fn_api.proto:
##########
@@ -1331,27 +1341,46 @@ service BeamFnLogging {
stream LogControl) {}
}
+// A request from the runner to start a new SDK worker process with the given
+// configuration, including endpoint addresses and parameters.
message StartWorkerRequest {
+ // (Required) A unique identifier for the worker to start.
string worker_id = 1;
+ // (Required) The control endpoint the worker should connect to.
org.apache.beam.model.pipeline.v1.ApiServiceDescriptor control_endpoint = 2;
+ // (Optional) The logging endpoint the worker should use.
org.apache.beam.model.pipeline.v1.ApiServiceDescriptor logging_endpoint = 3;
+ // (Optional) The artifact retrieval endpoint the worker should use.
org.apache.beam.model.pipeline.v1.ApiServiceDescriptor artifact_endpoint = 4;
+ // (Optional) The provisioning endpoint the worker should use.
org.apache.beam.model.pipeline.v1.ApiServiceDescriptor provision_endpoint =
5;
+ // (Optional) Additional runner-specific parameters to pass to the worker.
map<string, string> params = 10;
}
+// A response from a StartWorkerRequest. If the worker failed to start,
+// the error field will contain a human-readable error message.
message StartWorkerResponse {
+ // (Optional) Error message if the worker failed to start.
string error = 1;
}
+// A request from the runner to stop a running SDK worker process.
message StopWorkerRequest {
+ // (Required) The unique identifier of the worker to stop.
string worker_id = 1;
}
+// A response from a StopWorkerRequest. If the worker failed to stop
+// cleanly, the error field will contain a human-readable error message.
message StopWorkerResponse {
+ // (Optional) Error message if the worker failed to stop.
Review Comment:
```suggestion
// (Optional) Human-readable error message if the worker failed to stop.
```
##########
model/fn-execution/src/main/proto/org/apache/beam/model/fn_execution/v1/beam_fn_api.proto:
##########
@@ -1331,27 +1341,46 @@ service BeamFnLogging {
stream LogControl) {}
}
+// A request from the runner to start a new SDK worker process with the given
+// configuration, including endpoint addresses and parameters.
message StartWorkerRequest {
+ // (Required) A unique identifier for the worker to start.
string worker_id = 1;
+ // (Required) The control endpoint the worker should connect to.
org.apache.beam.model.pipeline.v1.ApiServiceDescriptor control_endpoint = 2;
+ // (Optional) The logging endpoint the worker should use.
org.apache.beam.model.pipeline.v1.ApiServiceDescriptor logging_endpoint = 3;
+ // (Optional) The artifact retrieval endpoint the worker should use.
org.apache.beam.model.pipeline.v1.ApiServiceDescriptor artifact_endpoint = 4;
+ // (Optional) The provisioning endpoint the worker should use.
org.apache.beam.model.pipeline.v1.ApiServiceDescriptor provision_endpoint =
5;
+ // (Optional) Additional runner-specific parameters to pass to the worker.
map<string, string> params = 10;
}
+// A response from a StartWorkerRequest. If the worker failed to start,
+// the error field will contain a human-readable error message.
message StartWorkerResponse {
+ // (Optional) Error message if the worker failed to start.
string error = 1;
}
+// A request from the runner to stop a running SDK worker process.
message StopWorkerRequest {
+ // (Required) The unique identifier of the worker to stop.
string worker_id = 1;
}
+// A response from a StopWorkerRequest. If the worker failed to stop
Review Comment:
nit: i'd remove 1374-1375 as self-evident or shorten to first sentence +
append content to the error as suggested
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
