google-cloud-error_reporting-v1beta1 0.1.0

data/lib/google/devtools/clouderrorreporting/v1beta1/report_errors_service_pb.rb

@@ -0,0 +1,39 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/devtools/clouderrorreporting/v1beta1/report_errors_service.proto
+
+require 'google/protobuf'
+
+require 'google/api/annotations_pb'
+require 'google/api/client_pb'
+require 'google/api/field_behavior_pb'
+require 'google/api/resource_pb'
+require 'google/devtools/clouderrorreporting/v1beta1/common_pb'
+require 'google/protobuf/timestamp_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/devtools/clouderrorreporting/v1beta1/report_errors_service.proto", :syntax => :proto3) do
+    add_message "google.devtools.clouderrorreporting.v1beta1.ReportErrorEventRequest" do
+      optional :project_name, :string, 1
+      optional :event, :message, 2, "google.devtools.clouderrorreporting.v1beta1.ReportedErrorEvent"
+    end
+    add_message "google.devtools.clouderrorreporting.v1beta1.ReportErrorEventResponse" do
+    end
+    add_message "google.devtools.clouderrorreporting.v1beta1.ReportedErrorEvent" do
+      optional :event_time, :message, 1, "google.protobuf.Timestamp"
+      optional :service_context, :message, 2, "google.devtools.clouderrorreporting.v1beta1.ServiceContext"
+      optional :message, :string, 3
+      optional :context, :message, 4, "google.devtools.clouderrorreporting.v1beta1.ErrorContext"
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module ErrorReporting
+      module V1beta1
+        ReportErrorEventRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.devtools.clouderrorreporting.v1beta1.ReportErrorEventRequest").msgclass
+        ReportErrorEventResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.devtools.clouderrorreporting.v1beta1.ReportErrorEventResponse").msgclass
+        ReportedErrorEvent = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.devtools.clouderrorreporting.v1beta1.ReportedErrorEvent").msgclass
+      end
+    end
+  end
+end

data/lib/google/devtools/clouderrorreporting/v1beta1/report_errors_service_services_pb.rb

@@ -0,0 +1,54 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: google/devtools/clouderrorreporting/v1beta1/report_errors_service.proto for package 'Google.Cloud.ErrorReporting.V1beta1'
+# Original file comments:
+# Copyright 2019 Google LLC.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+#
+
+require 'grpc'
+require 'google/devtools/clouderrorreporting/v1beta1/report_errors_service_pb'
+
+module Google
+  module Cloud
+    module ErrorReporting
+      module V1beta1
+        module ReportErrorsService
+          # An API for reporting error events.
+          class Service
+
+            include GRPC::GenericService
+
+            self.marshal_class_method = :encode
+            self.unmarshal_class_method = :decode
+            self.service_name = 'google.devtools.clouderrorreporting.v1beta1.ReportErrorsService'
+
+            # Report an individual error event.
+            #
+            # This endpoint accepts **either** an OAuth token,
+            # **or** an [API key](https://support.google.com/cloud/answer/6158862)
+            # for authentication. To use an API key, append it to the URL as the value of
+            # a `key` parameter. For example:
+            #
+            # `POST
+            # https://clouderrorreporting.googleapis.com/v1beta1/projects/example-project/events:report?key=123ABC456`
+            rpc :ReportErrorEvent, Google::Cloud::ErrorReporting::V1beta1::ReportErrorEventRequest, Google::Cloud::ErrorReporting::V1beta1::ReportErrorEventResponse
+          end
+
+          Stub = Service.rpc_stub_class
+        end
+      end
+    end
+  end
+end

data/proto_docs/README.md

@@ -0,0 +1,4 @@
+# Cloud Error Reporting V1beta1 Protocol Buffer Documentation
+
+These files are for the YARD documentation of the generated protobuf files.
+They are not intended to be required or loaded at runtime.

data/proto_docs/google/api/field_behavior.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Api
+    # An indicator of the behavior of a given field (for example, that a field
+    # is required in requests, or given as output but ignored as input).
+    # This **does not** change the behavior in protocol buffers itself; it only
+    # denotes the behavior and may affect how API tooling handles the field.
+    #
+    # Note: This enum **may** receive new values in the future.
+    module FieldBehavior
+      # Conventional default for enums. Do not use this.
+      FIELD_BEHAVIOR_UNSPECIFIED = 0
+
+      # Specifically denotes a field as optional.
+      # While all fields in protocol buffers are optional, this may be specified
+      # for emphasis if appropriate.
+      OPTIONAL = 1
+
+      # Denotes a field as required.
+      # This indicates that the field **must** be provided as part of the request,
+      # and failure to do so will cause an error (usually `INVALID_ARGUMENT`).
+      REQUIRED = 2
+
+      # Denotes a field as output only.
+      # This indicates that the field is provided in responses, but including the
+      # field in a request does nothing (the server *must* ignore it and
+      # *must not* throw an error as a result of the field's presence).
+      OUTPUT_ONLY = 3
+
+      # Denotes a field as input only.
+      # This indicates that the field is provided in requests, and the
+      # corresponding field is not included in output.
+      INPUT_ONLY = 4
+
+      # Denotes a field as immutable.
+      # This indicates that the field may be set once in a request to create a
+      # resource, but may not be changed thereafter.
+      IMMUTABLE = 5
+    end
+  end
+end

data/proto_docs/google/api/resource.rb

@@ -0,0 +1,247 @@
+# frozen_string_literal: true
+
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Api
+    # A simple descriptor of a resource type.
+    #
+    # ResourceDescriptor annotates a resource message (either by means of a
+    # protobuf annotation or use in the service config), and associates the
+    # resource's schema, the resource type, and the pattern of the resource name.
+    #
+    # Example:
+    #
+    #     message Topic {
+    #       // Indicates this message defines a resource schema.
+    #       // Declares the resource type in the format of {service}/{kind}.
+    #       // For Kubernetes resources, the format is {api group}/{kind}.
+    #       option (google.api.resource) = {
+    #         type: "pubsub.googleapis.com/Topic"
+    #         name_descriptor: {
+    #           pattern: "projects/{project}/topics/{topic}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #           parent_name_extractor: "projects/{project}"
+    #         }
+    #       };
+    #     }
+    #
+    # The ResourceDescriptor Yaml config will look like:
+    #
+    #    resources:
+    #    - type: "pubsub.googleapis.com/Topic"
+    #      name_descriptor:
+    #        - pattern: "projects/\\{project}/topics/\\{topic}"
+    #          parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #          parent_name_extractor: "projects/\\{project}"
+    #
+    # Sometimes, resources have multiple patterns, typically because they can
+    # live under multiple parents.
+    #
+    # Example:
+    #
+    #     message LogEntry {
+    #       option (google.api.resource) = {
+    #         type: "logging.googleapis.com/LogEntry"
+    #         name_descriptor: {
+    #           pattern: "projects/{project}/logs/{log}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #           parent_name_extractor: "projects/{project}"
+    #         }
+    #         name_descriptor: {
+    #           pattern: "folders/{folder}/logs/{log}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
+    #           parent_name_extractor: "folders/{folder}"
+    #         }
+    #         name_descriptor: {
+    #           pattern: "organizations/{organization}/logs/{log}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Organization"
+    #           parent_name_extractor: "organizations/{organization}"
+    #         }
+    #         name_descriptor: {
+    #           pattern: "billingAccounts/{billing_account}/logs/{log}"
+    #           parent_type: "billing.googleapis.com/BillingAccount"
+    #           parent_name_extractor: "billingAccounts/{billing_account}"
+    #         }
+    #       };
+    #     }
+    #
+    # The ResourceDescriptor Yaml config will look like:
+    #
+    #     resources:
+    #     - type: 'logging.googleapis.com/LogEntry'
+    #       name_descriptor:
+    #         - pattern: "projects/{project}/logs/{log}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #           parent_name_extractor: "projects/{project}"
+    #         - pattern: "folders/{folder}/logs/{log}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
+    #           parent_name_extractor: "folders/{folder}"
+    #         - pattern: "organizations/{organization}/logs/{log}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Organization"
+    #           parent_name_extractor: "organizations/{organization}"
+    #         - pattern: "billingAccounts/{billing_account}/logs/{log}"
+    #           parent_type: "billing.googleapis.com/BillingAccount"
+    #           parent_name_extractor: "billingAccounts/{billing_account}"
+    #
+    # For flexible resources, the resource name doesn't contain parent names, but
+    # the resource itself has parents for policy evaluation.
+    #
+    # Example:
+    #
+    #     message Shelf {
+    #       option (google.api.resource) = {
+    #         type: "library.googleapis.com/Shelf"
+    #         name_descriptor: {
+    #           pattern: "shelves/{shelf}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #         }
+    #         name_descriptor: {
+    #           pattern: "shelves/{shelf}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
+    #         }
+    #       };
+    #     }
+    #
+    # The ResourceDescriptor Yaml config will look like:
+    #
+    #     resources:
+    #     - type: 'library.googleapis.com/Shelf'
+    #       name_descriptor:
+    #         - pattern: "shelves/{shelf}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #         - pattern: "shelves/{shelf}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
+    # @!attribute [rw] type
+    #   @return [::String]
+    #     The resource type. It must be in the format of
+    #     \\{service_name}/\\{resource_type_kind}. The `resource_type_kind` must be
+    #     singular and must not include version numbers.
+    #
+    #     Example: `storage.googleapis.com/Bucket`
+    #
+    #     The value of the resource_type_kind must follow the regular expression
+    #     /[A-Za-z][a-zA-Z0-9]+/. It should start with an upper case character and
+    #     should use PascalCase (UpperCamelCase). The maximum number of
+    #     characters allowed for the `resource_type_kind` is 100.
+    # @!attribute [rw] pattern
+    #   @return [::Array<::String>]
+    #     Optional. The relative resource name pattern associated with this resource
+    #     type. The DNS prefix of the full resource name shouldn't be specified here.
+    #
+    #     The path pattern must follow the syntax, which aligns with HTTP binding
+    #     syntax:
+    #
+    #         Template = Segment { "/" Segment } ;
+    #         Segment = LITERAL | Variable ;
+    #         Variable = "{" LITERAL "}" ;
+    #
+    #     Examples:
+    #
+    #         - "projects/\\{project}/topics/\\{topic}"
+    #         - "projects/\\{project}/knowledgeBases/\\{knowledge_base}"
+    #
+    #     The components in braces correspond to the IDs for each resource in the
+    #     hierarchy. It is expected that, if multiple patterns are provided,
+    #     the same component name (e.g. "project") refers to IDs of the same
+    #     type of resource.
+    # @!attribute [rw] name_field
+    #   @return [::String]
+    #     Optional. The field on the resource that designates the resource name
+    #     field. If omitted, this is assumed to be "name".
+    # @!attribute [rw] history
+    #   @return [::Google::Api::ResourceDescriptor::History]
+    #     Optional. The historical or future-looking state of the resource pattern.
+    #
+    #     Example:
+    #
+    #         // The InspectTemplate message originally only supported resource
+    #         // names with organization, and project was added later.
+    #         message InspectTemplate {
+    #           option (google.api.resource) = {
+    #             type: "dlp.googleapis.com/InspectTemplate"
+    #             pattern:
+    #             "organizations/{organization}/inspectTemplates/{inspect_template}"
+    #             pattern: "projects/{project}/inspectTemplates/{inspect_template}"
+    #             history: ORIGINALLY_SINGLE_PATTERN
+    #           };
+    #         }
+    # @!attribute [rw] plural
+    #   @return [::String]
+    #     The plural name used in the resource name, such as 'projects' for
+    #     the name of 'projects/\\{project}'. It is the same concept of the `plural`
+    #     field in k8s CRD spec
+    #     https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
+    # @!attribute [rw] singular
+    #   @return [::String]
+    #     The same concept of the `singular` field in k8s CRD spec
+    #     https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
+    #     Such as "project" for the `resourcemanager.googleapis.com/Project` type.
+    class ResourceDescriptor
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+
+      # A description of the historical or future-looking state of the
+      # resource pattern.
+      module History
+        # The "unset" value.
+        HISTORY_UNSPECIFIED = 0
+
+        # The resource originally had one pattern and launched as such, and
+        # additional patterns were added later.
+        ORIGINALLY_SINGLE_PATTERN = 1
+
+        # The resource has one pattern, but the API owner expects to add more
+        # later. (This is the inverse of ORIGINALLY_SINGLE_PATTERN, and prevents
+        # that from being necessary once there are multiple patterns.)
+        FUTURE_MULTI_PATTERN = 2
+      end
+    end
+
+    # Defines a proto annotation that describes a string field that refers to
+    # an API resource.
+    # @!attribute [rw] type
+    #   @return [::String]
+    #     The resource type that the annotated field references.
+    #
+    #     Example:
+    #
+    #         message Subscription {
+    #           string topic = 2 [(google.api.resource_reference) = {
+    #             type: "pubsub.googleapis.com/Topic"
+    #           }];
+    #         }
+    # @!attribute [rw] child_type
+    #   @return [::String]
+    #     The resource type of a child collection that the annotated field
+    #     references. This is useful for annotating the `parent` field that
+    #     doesn't have a fixed resource type.
+    #
+    #     Example:
+    #
+    #       message ListLogEntriesRequest {
+    #         string parent = 1 [(google.api.resource_reference) = {
+    #           child_type: "logging.googleapis.com/LogEntry"
+    #         };
+    #       }
+    class ResourceReference
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

data/proto_docs/google/devtools/clouderrorreporting/v1beta1/common.rb

@@ -0,0 +1,183 @@
+# frozen_string_literal: true
+
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module ErrorReporting
+      module V1beta1
+        # Description of a group of similar error events.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     The group resource name.
+        #     Example: <code>projects/my-project-123/groups/my-groupid</code>
+        # @!attribute [rw] group_id
+        #   @return [::String]
+        #     Group IDs are unique for a given project. If the same kind of error
+        #     occurs in different service contexts, it will receive the same group ID.
+        # @!attribute [rw] tracking_issues
+        #   @return [::Array<::Google::Cloud::ErrorReporting::V1beta1::TrackingIssue>]
+        #     Associated tracking issues.
+        class ErrorGroup
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Information related to tracking the progress on resolving the error.
+        # @!attribute [rw] url
+        #   @return [::String]
+        #     A URL pointing to a related entry in an issue tracking system.
+        #     Example: `https://github.com/user/project/issues/4`
+        class TrackingIssue
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # An error event which is returned by the Error Reporting system.
+        # @!attribute [rw] event_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Time when the event occurred as provided in the error report.
+        #     If the report did not contain a timestamp, the time the error was received
+        #     by the Error Reporting system is used.
+        # @!attribute [rw] service_context
+        #   @return [::Google::Cloud::ErrorReporting::V1beta1::ServiceContext]
+        #     The `ServiceContext` for which this error was reported.
+        # @!attribute [rw] message
+        #   @return [::String]
+        #     The stack trace that was reported or logged by the service.
+        # @!attribute [rw] context
+        #   @return [::Google::Cloud::ErrorReporting::V1beta1::ErrorContext]
+        #     Data about the context in which the error occurred.
+        class ErrorEvent
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Describes a running service that sends errors.
+        # Its version changes over time and multiple versions can run in parallel.
+        # @!attribute [rw] service
+        #   @return [::String]
+        #     An identifier of the service, such as the name of the
+        #     executable, job, or Google App Engine service name. This field is expected
+        #     to have a low number of values that are relatively stable over time, as
+        #     opposed to `version`, which can be changed whenever new code is deployed.
+        #
+        #     Contains the service name for error reports extracted from Google
+        #     App Engine logs or `default` if the App Engine default service is used.
+        # @!attribute [rw] version
+        #   @return [::String]
+        #     Represents the source code version that the developer provided,
+        #     which could represent a version label or a Git SHA-1 hash, for example.
+        #     For App Engine standard environment, the version is set to the version of
+        #     the app.
+        # @!attribute [rw] resource_type
+        #   @return [::String]
+        #     Type of the MonitoredResource. List of possible values:
+        #     https://cloud.google.com/monitoring/api/resources
+        #
+        #     Value is set automatically for incoming errors and must not be set when
+        #     reporting errors.
+        class ServiceContext
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A description of the context in which an error occurred.
+        # This data should be provided by the application when reporting an error,
+        # unless the
+        # error report has been generated automatically from Google App Engine logs.
+        # @!attribute [rw] http_request
+        #   @return [::Google::Cloud::ErrorReporting::V1beta1::HttpRequestContext]
+        #     The HTTP request which was processed when the error was
+        #     triggered.
+        # @!attribute [rw] user
+        #   @return [::String]
+        #     The user who caused or was affected by the crash.
+        #     This can be a user ID, an email address, or an arbitrary token that
+        #     uniquely identifies the user.
+        #     When sending an error report, leave this field empty if the user was not
+        #     logged in. In this case the
+        #     Error Reporting system will use other data, such as remote IP address, to
+        #     distinguish affected users. See `affected_users_count` in
+        #     `ErrorGroupStats`.
+        # @!attribute [rw] report_location
+        #   @return [::Google::Cloud::ErrorReporting::V1beta1::SourceLocation]
+        #     The location in the source code where the decision was made to
+        #     report the error, usually the place where it was logged.
+        #     For a logged exception this would be the source line where the
+        #     exception is logged, usually close to the place where it was
+        #     caught.
+        class ErrorContext
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # HTTP request data that is related to a reported error.
+        # This data should be provided by the application when reporting an error,
+        # unless the
+        # error report has been generated automatically from Google App Engine logs.
+        # @!attribute [rw] method
+        #   @return [::String]
+        #     The type of HTTP request, such as `GET`, `POST`, etc.
+        # @!attribute [rw] url
+        #   @return [::String]
+        #     The URL of the request.
+        # @!attribute [rw] user_agent
+        #   @return [::String]
+        #     The user agent information that is provided with the request.
+        # @!attribute [rw] referrer
+        #   @return [::String]
+        #     The referrer information that is provided with the request.
+        # @!attribute [rw] response_status_code
+        #   @return [::Integer]
+        #     The HTTP response status code for the request.
+        # @!attribute [rw] remote_ip
+        #   @return [::String]
+        #     The IP address from which the request originated.
+        #     This can be IPv4, IPv6, or a token which is derived from the
+        #     IP address, depending on the data that has been provided
+        #     in the error report.
+        class HttpRequestContext
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Indicates a location in the source code of the service for which errors are
+        # reported. `functionName` must be provided by the application when reporting
+        # an error, unless the error report contains a `message` with a supported
+        # exception stack trace. All fields are optional for the later case.
+        # @!attribute [rw] file_path
+        #   @return [::String]
+        #     The source code filename, which can include a truncated relative
+        #     path, or a full path from a production machine.
+        # @!attribute [rw] line_number
+        #   @return [::Integer]
+        #     1-based. 0 indicates that the line number is unknown.
+        # @!attribute [rw] function_name
+        #   @return [::String]
+        #     Human-readable name of a function or method.
+        #     The value can include optional context like the class or package name.
+        #     For example, `my.package.MyClass.method` in case of Java.
+        class SourceLocation
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end