error_group_service.proto 3.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778
  1. // Copyright 2021 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. syntax = "proto3";
  15. package google.devtools.clouderrorreporting.v1beta1;
  16. import "google/api/annotations.proto";
  17. import "google/api/client.proto";
  18. import "google/api/field_behavior.proto";
  19. import "google/api/resource.proto";
  20. import "google/devtools/clouderrorreporting/v1beta1/common.proto";
  21. option cc_enable_arenas = true;
  22. option csharp_namespace = "Google.Cloud.ErrorReporting.V1Beta1";
  23. option go_package = "google.golang.org/genproto/googleapis/devtools/clouderrorreporting/v1beta1;clouderrorreporting";
  24. option java_multiple_files = true;
  25. option java_outer_classname = "ErrorGroupServiceProto";
  26. option java_package = "com.google.devtools.clouderrorreporting.v1beta1";
  27. option php_namespace = "Google\\Cloud\\ErrorReporting\\V1beta1";
  28. option ruby_package = "Google::Cloud::ErrorReporting::V1beta1";
  29. // Service for retrieving and updating individual error groups.
  30. service ErrorGroupService {
  31. option (google.api.default_host) = "clouderrorreporting.googleapis.com";
  32. option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
  33. // Get the specified group.
  34. rpc GetGroup(GetGroupRequest) returns (ErrorGroup) {
  35. option (google.api.http) = {
  36. get: "/v1beta1/{group_name=projects/*/groups/*}"
  37. };
  38. option (google.api.method_signature) = "group_name";
  39. }
  40. // Replace the data for the specified group.
  41. // Fails if the group does not exist.
  42. rpc UpdateGroup(UpdateGroupRequest) returns (ErrorGroup) {
  43. option (google.api.http) = {
  44. put: "/v1beta1/{group.name=projects/*/groups/*}"
  45. body: "group"
  46. };
  47. option (google.api.method_signature) = "group";
  48. }
  49. }
  50. // A request to return an individual group.
  51. message GetGroupRequest {
  52. // Required. The group resource name. Written as
  53. // `projects/{projectID}/groups/{group_name}`. Call
  54. // [`groupStats.list`](https://cloud.google.com/error-reporting/reference/rest/v1beta1/projects.groupStats/list)
  55. // to return a list of groups belonging to this project.
  56. //
  57. // Example: `projects/my-project-123/groups/my-group`
  58. string group_name = 1 [
  59. (google.api.field_behavior) = REQUIRED,
  60. (google.api.resource_reference) = {
  61. type: "clouderrorreporting.googleapis.com/ErrorGroup"
  62. }
  63. ];
  64. }
  65. // A request to replace the existing data for the given group.
  66. message UpdateGroupRequest {
  67. // Required. The group which replaces the resource on the server.
  68. ErrorGroup group = 1 [(google.api.field_behavior) = REQUIRED];
  69. }