projects/my-
- project-123/groups/CNSgkpnppqKCUw
- group_id (str):
- 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.
- tracking_issues (Sequence[google.cloud.errorreporting_v1beta1.types.TrackingIssue]):
- Associated tracking issues.
- resolution_status (google.cloud.errorreporting_v1beta1.types.ResolutionStatus):
- Error group's resolution status.
- An unspecified resolution status will be
- interpreted as OPEN
- """
-
- name = proto.Field(proto.STRING, number=1,)
- group_id = proto.Field(proto.STRING, number=2,)
- tracking_issues = proto.RepeatedField(
- proto.MESSAGE, number=3, message="TrackingIssue",
- )
- resolution_status = proto.Field(proto.ENUM, number=5, enum="ResolutionStatus",)
-
-
-class TrackingIssue(proto.Message):
- r"""Information related to tracking the progress on resolving the
- error.
-
- Attributes:
- url (str):
- A URL pointing to a related entry in an issue tracking
- system. Example:
- ``https://github.com/user/project/issues/4``
- """
-
- url = proto.Field(proto.STRING, number=1,)
-
-
-class ErrorEvent(proto.Message):
- r"""An error event which is returned by the Error Reporting
- system.
-
- Attributes:
- event_time (google.protobuf.timestamp_pb2.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.
- service_context (google.cloud.errorreporting_v1beta1.types.ServiceContext):
- The ``ServiceContext`` for which this error was reported.
- message (str):
- The stack trace that was reported or logged
- by the service.
- context (google.cloud.errorreporting_v1beta1.types.ErrorContext):
- Data about the context in which the error
- occurred.
- """
-
- event_time = proto.Field(proto.MESSAGE, number=1, message=timestamp_pb2.Timestamp,)
- service_context = proto.Field(proto.MESSAGE, number=2, message="ServiceContext",)
- message = proto.Field(proto.STRING, number=3,)
- context = proto.Field(proto.MESSAGE, number=5, message="ErrorContext",)
-
-
-class ServiceContext(proto.Message):
- r"""Describes a running service that sends errors.
- Its version changes over time and multiple versions can run in
- parallel.
-
- Attributes:
- service (str):
- 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.
- version (str):
- 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.
- resource_type (str):
- 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.
- """
-
- service = proto.Field(proto.STRING, number=2,)
- version = proto.Field(proto.STRING, number=3,)
- resource_type = proto.Field(proto.STRING, number=4,)
-
-
-class ErrorContext(proto.Message):
- r"""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.
-
- Attributes:
- http_request (google.cloud.errorreporting_v1beta1.types.HttpRequestContext):
- The HTTP request which was processed when the
- error was triggered.
- user (str):
- 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``.
- report_location (google.cloud.errorreporting_v1beta1.types.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.
- """
-
- http_request = proto.Field(proto.MESSAGE, number=1, message="HttpRequestContext",)
- user = proto.Field(proto.STRING, number=2,)
- report_location = proto.Field(proto.MESSAGE, number=3, message="SourceLocation",)
-
-
-class HttpRequestContext(proto.Message):
- r"""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.
-
- Attributes:
- method (str):
- The type of HTTP request, such as ``GET``, ``POST``, etc.
- url (str):
- The URL of the request.
- user_agent (str):
- The user agent information that is provided
- with the request.
- referrer (str):
- The referrer information that is provided
- with the request.
- response_status_code (int):
- The HTTP response status code for the
- request.
- remote_ip (str):
- 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.
- """
-
- method = proto.Field(proto.STRING, number=1,)
- url = proto.Field(proto.STRING, number=2,)
- user_agent = proto.Field(proto.STRING, number=3,)
- referrer = proto.Field(proto.STRING, number=4,)
- response_status_code = proto.Field(proto.INT32, number=5,)
- remote_ip = proto.Field(proto.STRING, number=6,)
-
-
-class SourceLocation(proto.Message):
- r"""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.
-
- Attributes:
- file_path (str):
- The source code filename, which can include a
- truncated relative path, or a full path from a
- production machine.
- line_number (int):
- 1-based. 0 indicates that the line number is
- unknown.
- function_name (str):
- 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.
- """
-
- file_path = proto.Field(proto.STRING, number=1,)
- line_number = proto.Field(proto.INT32, number=2,)
- function_name = proto.Field(proto.STRING, number=4,)
-
-
-__all__ = tuple(sorted(__protobuf__.manifest))
diff --git a/google/cloud/errorreporting_v1beta1/types/error_group_service.py b/google/cloud/errorreporting_v1beta1/types/error_group_service.py
deleted file mode 100644
index 5fdcf766..00000000
--- a/google/cloud/errorreporting_v1beta1/types/error_group_service.py
+++ /dev/null
@@ -1,55 +0,0 @@
-# -*- coding: utf-8 -*-
-# 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
-#
-# 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.
-#
-import proto # type: ignore
-
-from google.cloud.errorreporting_v1beta1.types import common
-
-
-__protobuf__ = proto.module(
- package="google.devtools.clouderrorreporting.v1beta1",
- manifest={"GetGroupRequest", "UpdateGroupRequest",},
-)
-
-
-class GetGroupRequest(proto.Message):
- r"""A request to return an individual group.
-
- Attributes:
- group_name (str):
- Required. The group resource name. Written as
- ``projects/{projectID}/groups/{group_name}``. Call
- ```groupStats.list`` ErrorGroupStats with these IDs.
- service_filter (google.cloud.errorreporting_v1beta1.types.ServiceContextFilter):
- Optional. List only
- ErrorGroupStats which belong to a
- service context that matches the filter. Data
- for all service contexts is returned if this
- field is not specified.
- time_range (google.cloud.errorreporting_v1beta1.types.QueryTimeRange):
- Optional. List data for the given time range. If not set, a
- default time range is used. The field time_range_begin in
- the response will specify the beginning of this time range.
- Only ErrorGroupStats with a non-zero count in the given time
- range are returned, unless the request contains an explicit
- group_id list. If a group_id list is given, also
- ErrorGroupStats with zero occurrences are returned.
- timed_count_duration (google.protobuf.duration_pb2.Duration):
- Optional. The preferred duration for a single returned
- ``TimedCount``. If not set, no timed counts are returned.
- alignment (google.cloud.errorreporting_v1beta1.types.TimedCountAlignment):
- Optional. The alignment of the timed counts to be returned.
- Default is ``ALIGNMENT_EQUAL_AT_END``.
- alignment_time (google.protobuf.timestamp_pb2.Timestamp):
- Optional. Time where the timed counts shall
- be aligned if rounded alignment is chosen.
- Default is 00:00 UTC.
- order (google.cloud.errorreporting_v1beta1.types.ErrorGroupOrder):
- Optional. The sort order in which the results are returned.
- Default is ``COUNT_DESC``.
- page_size (int):
- Optional. The maximum number of results to
- return per response. Default is 20.
- page_token (str):
- Optional. A ``next_page_token`` provided by a previous
- response. To view additional results, pass this token along
- with the identical query parameters as the first request.
- """
-
- project_name = proto.Field(proto.STRING, number=1,)
- group_id = proto.RepeatedField(proto.STRING, number=2,)
- service_filter = proto.Field(
- proto.MESSAGE, number=3, message="ServiceContextFilter",
- )
- time_range = proto.Field(proto.MESSAGE, number=5, message="QueryTimeRange",)
- timed_count_duration = proto.Field(
- proto.MESSAGE, number=6, message=duration_pb2.Duration,
- )
- alignment = proto.Field(proto.ENUM, number=7, enum="TimedCountAlignment",)
- alignment_time = proto.Field(
- proto.MESSAGE, number=8, message=timestamp_pb2.Timestamp,
- )
- order = proto.Field(proto.ENUM, number=9, enum="ErrorGroupOrder",)
- page_size = proto.Field(proto.INT32, number=11,)
- page_token = proto.Field(proto.STRING, number=12,)
-
-
-class ListGroupStatsResponse(proto.Message):
- r"""Contains a set of requested error group stats.
-
- Attributes:
- error_group_stats (Sequence[google.cloud.errorreporting_v1beta1.types.ErrorGroupStats]):
- The error group stats which match the given
- request.
- next_page_token (str):
- If non-empty, more results are available.
- Pass this token, along with the same query
- parameters as the first request, to view the
- next page of results.
- time_range_begin (google.protobuf.timestamp_pb2.Timestamp):
- The timestamp specifies the start time to
- which the request was restricted. The start time
- is set based on the requested time range. It may
- be adjusted to a later time if a project has
- exceeded the storage quota and older data has
- been deleted.
- """
-
- @property
- def raw_page(self):
- return self
-
- error_group_stats = proto.RepeatedField(
- proto.MESSAGE, number=1, message="ErrorGroupStats",
- )
- next_page_token = proto.Field(proto.STRING, number=2,)
- time_range_begin = proto.Field(
- proto.MESSAGE, number=4, message=timestamp_pb2.Timestamp,
- )
-
-
-class ErrorGroupStats(proto.Message):
- r"""Data extracted for a specific group based on certain filter
- criteria, such as a given time period and/or service filter.
-
- Attributes:
- group (google.cloud.errorreporting_v1beta1.types.ErrorGroup):
- Group data that is independent of the filter
- criteria.
- count (int):
- Approximate total number of events in the
- given group that match the filter criteria.
- affected_users_count (int):
- Approximate number of affected users in the given group that
- match the filter criteria. Users are distinguished by data
- in the ``ErrorContext`` of the individual error events, such
- as their login name or their remote IP address in case of
- HTTP requests. The number of affected users can be zero even
- if the number of errors is non-zero if no data was provided
- from which the affected user could be deduced. Users are
- counted based on data in the request context that was
- provided in the error report. If more users are implicitly
- affected, such as due to a crash of the whole service, this
- is not reflected here.
- timed_counts (Sequence[google.cloud.errorreporting_v1beta1.types.TimedCount]):
- Approximate number of occurrences over time.
- Timed counts returned by ListGroups are
- guaranteed to be:
- - Inside the requested time interval
- - Non-overlapping, and
- - Ordered by ascending time.
- first_seen_time (google.protobuf.timestamp_pb2.Timestamp):
- Approximate first occurrence that was ever seen for this
- group and which matches the given filter criteria, ignoring
- the time_range that was specified in the request.
- last_seen_time (google.protobuf.timestamp_pb2.Timestamp):
- Approximate last occurrence that was ever seen for this
- group and which matches the given filter criteria, ignoring
- the time_range that was specified in the request.
- affected_services (Sequence[google.cloud.errorreporting_v1beta1.types.ServiceContext]):
- Service contexts with a non-zero error count for the given
- filter criteria. This list can be truncated if multiple
- services are affected. Refer to ``num_affected_services``
- for the total count.
- num_affected_services (int):
- The total number of services with a non-zero
- error count for the given filter criteria.
- representative (google.cloud.errorreporting_v1beta1.types.ErrorEvent):
- An arbitrary event that is chosen as
- representative for the whole group. The
- representative event is intended to be used as a
- quick preview for the whole group. Events in the
- group are usually sufficiently similar to each
- other such that showing an arbitrary
- representative provides insight into the
- characteristics of the group as a whole.
- """
-
- group = proto.Field(proto.MESSAGE, number=1, message=common.ErrorGroup,)
- count = proto.Field(proto.INT64, number=2,)
- affected_users_count = proto.Field(proto.INT64, number=3,)
- timed_counts = proto.RepeatedField(proto.MESSAGE, number=4, message="TimedCount",)
- first_seen_time = proto.Field(
- proto.MESSAGE, number=5, message=timestamp_pb2.Timestamp,
- )
- last_seen_time = proto.Field(
- proto.MESSAGE, number=6, message=timestamp_pb2.Timestamp,
- )
- affected_services = proto.RepeatedField(
- proto.MESSAGE, number=7, message=common.ServiceContext,
- )
- num_affected_services = proto.Field(proto.INT32, number=8,)
- representative = proto.Field(proto.MESSAGE, number=9, message=common.ErrorEvent,)
-
-
-class TimedCount(proto.Message):
- r"""The number of errors in a given time period.
- All numbers are approximate since the error events are sampled
- before counting them.
-
- Attributes:
- count (int):
- Approximate number of occurrences in the
- given time period.
- start_time (google.protobuf.timestamp_pb2.Timestamp):
- Start of the time period to which ``count`` refers
- (included).
- end_time (google.protobuf.timestamp_pb2.Timestamp):
- End of the time period to which ``count`` refers (excluded).
- """
-
- count = proto.Field(proto.INT64, number=1,)
- start_time = proto.Field(proto.MESSAGE, number=2, message=timestamp_pb2.Timestamp,)
- end_time = proto.Field(proto.MESSAGE, number=3, message=timestamp_pb2.Timestamp,)
-
-
-class ListEventsRequest(proto.Message):
- r"""Specifies a set of error events to return.
-
- Attributes:
- project_name (str):
- Required. The resource name of the Google Cloud Platform
- project. Written as ``projects/{projectID}``, where
- ``{projectID}`` is the `Google Cloud Platform project
- ID