Skip to content

Commit c723311

Browse files
Google APIscopybara-github
Google APIs
authored and
copybara-github
committed
docs: Comment clarifications feat: Add a BUILD.bazel file feat: Adding the ExportInvocation RPC method feat: Adding the SearchConfiguredTargets RPC method feat: Adding the BatchListActions RPC method feat: Adding the exit_code field to the Invocation proto PiperOrigin-RevId: 368018945
1 parent f46e9e5 commit c723311

18 files changed

Lines changed: 830 additions & 174 deletions

‎google/devtools/resultstore/v2/BUILD.bazel‎

Lines changed: 194 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,194 @@
1+
# This file was automatically generated by BuildFileGenerator
2+
3+
# This is an API workspace, having public visibility by default makes perfect sense.
4+
package(default_visibility = ["//visibility:public"])
5+
6+
##############################################################################
7+
# Common
8+
##############################################################################
9+
load("@rules_proto//proto:defs.bzl", "proto_library")
10+
11+
proto_library(
12+
name = "resultstore_proto",
13+
srcs = [
14+
"action.proto",
15+
"common.proto",
16+
"configuration.proto",
17+
"configured_target.proto",
18+
"coverage.proto",
19+
"coverage_summary.proto",
20+
"download_metadata.proto",
21+
"file.proto",
22+
"file_processing_error.proto",
23+
"file_set.proto",
24+
"invocation.proto",
25+
"resultstore_download.proto",
26+
"resultstore_file_download.proto",
27+
"resultstore_upload.proto",
28+
"target.proto",
29+
"test_suite.proto",
30+
"upload_metadata.proto",
31+
],
32+
deps = [
33+
"//google/api:annotations_proto",
34+
"//google/api:client_proto",
35+
"//google/api:field_behavior_proto",
36+
"//google/api:resource_proto",
37+
"@com_google_protobuf//:duration_proto",
38+
"@com_google_protobuf//:empty_proto",
39+
"@com_google_protobuf//:field_mask_proto",
40+
"@com_google_protobuf//:timestamp_proto",
41+
"@com_google_protobuf//:wrappers_proto",
42+
],
43+
)
44+
45+
##############################################################################
46+
# Java
47+
##############################################################################
48+
load(
49+
"@com_google_googleapis_imports//:imports.bzl",
50+
"java_grpc_library",
51+
"java_proto_library",
52+
)
53+
54+
java_proto_library(
55+
name = "resultstore_java_proto",
56+
deps = [":resultstore_proto"],
57+
)
58+
59+
java_grpc_library(
60+
name = "resultstore_java_grpc",
61+
srcs = [":resultstore_proto"],
62+
deps = [":resultstore_java_proto"],
63+
)
64+
65+
##############################################################################
66+
# Go
67+
##############################################################################
68+
load(
69+
"@com_google_googleapis_imports//:imports.bzl",
70+
"go_proto_library",
71+
)
72+
73+
go_proto_library(
74+
name = "resultstore_go_proto",
75+
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
76+
importpath = "google.golang.org/genproto/googleapis/devtools/resultstore/v2",
77+
protos = [":resultstore_proto"],
78+
deps = [
79+
"//google/api:annotations_go_proto",
80+
],
81+
)
82+
83+
##############################################################################
84+
# Python
85+
##############################################################################
86+
load(
87+
"@com_google_googleapis_imports//:imports.bzl",
88+
"moved_proto_library",
89+
"py_grpc_library",
90+
"py_proto_library",
91+
)
92+
93+
moved_proto_library(
94+
name = "resultstore_moved_proto",
95+
srcs = [":resultstore_proto"],
96+
deps = [
97+
"//google/api:annotations_proto",
98+
"//google/api:client_proto",
99+
"//google/api:field_behavior_proto",
100+
"//google/api:resource_proto",
101+
"@com_google_protobuf//:duration_proto",
102+
"@com_google_protobuf//:empty_proto",
103+
"@com_google_protobuf//:field_mask_proto",
104+
"@com_google_protobuf//:timestamp_proto",
105+
"@com_google_protobuf//:wrappers_proto",
106+
],
107+
)
108+
109+
py_proto_library(
110+
name = "resultstore_py_proto",
111+
plugin = "@protoc_docs_plugin//:docs_plugin",
112+
deps = [":resultstore_moved_proto"],
113+
)
114+
115+
py_grpc_library(
116+
name = "resultstore_py_grpc",
117+
srcs = [":resultstore_moved_proto"],
118+
deps = [":resultstore_py_proto"],
119+
)
120+
121+
##############################################################################
122+
# PHP
123+
##############################################################################
124+
load(
125+
"@com_google_googleapis_imports//:imports.bzl",
126+
"php_grpc_library",
127+
"php_proto_library",
128+
)
129+
130+
php_proto_library(
131+
name = "resultstore_php_proto",
132+
deps = [":resultstore_proto"],
133+
)
134+
135+
php_grpc_library(
136+
name = "resultstore_php_grpc",
137+
srcs = [":resultstore_proto"],
138+
deps = [":resultstore_php_proto"],
139+
)
140+
141+
##############################################################################
142+
# Node.js
143+
##############################################################################
144+
load(
145+
"@com_google_googleapis_imports//:imports.bzl",
146+
"nodejs_gapic_assembly_pkg",
147+
"nodejs_gapic_library",
148+
)
149+
150+
151+
##############################################################################
152+
# Ruby
153+
##############################################################################
154+
load(
155+
"@com_google_googleapis_imports//:imports.bzl",
156+
"ruby_grpc_library",
157+
"ruby_proto_library",
158+
)
159+
160+
ruby_proto_library(
161+
name = "resultstore_ruby_proto",
162+
deps = [":resultstore_proto"],
163+
)
164+
165+
ruby_grpc_library(
166+
name = "resultstore_ruby_grpc",
167+
srcs = [":resultstore_proto"],
168+
deps = [":resultstore_ruby_proto"],
169+
)
170+
171+
##############################################################################
172+
# C#
173+
##############################################################################
174+
load(
175+
"@com_google_googleapis_imports//:imports.bzl",
176+
"csharp_grpc_library",
177+
"csharp_proto_library",
178+
)
179+
180+
csharp_proto_library(
181+
name = "resultstore_csharp_proto",
182+
deps = [":resultstore_proto"],
183+
)
184+
185+
csharp_grpc_library(
186+
name = "resultstore_csharp_grpc",
187+
srcs = [":resultstore_proto"],
188+
deps = [":resultstore_csharp_proto"],
189+
)
190+
191+
##############################################################################
192+
# C++
193+
##############################################################################
194+
# Put your C++ code here

‎google/devtools/resultstore/v2/action.proto‎

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2019 Google LLC.
1+
// Copyright 2021 Google LLC
22
//
33
// Licensed under the Apache License, Version 2.0 (the "License");
44
// you may not use this file except in compliance with the License.
@@ -11,12 +11,12 @@
1111
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1212
// See the License for the specific language governing permissions and
1313
// limitations under the License.
14-
//
1514

1615
syntax = "proto3";
1716

1817
package google.devtools.resultstore.v2;
1918

19+
import "google/api/resource.proto";
2020
import "google/devtools/resultstore/v2/common.proto";
2121
import "google/devtools/resultstore/v2/coverage.proto";
2222
import "google/devtools/resultstore/v2/file.proto";
@@ -26,6 +26,7 @@ import "google/protobuf/duration.proto";
2626

2727
option go_package = "google.golang.org/genproto/googleapis/devtools/resultstore/v2;resultstore";
2828
option java_multiple_files = true;
29+
option java_outer_classname = "ActionProto";
2930
option java_package = "com.google.devtools.resultstore.v2";
3031

3132
// An action that happened as part of a configured target. This action could be
@@ -35,9 +36,14 @@ option java_package = "com.google.devtools.resultstore.v2";
3536
// Each parent ConfiguredTarget resource should have at least one Action as its
3637
// child resource before the invocation is finalized. For a simple build, at
3738
// least one build action should be created to represent the build result, and
38-
// at at least one test action should be created to represent the test result,
39-
// if any.
39+
// at least one test action should be created to represent the test result, if
40+
// any.
4041
message Action {
42+
option (google.api.resource) = {
43+
type: "resultstore.googleapis.com/Action"
44+
pattern: "invocations/{invocation}/targets/{target}/configuredTargets/{configured_target}/actions/{action}"
45+
};
46+
4147
// The resource ID components that identify the Action.
4248
message Id {
4349
// The Invocation ID.
@@ -179,7 +185,7 @@ message TestAction {
179185

180186
// If flaky tests are automatically retried, set this to indicate which
181187
// attempt this test action is for. (e.g. 0 for the first attempt, 1 for
182-
// second, and so on). Defaults to 0, which is appropriate if this is only
188+
// second, and so on). Defaults to 0, which is appropriate if this is the only
183189
// attempt.
184190
int32 attempt_number = 4;
185191

‎google/devtools/resultstore/v2/common.proto‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2019 Google LLC.
1+
// Copyright 2021 Google LLC
22
//
33
// Licensed under the Apache License, Version 2.0 (the "License");
44
// you may not use this file except in compliance with the License.
@@ -11,7 +11,6 @@
1111
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1212
// See the License for the specific language governing permissions and
1313
// limitations under the License.
14-
//
1514

1615
syntax = "proto3";
1716

@@ -22,6 +21,7 @@ import "google/protobuf/timestamp.proto";
2221

2322
option go_package = "google.golang.org/genproto/googleapis/devtools/resultstore/v2;resultstore";
2423
option java_multiple_files = true;
24+
option java_outer_classname = "CommonProto";
2525
option java_package = "com.google.devtools.resultstore.v2";
2626

2727
// Describes the status of a resource in both enum and string form.

‎google/devtools/resultstore/v2/configuration.proto‎

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2019 Google LLC.
1+
// Copyright 2021 Google LLC
22
//
33
// Licensed under the Apache License, Version 2.0 (the "License");
44
// you may not use this file except in compliance with the License.
@@ -11,22 +11,28 @@
1111
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1212
// See the License for the specific language governing permissions and
1313
// limitations under the License.
14-
//
1514

1615
syntax = "proto3";
1716

1817
package google.devtools.resultstore.v2;
1918

19+
import "google/api/resource.proto";
2020
import "google/devtools/resultstore/v2/common.proto";
2121

2222
option go_package = "google.golang.org/genproto/googleapis/devtools/resultstore/v2;resultstore";
2323
option java_multiple_files = true;
24+
option java_outer_classname = "ConfigurationProto";
2425
option java_package = "com.google.devtools.resultstore.v2";
2526

2627
// Represents a configuration within an Invocation associated with one or more
2728
// ConfiguredTargets. It captures the environment and other settings that
2829
// were used.
2930
message Configuration {
31+
option (google.api.resource) = {
32+
type: "resultstore.googleapis.com/Configuration"
33+
pattern: "invocations/{invocation}/configs/{config}"
34+
};
35+
3036
// The resource ID components that identify the Configuration.
3137
message Id {
3238
// The Invocation ID.
@@ -57,9 +63,9 @@ message Configuration {
5763
// the same key. Properties will be returned in lexicographical order by key.
5864
repeated Property properties = 6;
5965

60-
// A human-readable name for Configuration.
66+
// A human-readable name for Configuration for UIs.
6167
// It is recommended that this name be unique.
62-
// If omitted, the configuration_id should be used as display_name instead.
68+
// If omitted, UIs should default to configuration_id.
6369
string display_name = 8;
6470
}
6571

‎google/devtools/resultstore/v2/configured_target.proto‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2019 Google LLC.
1+
// Copyright 2021 Google LLC
22
//
33
// Licensed under the Apache License, Version 2.0 (the "License");
44
// you may not use this file except in compliance with the License.
@@ -11,18 +11,19 @@
1111
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1212
// See the License for the specific language governing permissions and
1313
// limitations under the License.
14-
//
1514

1615
syntax = "proto3";
1716

1817
package google.devtools.resultstore.v2;
1918

19+
import "google/api/resource.proto";
2020
import "google/devtools/resultstore/v2/common.proto";
2121
import "google/devtools/resultstore/v2/file.proto";
2222
import "google/protobuf/duration.proto";
2323

2424
option go_package = "google.golang.org/genproto/googleapis/devtools/resultstore/v2;resultstore";
2525
option java_multiple_files = true;
26+
option java_outer_classname = "ConfiguredTargetProto";
2627
option java_package = "com.google.devtools.resultstore.v2";
2728

2829
// Each ConfiguredTarget represents data for a given configuration of a given
@@ -31,6 +32,11 @@ option java_package = "com.google.devtools.resultstore.v2";
3132
// before the invocation is finalized. Refer to the Action's documentation for
3233
// more info on this.
3334
message ConfiguredTarget {
35+
option (google.api.resource) = {
36+
type: "resultstore.googleapis.com/ConfiguredTarget"
37+
pattern: "invocations/{invocation}/targets/{target}/configuredTargets/{configured_target}"
38+
};
39+
3440
// The resource ID components that identify the ConfiguredTarget.
3541
message Id {
3642
// The Invocation ID.

‎google/devtools/resultstore/v2/coverage.proto‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2019 Google LLC.
1+
// Copyright 2021 Google LLC
22
//
33
// Licensed under the Apache License, Version 2.0 (the "License");
44
// you may not use this file except in compliance with the License.
@@ -11,14 +11,14 @@
1111
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1212
// See the License for the specific language governing permissions and
1313
// limitations under the License.
14-
//
1514

1615
syntax = "proto3";
1716

1817
package google.devtools.resultstore.v2;
1918

2019
option go_package = "google.golang.org/genproto/googleapis/devtools/resultstore/v2;resultstore";
2120
option java_multiple_files = true;
21+
option java_outer_classname = "CoverageProto";
2222
option java_package = "com.google.devtools.resultstore.v2";
2323

2424
// Describes line coverage for a file
@@ -87,10 +87,10 @@ message FileCoverage {
8787
// Path of source file within the SourceContext of this Invocation.
8888
string path = 1;
8989

90-
// Details of lines in a file required to calculate line coverage.
90+
// Details of lines in a file for calculating line coverage.
9191
LineCoverage line_coverage = 2;
9292

93-
// Details of branches in a file required to calculate branch coverage.
93+
// Details of branches in a file for calculating branch coverage.
9494
BranchCoverage branch_coverage = 3;
9595
}
9696

0 commit comments

Comments
 (0)