Skip to content

Commit 72b7238

Browse files
Google APIscopybara-github
Google APIs
authored and
copybara-github
committed
docs: Updates documentation with regional resource names for multiple requests
docs: Removes references as a "global-only" service PiperOrigin-RevId: 652832022
1 parent f1bfd1d commit 72b7238

File tree

6 files changed

+331
-132
lines changed

6 files changed

+331
-132
lines changed

‎google/devtools/clouderrorreporting/v1beta1/BUILD.bazel‎

Lines changed: 120 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# This file was automatically generated by BuildFileGenerator
2-
# https://github.com/googleapis/gapic-generator/tree/master/rules_gapic/bazel
2+
# https://github.com/googleapis/rules_gapic/tree/master/bazel
33

44
# Most of the manual changes to this file will be overwritten.
55
# It's **only** allowed to change the following rule attribute values:
@@ -9,41 +9,17 @@
99
# * extra_protoc_file_parameters
1010
# The complete list of preserved parameters can be found in the source code.
1111

12+
# buildifier: disable=load-on-top
13+
14+
# This is an API workspace, having public visibility by default makes perfect sense.
15+
package(default_visibility = ["//visibility:public"])
16+
1217
##############################################################################
1318
# Common
1419
##############################################################################
20+
# buildifier: disable=same-origin-load
21+
load("@com_google_googleapis_imports//:imports.bzl", "proto_library_with_info")
1522
load("@rules_proto//proto:defs.bzl", "proto_library")
16-
load(
17-
"@com_google_googleapis_imports//:imports.bzl",
18-
"csharp_gapic_assembly_pkg",
19-
"csharp_gapic_library",
20-
"csharp_grpc_library",
21-
"csharp_proto_library",
22-
"go_gapic_assembly_pkg",
23-
"go_gapic_library",
24-
"go_proto_library",
25-
"java_gapic_assembly_gradle_pkg",
26-
"java_gapic_library",
27-
"java_gapic_test",
28-
"java_grpc_library",
29-
"java_proto_library",
30-
"nodejs_gapic_assembly_pkg",
31-
"nodejs_gapic_library",
32-
"php_gapic_assembly_pkg",
33-
"php_gapic_library",
34-
"php_proto_library",
35-
"proto_library_with_info",
36-
"py_gapic_assembly_pkg",
37-
"py_gapic_library",
38-
"py_test",
39-
"ruby_cloud_gapic_library",
40-
"ruby_gapic_assembly_pkg",
41-
"ruby_grpc_library",
42-
"ruby_proto_library",
43-
)
44-
45-
# This is an API workspace, having public visibility by default makes perfect sense.
46-
package(default_visibility = ["//visibility:public"])
4723

4824
proto_library(
4925
name = "clouderrorreporting_proto",
@@ -71,6 +47,19 @@ proto_library_with_info(
7147
],
7248
)
7349

50+
##############################################################################
51+
# Java
52+
##############################################################################
53+
# buildifier: disable=same-origin-load
54+
load(
55+
"@com_google_googleapis_imports//:imports.bzl",
56+
"java_gapic_assembly_gradle_pkg",
57+
"java_gapic_library",
58+
"java_gapic_test",
59+
"java_grpc_library",
60+
"java_proto_library",
61+
)
62+
7463
java_proto_library(
7564
name = "clouderrorreporting_java_proto",
7665
deps = [":clouderrorreporting_proto"],
@@ -85,6 +74,7 @@ java_grpc_library(
8574
java_gapic_library(
8675
name = "clouderrorreporting_java_gapic",
8776
srcs = [":clouderrorreporting_proto_with_info"],
77+
gapic_yaml = None,
8878
grpc_service_config = "errorreporting_grpc_service_config.json",
8979
rest_numeric_enums = True,
9080
service_yaml = "clouderrorreporting_v1beta1.yaml",
@@ -94,6 +84,7 @@ java_gapic_library(
9484
transport = "grpc+rest",
9585
deps = [
9686
":clouderrorreporting_java_proto",
87+
"//google/api:api_java_proto",
9788
],
9889
)
9990

@@ -123,6 +114,17 @@ java_gapic_assembly_gradle_pkg(
123114
],
124115
)
125116

117+
##############################################################################
118+
# Go
119+
##############################################################################
120+
# buildifier: disable=same-origin-load
121+
load(
122+
"@com_google_googleapis_imports//:imports.bzl",
123+
"go_gapic_assembly_pkg",
124+
"go_gapic_library",
125+
"go_proto_library",
126+
)
127+
126128
go_proto_library(
127129
name = "clouderrorreporting_go_proto",
128130
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
@@ -139,6 +141,8 @@ go_gapic_library(
139141
srcs = [":clouderrorreporting_proto_with_info"],
140142
grpc_service_config = "errorreporting_grpc_service_config.json",
141143
importpath = "cloud.google.com/go/errorreporting/apiv1beta1;errorreporting",
144+
metadata = True,
145+
release_level = "beta",
142146
rest_numeric_enums = True,
143147
service_yaml = "clouderrorreporting_v1beta1.yaml",
144148
transport = "grpc+rest",
@@ -153,12 +157,24 @@ go_gapic_assembly_pkg(
153157
name = "gapi-cloud-devtools-clouderrorreporting-v1beta1-go",
154158
deps = [
155159
":clouderrorreporting_go_gapic",
160+
":clouderrorreporting_go_gapic_srcjar-metadata.srcjar",
156161
":clouderrorreporting_go_gapic_srcjar-snippets.srcjar",
157162
":clouderrorreporting_go_gapic_srcjar-test.srcjar",
158163
":clouderrorreporting_go_proto",
159164
],
160165
)
161166

167+
##############################################################################
168+
# Python
169+
##############################################################################
170+
# buildifier: disable=same-origin-load
171+
load(
172+
"@com_google_googleapis_imports//:imports.bzl",
173+
"py_gapic_assembly_pkg",
174+
"py_gapic_library",
175+
"py_test",
176+
)
177+
162178
py_gapic_library(
163179
name = "clouderrorreporting_py_gapic",
164180
srcs = [":clouderrorreporting_proto"],
@@ -171,6 +187,8 @@ py_gapic_library(
171187
rest_numeric_enums = True,
172188
service_yaml = "clouderrorreporting_v1beta1.yaml",
173189
transport = "grpc+rest",
190+
deps = [
191+
],
174192
)
175193

176194
py_test(
@@ -191,6 +209,17 @@ py_gapic_assembly_pkg(
191209
],
192210
)
193211

212+
##############################################################################
213+
# PHP
214+
##############################################################################
215+
# buildifier: disable=same-origin-load
216+
load(
217+
"@com_google_googleapis_imports//:imports.bzl",
218+
"php_gapic_assembly_pkg",
219+
"php_gapic_library",
220+
"php_proto_library",
221+
)
222+
194223
php_proto_library(
195224
name = "clouderrorreporting_php_proto",
196225
deps = [":clouderrorreporting_proto"],
@@ -204,7 +233,9 @@ php_gapic_library(
204233
rest_numeric_enums = True,
205234
service_yaml = "clouderrorreporting_v1beta1.yaml",
206235
transport = "grpc+rest",
207-
deps = [":clouderrorreporting_php_proto"],
236+
deps = [
237+
":clouderrorreporting_php_proto",
238+
],
208239
)
209240

210241
# Open Source Packages
@@ -216,6 +247,16 @@ php_gapic_assembly_pkg(
216247
],
217248
)
218249

250+
##############################################################################
251+
# Node.js
252+
##############################################################################
253+
# buildifier: disable=same-origin-load
254+
load(
255+
"@com_google_googleapis_imports//:imports.bzl",
256+
"nodejs_gapic_assembly_pkg",
257+
"nodejs_gapic_library",
258+
)
259+
219260
nodejs_gapic_library(
220261
name = "clouderrorreporting_nodejs_gapic",
221262
package_name = "@google-cloud/clouderrorreporting",
@@ -237,6 +278,18 @@ nodejs_gapic_assembly_pkg(
237278
],
238279
)
239280

281+
##############################################################################
282+
# Ruby
283+
##############################################################################
284+
# buildifier: disable=same-origin-load
285+
load(
286+
"@com_google_googleapis_imports//:imports.bzl",
287+
"ruby_cloud_gapic_library",
288+
"ruby_gapic_assembly_pkg",
289+
"ruby_grpc_library",
290+
"ruby_proto_library",
291+
)
292+
240293
ruby_proto_library(
241294
name = "clouderrorreporting_ruby_proto",
242295
deps = [":clouderrorreporting_proto"],
@@ -252,11 +305,11 @@ ruby_cloud_gapic_library(
252305
name = "clouderrorreporting_ruby_gapic",
253306
srcs = [":clouderrorreporting_proto_with_info"],
254307
extra_protoc_parameters = [
255-
"ruby-cloud-gem-name=google-cloud-error_reporting-v1beta1",
256-
"ruby-cloud-env-prefix=ERROR_REPORTING",
257-
"ruby-cloud-product-url=https://cloud.google.com/error-reporting",
258308
"ruby-cloud-api-id=clouderrorreporting.googleapis.com",
259309
"ruby-cloud-api-shortname=clouderrorreporting",
310+
"ruby-cloud-env-prefix=ERROR_REPORTING",
311+
"ruby-cloud-gem-name=google-cloud-error_reporting-v1beta1",
312+
"ruby-cloud-product-url=https://cloud.google.com/error-reporting",
260313
],
261314
grpc_service_config = "errorreporting_grpc_service_config.json",
262315
rest_numeric_enums = True,
@@ -280,8 +333,21 @@ ruby_gapic_assembly_pkg(
280333
],
281334
)
282335

336+
##############################################################################
337+
# C#
338+
##############################################################################
339+
# buildifier: disable=same-origin-load
340+
load(
341+
"@com_google_googleapis_imports//:imports.bzl",
342+
"csharp_gapic_assembly_pkg",
343+
"csharp_gapic_library",
344+
"csharp_grpc_library",
345+
"csharp_proto_library",
346+
)
347+
283348
csharp_proto_library(
284349
name = "clouderrorreporting_csharp_proto",
350+
extra_opts = [],
285351
deps = [":clouderrorreporting_proto"],
286352
)
287353

@@ -318,4 +384,21 @@ csharp_gapic_assembly_pkg(
318384
##############################################################################
319385
# C++
320386
##############################################################################
321-
# Put your C++ rules here
387+
# buildifier: disable=same-origin-load
388+
load(
389+
"@com_google_googleapis_imports//:imports.bzl",
390+
"cc_grpc_library",
391+
"cc_proto_library",
392+
)
393+
394+
cc_proto_library(
395+
name = "clouderrorreporting_cc_proto",
396+
deps = [":clouderrorreporting_proto"],
397+
)
398+
399+
cc_grpc_library(
400+
name = "clouderrorreporting_cc_grpc",
401+
srcs = [":clouderrorreporting_proto"],
402+
grpc_only = True,
403+
deps = [":clouderrorreporting_cc_proto"],
404+
)

‎google/devtools/clouderrorreporting/v1beta1/clouderrorreporting_v1beta1.yaml‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,6 @@ documentation:
1919
{% include "_shared/apis/console/_local_variables.html" %}
2020
{% include "cloud/_shared/_cloud_shared_files.html" %}
2121
22-
{% dynamic setvar launch_stage %}beta{% dynamic endsetvar %}
23-
{% dynamic include /docs/includes/___info_launch_stage_disclaimer %}
24-
2522
The {{error_reporting_api}} provides:
2623
2724
* A simple

‎google/devtools/clouderrorreporting/v1beta1/common.proto‎

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,17 +36,38 @@ message ErrorGroup {
3636
};
3737

3838
// The group resource name.
39-
// Example: <code>projects/my-project-123/groups/CNSgkpnppqKCUw</code>
39+
// Written as `projects/{projectID}/groups/{group_id}` or
40+
// `projects/{projectID}/locations/{location}/groups/{group_id}`
41+
//
42+
// Examples: `projects/my-project-123/groups/my-group`,
43+
// `projects/my-project-123/locations/us-central1/groups/my-group`
44+
//
45+
// In the group resource name, the `group_id` is a unique identifier for a
46+
// particular error group. The identifier is derived from key parts of the
47+
// error-log content and is treated as Service Data. For information about
48+
// how Service Data is handled, see [Google Cloud Privacy
49+
// Notice](https://cloud.google.com/terms/cloud-privacy-notice).
50+
//
51+
// For a list of supported locations, see [Supported
52+
// Regions](https://cloud.google.com/logging/docs/region-support). `global` is
53+
// the default when unspecified.
4054
string name = 1;
4155

42-
// Group IDs are unique for a given project. If the same kind of error
43-
// occurs in different service contexts, it will receive the same group ID.
56+
// An opaque identifier of the group. This field is assigned by the Error
57+
// Reporting system and always populated.
58+
//
59+
// In the group resource name, the `group_id` is a unique identifier for a
60+
// particular error group. The identifier is derived from key parts of the
61+
// error-log content and is treated as Service Data. For information about
62+
// how Service Data is handled, see [Google Cloud Privacy
63+
// Notice](https://cloud.google.com/terms/cloud-privacy-notice).
4464
string group_id = 2;
4565

4666
// Associated tracking issues.
4767
repeated TrackingIssue tracking_issues = 3;
4868

4969
// Error group's resolution status.
70+
//
5071
// An unspecified resolution status will be interpreted as OPEN
5172
ResolutionStatus resolution_status = 5;
5273
}

‎google/devtools/clouderrorreporting/v1beta1/error_group_service.proto‎

Lines changed: 26 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,16 @@ option ruby_package = "Google::Cloud::ErrorReporting::V1beta1";
3434
// Service for retrieving and updating individual error groups.
3535
service ErrorGroupService {
3636
option (google.api.default_host) = "clouderrorreporting.googleapis.com";
37-
option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
37+
option (google.api.oauth_scopes) =
38+
"https://www.googleapis.com/auth/cloud-platform";
3839

3940
// Get the specified group.
4041
rpc GetGroup(GetGroupRequest) returns (ErrorGroup) {
4142
option (google.api.http) = {
4243
get: "/v1beta1/{group_name=projects/*/groups/*}"
44+
additional_bindings {
45+
get: "/v1beta1/{group_name=projects/*/locations/*/groups/*}"
46+
}
4347
};
4448
option (google.api.method_signature) = "group_name";
4549
}
@@ -50,19 +54,36 @@ service ErrorGroupService {
5054
option (google.api.http) = {
5155
put: "/v1beta1/{group.name=projects/*/groups/*}"
5256
body: "group"
57+
additional_bindings {
58+
put: "/v1beta1/{group.name=projects/*/locations/*/groups/*}"
59+
body: "group"
60+
}
5361
};
5462
option (google.api.method_signature) = "group";
5563
}
5664
}
5765

5866
// A request to return an individual group.
5967
message GetGroupRequest {
60-
// Required. The group resource name. Written as
61-
// `projects/{projectID}/groups/{group_name}`. Call
62-
// [`groupStats.list`](https://cloud.google.com/error-reporting/reference/rest/v1beta1/projects.groupStats/list)
68+
// Required. The group resource name. Written as either
69+
// `projects/{projectID}/groups/{group_id}` or
70+
// `projects/{projectID}/locations/{location}/groups/{group_id}`. Call
71+
// [groupStats.list]
72+
// [google.devtools.clouderrorreporting.v1beta1.ErrorStatsService.ListGroupStats]
6373
// to return a list of groups belonging to this project.
6474
//
65-
// Example: `projects/my-project-123/groups/my-group`
75+
// Examples: `projects/my-project-123/groups/my-group`,
76+
// `projects/my-project-123/locations/global/groups/my-group`
77+
//
78+
// In the group resource name, the `group_id` is a unique identifier for a
79+
// particular error group. The identifier is derived from key parts of the
80+
// error-log content and is treated as Service Data. For information about
81+
// how Service Data is handled, see [Google Cloud Privacy
82+
// Notice](https://cloud.google.com/terms/cloud-privacy-notice).
83+
//
84+
// For a list of supported locations, see [Supported
85+
// Regions](https://cloud.google.com/logging/docs/region-support). `global` is
86+
// the default when unspecified.
6687
string group_name = 1 [
6788
(google.api.field_behavior) = REQUIRED,
6889
(google.api.resource_reference) = {

0 commit comments

Comments
 (0)