Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document errors returned by Execution/WaitExecution #225

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion build/bazel/remote/execution/v2/remote_execution.proto
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,8 @@ service Execution {
//
// Errors discovered during creation of the `Operation` will be reported
// as gRPC Status errors, while errors that occurred while running the
// action will be reported in the `status` field of the `ExecuteResponse`. The
// action will be reported in the `status` field of the
// [ExecuteResponse][build.bazel.remote.execution.v2.ExecuteResponse]. The
// server MUST NOT set the `error` field of the `Operation` proto.
// The possible errors include:
//
Expand Down Expand Up @@ -120,6 +121,23 @@ service Execution {
// operation completes, and then respond with the completed operation. The
// server MAY choose to stream additional updates as execution progresses,
// such as to provide an update as to the state of the execution.
//
// Similarly to [Execute][build.bazel.remote.execution.v2.Execution.Execute],
// errors that occured while running the action will be reported in the
// `status` field of
// [ExecuteResponse][build.bazel.remote.execution.v2.ExecuteResponse].
// The possible errors include:
//
// * `NOT_FOUND`: The client requested an
// [Operation][google.longrunning.Operation] that is not known by the server
// (e.g., because
// [Execute][build.bazel.remote.execution.v2.Execution.Execute] never
// returned that value, because the action was already executed and returned
// the result, or because the action was cancelled explicitly using
// [google.longrunning.Operations.CancelOperation] or implicitly because there
// was no client waiting for the action to execute).
// * All errors returned by
// [Execute][build.bazel.remote.execution.v2.Execution.Execute].
rpc WaitExecution(WaitExecutionRequest) returns (stream google.longrunning.Operation) {
option (google.api.http) = { post: "/v2/{name=operations/**}:waitExecution" body: "*" };
}
Expand Down