xref: /aosp_15_r20/external/googleapis/google/devtools/build/v1/build_status.proto (revision d5c09012810ac0c9f33fe448fb6da8260d444cc9)
1// Copyright 2023 Google LLC
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15syntax = "proto3";
16
17package google.devtools.build.v1;
18
19import "google/protobuf/any.proto";
20import "google/protobuf/wrappers.proto";
21
22option cc_enable_arenas = true;
23option go_package = "google.golang.org/genproto/googleapis/devtools/build/v1;build";
24option java_multiple_files = true;
25option java_outer_classname = "BuildStatusProto";
26option java_package = "com.google.devtools.build.v1";
27option php_namespace = "Google\\Cloud\\Build\\V1";
28
29// Status used for both invocation attempt and overall build completion.
30message BuildStatus {
31  // The end result of the Build.
32  enum Result {
33    // Unspecified or unknown.
34    UNKNOWN_STATUS = 0;
35
36    // Build was successful and tests (if requested) all pass.
37    COMMAND_SUCCEEDED = 1;
38
39    // Build error and/or test failure.
40    COMMAND_FAILED = 2;
41
42    // Unable to obtain a result due to input provided by the user.
43    USER_ERROR = 3;
44
45    // Unable to obtain a result due to a failure within the build system.
46    SYSTEM_ERROR = 4;
47
48    // Build required too many resources, such as build tool RAM.
49    RESOURCE_EXHAUSTED = 5;
50
51    // An invocation attempt time exceeded its deadline.
52    INVOCATION_DEADLINE_EXCEEDED = 6;
53
54    // Build request time exceeded the request_deadline
55    REQUEST_DEADLINE_EXCEEDED = 8;
56
57    // The build was cancelled by a call to CancelBuild.
58    CANCELLED = 7;
59  }
60
61  // The end result.
62  Result result = 1;
63
64  // Final invocation ID of the build, if there was one.
65  // This field is only set on a status in BuildFinished event.
66  string final_invocation_id = 3;
67
68  // Build tool exit code. Integer value returned by the executed build tool.
69  // Might not be available in some cases, e.g., a build timeout.
70  google.protobuf.Int32Value build_tool_exit_code = 4;
71
72  // Human-readable error message. Do not use for programmatic purposes.
73  string error_message = 5;
74
75  // Fine-grained diagnostic information to complement the status.
76  google.protobuf.Any details = 2;
77}
78