Skip to content

Commit 1fef616

Browse files
gcf-owl-bot[bot]gcf-owl-bot[bot]
authoredJul 29, 2024··
chore: Update gapic-generator-python to v1.18.3 (#517)
* docs: Updates documentation with regional resource names for multiple requests docs: Removes references as a "global-only" service PiperOrigin-RevId: 652832022 Source-Link: googleapis/googleapis@72b7238 Source-Link: googleapis/googleapis-gen@fa6a37c Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiZmE2YTM3YzEwMDQwYmU4MDBhOWJmZTMyODZmMjY3ODU1MzVjMzczNyJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * chore: Update gapic-generator-python to v1.18.3 PiperOrigin-RevId: 655567917 Source-Link: googleapis/googleapis@43aa65e Source-Link: googleapis/googleapis-gen@0e38378 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMGUzODM3ODc1MzA3NGMwZjY2ZmY2MzM0OGQ2ODY0OTI5ZTEwNGQ1YyJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * chore: Update gapic-generator-python to v1.18.3 PiperOrigin-RevId: 656040068 Source-Link: googleapis/googleapis@3f4e29a Source-Link: googleapis/googleapis-gen@b8feb21 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiYjhmZWIyMTA5ZGRlN2IwOTM4YzIyYzk5M2QwMDIyNTFhYzY3MTRkYyJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
·
v1.11.1
1 parent 8d33168 commit 1fef616

File tree

14 files changed

+373
-118
lines changed

14 files changed

+373
-118
lines changed
 

‎google/cloud/errorreporting_v1beta1/services/error_group_service/async_client.py

+18-4
Original file line numberDiff line numberDiff line change
@@ -305,12 +305,26 @@ async def sample_get_group():
305305
The request object. A request to return an individual
306306
group.
307307
group_name (:class:`str`):
308-
Required. The group resource name. Written as
309-
``projects/{projectID}/groups/{group_name}``. Call
310-
```groupStats.list`` <https://cloud.google.com/error-reporting/reference/rest/v1beta1/projects.groupStats/list>`__
308+
Required. The group resource name. Written as either
309+
``projects/{projectID}/groups/{group_id}`` or
310+
``projects/{projectID}/locations/{location}/groups/{group_id}``.
311+
Call [groupStats.list]
312+
[google.devtools.clouderrorreporting.v1beta1.ErrorStatsService.ListGroupStats]
311313
to return a list of groups belonging to this project.
312314
313-
Example: ``projects/my-project-123/groups/my-group``
315+
Examples: ``projects/my-project-123/groups/my-group``,
316+
``projects/my-project-123/locations/global/groups/my-group``
317+
318+
In the group resource name, the ``group_id`` is a unique
319+
identifier for a particular error group. The identifier
320+
is derived from key parts of the error-log content and
321+
is treated as Service Data. For information about how
322+
Service Data is handled, see `Google Cloud Privacy
323+
Notice <https://cloud.google.com/terms/cloud-privacy-notice>`__.
324+
325+
For a list of supported locations, see `Supported
326+
Regions <https://cloud.google.com/logging/docs/region-support>`__.
327+
``global`` is the default when unspecified.
314328
315329
This corresponds to the ``group_name`` field
316330
on the ``request`` instance; if ``request`` is provided, this

‎google/cloud/errorreporting_v1beta1/services/error_group_service/client.py

+18-4
Original file line numberDiff line numberDiff line change
@@ -718,12 +718,26 @@ def sample_get_group():
718718
The request object. A request to return an individual
719719
group.
720720
group_name (str):
721-
Required. The group resource name. Written as
722-
``projects/{projectID}/groups/{group_name}``. Call
723-
```groupStats.list`` <https://cloud.google.com/error-reporting/reference/rest/v1beta1/projects.groupStats/list>`__
721+
Required. The group resource name. Written as either
722+
``projects/{projectID}/groups/{group_id}`` or
723+
``projects/{projectID}/locations/{location}/groups/{group_id}``.
724+
Call [groupStats.list]
725+
[google.devtools.clouderrorreporting.v1beta1.ErrorStatsService.ListGroupStats]
724726
to return a list of groups belonging to this project.
725727
726-
Example: ``projects/my-project-123/groups/my-group``
728+
Examples: ``projects/my-project-123/groups/my-group``,
729+
``projects/my-project-123/locations/global/groups/my-group``
730+
731+
In the group resource name, the ``group_id`` is a unique
732+
identifier for a particular error group. The identifier
733+
is derived from key parts of the error-log content and
734+
is treated as Service Data. For information about how
735+
Service Data is handled, see `Google Cloud Privacy
736+
Notice <https://cloud.google.com/terms/cloud-privacy-notice>`__.
737+
738+
For a list of supported locations, see `Supported
739+
Regions <https://cloud.google.com/logging/docs/region-support>`__.
740+
``global`` is the default when unspecified.
727741
728742
This corresponds to the ``group_name`` field
729743
on the ``request`` instance; if ``request`` is provided, this

‎google/cloud/errorreporting_v1beta1/services/error_group_service/transports/rest.py

+9
Original file line numberDiff line numberDiff line change
@@ -277,6 +277,10 @@ def __call__(
277277
"method": "get",
278278
"uri": "/v1beta1/{group_name=projects/*/groups/*}",
279279
},
280+
{
281+
"method": "get",
282+
"uri": "/v1beta1/{group_name=projects/*/locations/*/groups/*}",
283+
},
280284
]
281285
request, metadata = self._interceptor.pre_get_group(request, metadata)
282286
pb_request = error_group_service.GetGroupRequest.pb(request)
@@ -366,6 +370,11 @@ def __call__(
366370
"uri": "/v1beta1/{group.name=projects/*/groups/*}",
367371
"body": "group",
368372
},
373+
{
374+
"method": "put",
375+
"uri": "/v1beta1/{group.name=projects/*/locations/*/groups/*}",
376+
"body": "group",
377+
},
369378
]
370379
request, metadata = self._interceptor.pre_update_group(request, metadata)
371380
pb_request = error_group_service.UpdateGroupRequest.pb(request)

‎google/cloud/errorreporting_v1beta1/services/error_stats_service/async_client.py

+53-16
Original file line numberDiff line numberDiff line change
@@ -315,23 +315,41 @@ async def sample_list_group_stats():
315315
project. Written as ``projects/{projectID}`` or
316316
``projects/{projectNumber}``, where ``{projectID}`` and
317317
``{projectNumber}`` can be found in the `Google Cloud
318-
Console <https://support.google.com/cloud/answer/6158840>`__.
318+
console <https://support.google.com/cloud/answer/6158840>`__.
319+
It may also include a location, such as
320+
``projects/{projectID}/locations/{location}`` where
321+
``{location}`` is a cloud region.
319322
320323
Examples: ``projects/my-project-123``,
321-
``projects/5551234``.
324+
``projects/5551234``,
325+
``projects/my-project-123/locations/us-central1``,
326+
``projects/5551234/locations/us-central1``.
327+
328+
For a list of supported locations, see `Supported
329+
Regions <https://cloud.google.com/logging/docs/region-support>`__.
330+
``global`` is the default when unspecified. Use ``-`` as
331+
a wildcard to request group stats from all regions.
322332
323333
This corresponds to the ``project_name`` field
324334
on the ``request`` instance; if ``request`` is provided, this
325335
should not be set.
326336
time_range (:class:`google.cloud.errorreporting_v1beta1.types.QueryTimeRange`):
327337
Optional. List data for the given time range. If not
328338
set, a default time range is used. The field
329-
time_range_begin in the response will specify the
330-
beginning of this time range. Only ErrorGroupStats with
331-
a non-zero count in the given time range are returned,
332-
unless the request contains an explicit group_id list.
333-
If a group_id list is given, also ErrorGroupStats with
334-
zero occurrences are returned.
339+
[time_range_begin]
340+
[google.devtools.clouderrorreporting.v1beta1.ListGroupStatsResponse.time_range_begin]
341+
in the response will specify the beginning of this time
342+
range. Only [ErrorGroupStats]
343+
[google.devtools.clouderrorreporting.v1beta1.ErrorGroupStats]
344+
with a non-zero count in the given time range are
345+
returned, unless the request contains an explicit
346+
[group_id]
347+
[google.devtools.clouderrorreporting.v1beta1.ListGroupStatsRequest.group_id]
348+
list. If a [group_id]
349+
[google.devtools.clouderrorreporting.v1beta1.ListGroupStatsRequest.group_id]
350+
list is given, also [ErrorGroupStats]
351+
[google.devtools.clouderrorreporting.v1beta1.ErrorGroupStats]
352+
with zero occurrences are returned.
335353
336354
This corresponds to the ``time_range`` field
337355
on the ``request`` instance; if ``request`` is provided, this
@@ -456,18 +474,30 @@ async def sample_list_events():
456474
return.
457475
project_name (:class:`str`):
458476
Required. The resource name of the Google Cloud Platform
459-
project. Written as ``projects/{projectID}``, where
477+
project. Written as ``projects/{projectID}`` or
478+
``projects/{projectID}/locations/{location}``, where
460479
``{projectID}`` is the `Google Cloud Platform project
461-
ID <https://support.google.com/cloud/answer/6158840>`__.
480+
ID <https://support.google.com/cloud/answer/6158840>`__
481+
and ``{location}`` is a Cloud region.
482+
483+
Examples: ``projects/my-project-123``,
484+
``projects/my-project-123/locations/global``.
462485
463-
Example: ``projects/my-project-123``.
486+
For a list of supported locations, see `Supported
487+
Regions <https://cloud.google.com/logging/docs/region-support>`__.
488+
``global`` is the default when unspecified.
464489
465490
This corresponds to the ``project_name`` field
466491
on the ``request`` instance; if ``request`` is provided, this
467492
should not be set.
468493
group_id (:class:`str`):
469-
Required. The group for which events
470-
shall be returned.
494+
Required. The group for which events shall be returned.
495+
The ``group_id`` is a unique identifier for a particular
496+
error group. The identifier is derived from key parts of
497+
the error-log content and is treated as Service Data.
498+
For information about how Service Data is handled, see
499+
`Google Cloud Privacy
500+
Notice <https://cloud.google.com/terms/cloud-privacy-notice>`__.
471501
472502
This corresponds to the ``group_id`` field
473503
on the ``request`` instance; if ``request`` is provided, this
@@ -588,11 +618,18 @@ async def sample_delete_events():
588618
The request object. Deletes all events in the project.
589619
project_name (:class:`str`):
590620
Required. The resource name of the Google Cloud Platform
591-
project. Written as ``projects/{projectID}``, where
621+
project. Written as ``projects/{projectID}`` or
622+
``projects/{projectID}/locations/{location}``, where
592623
``{projectID}`` is the `Google Cloud Platform project
593-
ID <https://support.google.com/cloud/answer/6158840>`__.
624+
ID <https://support.google.com/cloud/answer/6158840>`__
625+
and ``{location}`` is a Cloud region.
626+
627+
Examples: ``projects/my-project-123``,
628+
``projects/my-project-123/locations/global``.
594629
595-
Example: ``projects/my-project-123``.
630+
For a list of supported locations, see `Supported
631+
Regions <https://cloud.google.com/logging/docs/region-support>`__.
632+
``global`` is the default when unspecified.
596633
597634
This corresponds to the ``project_name`` field
598635
on the ``request`` instance; if ``request`` is provided, this

‎google/cloud/errorreporting_v1beta1/services/error_stats_service/client.py

+53-16
Original file line numberDiff line numberDiff line change
@@ -728,23 +728,41 @@ def sample_list_group_stats():
728728
project. Written as ``projects/{projectID}`` or
729729
``projects/{projectNumber}``, where ``{projectID}`` and
730730
``{projectNumber}`` can be found in the `Google Cloud
731-
Console <https://support.google.com/cloud/answer/6158840>`__.
731+
console <https://support.google.com/cloud/answer/6158840>`__.
732+
It may also include a location, such as
733+
``projects/{projectID}/locations/{location}`` where
734+
``{location}`` is a cloud region.
732735
733736
Examples: ``projects/my-project-123``,
734-
``projects/5551234``.
737+
``projects/5551234``,
738+
``projects/my-project-123/locations/us-central1``,
739+
``projects/5551234/locations/us-central1``.
740+
741+
For a list of supported locations, see `Supported
742+
Regions <https://cloud.google.com/logging/docs/region-support>`__.
743+
``global`` is the default when unspecified. Use ``-`` as
744+
a wildcard to request group stats from all regions.
735745
736746
This corresponds to the ``project_name`` field
737747
on the ``request`` instance; if ``request`` is provided, this
738748
should not be set.
739749
time_range (google.cloud.errorreporting_v1beta1.types.QueryTimeRange):
740750
Optional. List data for the given time range. If not
741751
set, a default time range is used. The field
742-
time_range_begin in the response will specify the
743-
beginning of this time range. Only ErrorGroupStats with
744-
a non-zero count in the given time range are returned,
745-
unless the request contains an explicit group_id list.
746-
If a group_id list is given, also ErrorGroupStats with
747-
zero occurrences are returned.
752+
[time_range_begin]
753+
[google.devtools.clouderrorreporting.v1beta1.ListGroupStatsResponse.time_range_begin]
754+
in the response will specify the beginning of this time
755+
range. Only [ErrorGroupStats]
756+
[google.devtools.clouderrorreporting.v1beta1.ErrorGroupStats]
757+
with a non-zero count in the given time range are
758+
returned, unless the request contains an explicit
759+
[group_id]
760+
[google.devtools.clouderrorreporting.v1beta1.ListGroupStatsRequest.group_id]
761+
list. If a [group_id]
762+
[google.devtools.clouderrorreporting.v1beta1.ListGroupStatsRequest.group_id]
763+
list is given, also [ErrorGroupStats]
764+
[google.devtools.clouderrorreporting.v1beta1.ErrorGroupStats]
765+
with zero occurrences are returned.
748766
749767
This corresponds to the ``time_range`` field
750768
on the ``request`` instance; if ``request`` is provided, this
@@ -866,18 +884,30 @@ def sample_list_events():
866884
return.
867885
project_name (str):
868886
Required. The resource name of the Google Cloud Platform
869-
project. Written as ``projects/{projectID}``, where
887+
project. Written as ``projects/{projectID}`` or
888+
``projects/{projectID}/locations/{location}``, where
870889
``{projectID}`` is the `Google Cloud Platform project
871-
ID <https://support.google.com/cloud/answer/6158840>`__.
890+
ID <https://support.google.com/cloud/answer/6158840>`__
891+
and ``{location}`` is a Cloud region.
892+
893+
Examples: ``projects/my-project-123``,
894+
``projects/my-project-123/locations/global``.
872895
873-
Example: ``projects/my-project-123``.
896+
For a list of supported locations, see `Supported
897+
Regions <https://cloud.google.com/logging/docs/region-support>`__.
898+
``global`` is the default when unspecified.
874899
875900
This corresponds to the ``project_name`` field
876901
on the ``request`` instance; if ``request`` is provided, this
877902
should not be set.
878903
group_id (str):
879-
Required. The group for which events
880-
shall be returned.
904+
Required. The group for which events shall be returned.
905+
The ``group_id`` is a unique identifier for a particular
906+
error group. The identifier is derived from key parts of
907+
the error-log content and is treated as Service Data.
908+
For information about how Service Data is handled, see
909+
`Google Cloud Privacy
910+
Notice <https://cloud.google.com/terms/cloud-privacy-notice>`__.
881911
882912
This corresponds to the ``group_id`` field
883913
on the ``request`` instance; if ``request`` is provided, this
@@ -995,11 +1025,18 @@ def sample_delete_events():
9951025
The request object. Deletes all events in the project.
9961026
project_name (str):
9971027
Required. The resource name of the Google Cloud Platform
998-
project. Written as ``projects/{projectID}``, where
1028+
project. Written as ``projects/{projectID}`` or
1029+
``projects/{projectID}/locations/{location}``, where
9991030
``{projectID}`` is the `Google Cloud Platform project
1000-
ID <https://support.google.com/cloud/answer/6158840>`__.
1031+
ID <https://support.google.com/cloud/answer/6158840>`__
1032+
and ``{location}`` is a Cloud region.
1033+
1034+
Examples: ``projects/my-project-123``,
1035+
``projects/my-project-123/locations/global``.
10011036
1002-
Example: ``projects/my-project-123``.
1037+
For a list of supported locations, see `Supported
1038+
Regions <https://cloud.google.com/logging/docs/region-support>`__.
1039+
``global`` is the default when unspecified.
10031040
10041041
This corresponds to the ``project_name`` field
10051042
on the ``request`` instance; if ``request`` is provided, this

‎google/cloud/errorreporting_v1beta1/services/error_stats_service/transports/rest.py

+12
Original file line numberDiff line numberDiff line change
@@ -311,6 +311,10 @@ def __call__(
311311
"method": "delete",
312312
"uri": "/v1beta1/{project_name=projects/*}/events",
313313
},
314+
{
315+
"method": "delete",
316+
"uri": "/v1beta1/{project_name=projects/*/locations/*}/events",
317+
},
314318
]
315319
request, metadata = self._interceptor.pre_delete_events(request, metadata)
316320
pb_request = error_stats_service.DeleteEventsRequest.pb(request)
@@ -401,6 +405,10 @@ def __call__(
401405
"method": "get",
402406
"uri": "/v1beta1/{project_name=projects/*}/events",
403407
},
408+
{
409+
"method": "get",
410+
"uri": "/v1beta1/{project_name=projects/*/locations/*}/events",
411+
},
404412
]
405413
request, metadata = self._interceptor.pre_list_events(request, metadata)
406414
pb_request = error_stats_service.ListEventsRequest.pb(request)
@@ -488,6 +496,10 @@ def __call__(
488496
"method": "get",
489497
"uri": "/v1beta1/{project_name=projects/*}/groupStats",
490498
},
499+
{
500+
"method": "get",
501+
"uri": "/v1beta1/{project_name=projects/*/locations/*}/groupStats",
502+
},
491503
]
492504
request, metadata = self._interceptor.pre_list_group_stats(
493505
request, metadata

‎google/cloud/errorreporting_v1beta1/services/report_errors_service/async_client.py

+13-4
Original file line numberDiff line numberDiff line change
@@ -280,10 +280,19 @@ async def report_error_event(
280280
281281
``POST https://clouderrorreporting.googleapis.com/v1beta1/{projectName}/events:report?key=123ABC456``
282282
283-
**Note:** `Error Reporting </error-reporting>`__ is a global
284-
service built on Cloud Logging and doesn't analyze logs stored
285-
in regional log buckets or logs routed to other Google Cloud
286-
projects.
283+
**Note:** [Error Reporting]
284+
(https://cloud.google.com/error-reporting) is a service built on
285+
Cloud Logging and can analyze log entries when all of the
286+
following are true:
287+
288+
- Customer-managed encryption keys (CMEK) are disabled on the
289+
log bucket.
290+
- The log bucket satisfies one of the following:
291+
292+
- The log bucket is stored in the same project where the
293+
logs originated.
294+
- The logs were routed to a project, and then that project
295+
stored those logs in a log bucket that it owns.
287296
288297
.. code-block:: python
289298

‎google/cloud/errorreporting_v1beta1/services/report_errors_service/client.py

+13-4
Original file line numberDiff line numberDiff line change
@@ -679,10 +679,19 @@ def report_error_event(
679679
680680
``POST https://clouderrorreporting.googleapis.com/v1beta1/{projectName}/events:report?key=123ABC456``
681681
682-
**Note:** `Error Reporting </error-reporting>`__ is a global
683-
service built on Cloud Logging and doesn't analyze logs stored
684-
in regional log buckets or logs routed to other Google Cloud
685-
projects.
682+
**Note:** [Error Reporting]
683+
(https://cloud.google.com/error-reporting) is a service built on
684+
Cloud Logging and can analyze log entries when all of the
685+
following are true:
686+
687+
- Customer-managed encryption keys (CMEK) are disabled on the
688+
log bucket.
689+
- The log bucket satisfies one of the following:
690+
691+
- The log bucket is stored in the same project where the
692+
logs originated.
693+
- The logs were routed to a project, and then that project
694+
stored those logs in a log bucket that it owns.
686695
687696
.. code-block:: python
688697

‎google/cloud/errorreporting_v1beta1/services/report_errors_service/transports/grpc.py

+13-4
Original file line numberDiff line numberDiff line change
@@ -253,10 +253,19 @@ def report_error_event(
253253
254254
``POST https://clouderrorreporting.googleapis.com/v1beta1/{projectName}/events:report?key=123ABC456``
255255
256-
**Note:** `Error Reporting </error-reporting>`__ is a global
257-
service built on Cloud Logging and doesn't analyze logs stored
258-
in regional log buckets or logs routed to other Google Cloud
259-
projects.
256+
**Note:** [Error Reporting]
257+
(https://cloud.google.com/error-reporting) is a service built on
258+
Cloud Logging and can analyze log entries when all of the
259+
following are true:
260+
261+
- Customer-managed encryption keys (CMEK) are disabled on the
262+
log bucket.
263+
- The log bucket satisfies one of the following:
264+
265+
- The log bucket is stored in the same project where the
266+
logs originated.
267+
- The logs were routed to a project, and then that project
268+
stored those logs in a log bucket that it owns.
260269
261270
Returns:
262271
Callable[[~.ReportErrorEventRequest],

‎google/cloud/errorreporting_v1beta1/services/report_errors_service/transports/grpc_asyncio.py

+13-4
Original file line numberDiff line numberDiff line change
@@ -257,10 +257,19 @@ def report_error_event(
257257
258258
``POST https://clouderrorreporting.googleapis.com/v1beta1/{projectName}/events:report?key=123ABC456``
259259
260-
**Note:** `Error Reporting </error-reporting>`__ is a global
261-
service built on Cloud Logging and doesn't analyze logs stored
262-
in regional log buckets or logs routed to other Google Cloud
263-
projects.
260+
**Note:** [Error Reporting]
261+
(https://cloud.google.com/error-reporting) is a service built on
262+
Cloud Logging and can analyze log entries when all of the
263+
following are true:
264+
265+
- Customer-managed encryption keys (CMEK) are disabled on the
266+
log bucket.
267+
- The log bucket satisfies one of the following:
268+
269+
- The log bucket is stored in the same project where the
270+
logs originated.
271+
- The logs were routed to a project, and then that project
272+
stored those logs in a log bucket that it owns.
264273
265274
Returns:
266275
Callable[[~.ReportErrorEventRequest],

‎google/cloud/errorreporting_v1beta1/types/common.py

+27-7
Original file line numberDiff line numberDiff line change
@@ -70,18 +70,38 @@ class ErrorGroup(proto.Message):
7070
7171
Attributes:
7272
name (str):
73-
The group resource name.
74-
Example:
75-
<code>projects/my-project-123/groups/CNSgkpnppqKCUw</code>
73+
The group resource name. Written as
74+
``projects/{projectID}/groups/{group_id}`` or
75+
``projects/{projectID}/locations/{location}/groups/{group_id}``
76+
77+
Examples: ``projects/my-project-123/groups/my-group``,
78+
``projects/my-project-123/locations/us-central1/groups/my-group``
79+
80+
In the group resource name, the ``group_id`` is a unique
81+
identifier for a particular error group. The identifier is
82+
derived from key parts of the error-log content and is
83+
treated as Service Data. For information about how Service
84+
Data is handled, see `Google Cloud Privacy
85+
Notice <https://cloud.google.com/terms/cloud-privacy-notice>`__.
86+
87+
For a list of supported locations, see `Supported
88+
Regions <https://cloud.google.com/logging/docs/region-support>`__.
89+
``global`` is the default when unspecified.
7690
group_id (str):
77-
Group IDs are unique for a given project. If
78-
the same kind of error occurs in different
79-
service contexts, it will receive the same group
80-
ID.
91+
An opaque identifier of the group. This field is assigned by
92+
the Error Reporting system and always populated.
93+
94+
In the group resource name, the ``group_id`` is a unique
95+
identifier for a particular error group. The identifier is
96+
derived from key parts of the error-log content and is
97+
treated as Service Data. For information about how Service
98+
Data is handled, see `Google Cloud Privacy
99+
Notice <https://cloud.google.com/terms/cloud-privacy-notice>`__.
81100
tracking_issues (MutableSequence[google.cloud.errorreporting_v1beta1.types.TrackingIssue]):
82101
Associated tracking issues.
83102
resolution_status (google.cloud.errorreporting_v1beta1.types.ResolutionStatus):
84103
Error group's resolution status.
104+
85105
An unspecified resolution status will be
86106
interpreted as OPEN
87107
"""

‎google/cloud/errorreporting_v1beta1/types/error_group_service.py

+18-4
Original file line numberDiff line numberDiff line change
@@ -36,12 +36,26 @@ class GetGroupRequest(proto.Message):
3636
3737
Attributes:
3838
group_name (str):
39-
Required. The group resource name. Written as
40-
``projects/{projectID}/groups/{group_name}``. Call
41-
```groupStats.list`` <https://cloud.google.com/error-reporting/reference/rest/v1beta1/projects.groupStats/list>`__
39+
Required. The group resource name. Written as either
40+
``projects/{projectID}/groups/{group_id}`` or
41+
``projects/{projectID}/locations/{location}/groups/{group_id}``.
42+
Call [groupStats.list]
43+
[google.devtools.clouderrorreporting.v1beta1.ErrorStatsService.ListGroupStats]
4244
to return a list of groups belonging to this project.
4345
44-
Example: ``projects/my-project-123/groups/my-group``
46+
Examples: ``projects/my-project-123/groups/my-group``,
47+
``projects/my-project-123/locations/global/groups/my-group``
48+
49+
In the group resource name, the ``group_id`` is a unique
50+
identifier for a particular error group. The identifier is
51+
derived from key parts of the error-log content and is
52+
treated as Service Data. For information about how Service
53+
Data is handled, see `Google Cloud Privacy
54+
Notice <https://cloud.google.com/terms/cloud-privacy-notice>`__.
55+
56+
For a list of supported locations, see `Supported
57+
Regions <https://cloud.google.com/logging/docs/region-support>`__.
58+
``global`` is the default when unspecified.
4559
"""
4660

4761
group_name: str = proto.Field(

‎google/cloud/errorreporting_v1beta1/types/error_stats_service.py

+103-44
Original file line numberDiff line numberDiff line change
@@ -53,12 +53,18 @@ class TimedCountAlignment(proto.Enum):
5353
ALIGNMENT_EQUAL_ROUNDED (1):
5454
The time periods shall be consecutive, have width equal to
5555
the requested duration, and be aligned at the
56-
``alignment_time`` provided in the request. The
57-
``alignment_time`` does not have to be inside the query
58-
period but even if it is outside, only time periods are
59-
returned which overlap with the query period. A rounded
60-
alignment will typically result in a different size of the
61-
first or the last time period.
56+
[alignment_time]
57+
[google.devtools.clouderrorreporting.v1beta1.ListGroupStatsRequest.alignment_time]
58+
provided in the request.
59+
60+
The [alignment_time]
61+
[google.devtools.clouderrorreporting.v1beta1.ListGroupStatsRequest.alignment_time]
62+
does not have to be inside the query period but even if it
63+
is outside, only time periods are returned which overlap
64+
with the query period.
65+
66+
A rounded alignment will typically result in a different
67+
size of the first or the last time period.
6268
ALIGNMENT_EQUAL_AT_END (2):
6369
The time periods shall be consecutive, have
6470
width equal to the requested duration, and be
@@ -106,29 +112,54 @@ class ListGroupStatsRequest(proto.Message):
106112
project. Written as ``projects/{projectID}`` or
107113
``projects/{projectNumber}``, where ``{projectID}`` and
108114
``{projectNumber}`` can be found in the `Google Cloud
109-
Console <https://support.google.com/cloud/answer/6158840>`__.
110-
111-
Examples: ``projects/my-project-123``, ``projects/5551234``.
115+
console <https://support.google.com/cloud/answer/6158840>`__.
116+
It may also include a location, such as
117+
``projects/{projectID}/locations/{location}`` where
118+
``{location}`` is a cloud region.
119+
120+
Examples: ``projects/my-project-123``, ``projects/5551234``,
121+
``projects/my-project-123/locations/us-central1``,
122+
``projects/5551234/locations/us-central1``.
123+
124+
For a list of supported locations, see `Supported
125+
Regions <https://cloud.google.com/logging/docs/region-support>`__.
126+
``global`` is the default when unspecified. Use ``-`` as a
127+
wildcard to request group stats from all regions.
112128
group_id (MutableSequence[str]):
113-
Optional. List all
114-
<code>ErrorGroupStats</code> with these IDs.
129+
Optional. List all [ErrorGroupStats]
130+
[google.devtools.clouderrorreporting.v1beta1.ErrorGroupStats]
131+
with these IDs. The ``group_id`` is a unique identifier for
132+
a particular error group. The identifier is derived from key
133+
parts of the error-log content and is treated as Service
134+
Data. For information about how Service Data is handled, see
135+
[Google Cloud Privacy Notice]
136+
(https://cloud.google.com/terms/cloud-privacy-notice).
115137
service_filter (google.cloud.errorreporting_v1beta1.types.ServiceContextFilter):
116-
Optional. List only
117-
<code>ErrorGroupStats</code> which belong to a
118-
service context that matches the filter. Data
119-
for all service contexts is returned if this
120-
field is not specified.
138+
Optional. List only [ErrorGroupStats]
139+
[google.devtools.clouderrorreporting.v1beta1.ErrorGroupStats]
140+
which belong to a service context that matches the filter.
141+
Data for all service contexts is returned if this field is
142+
not specified.
121143
time_range (google.cloud.errorreporting_v1beta1.types.QueryTimeRange):
122144
Optional. List data for the given time range. If not set, a
123-
default time range is used. The field time_range_begin in
124-
the response will specify the beginning of this time range.
125-
Only ErrorGroupStats with a non-zero count in the given time
126-
range are returned, unless the request contains an explicit
127-
group_id list. If a group_id list is given, also
128-
ErrorGroupStats with zero occurrences are returned.
145+
default time range is used. The field [time_range_begin]
146+
[google.devtools.clouderrorreporting.v1beta1.ListGroupStatsResponse.time_range_begin]
147+
in the response will specify the beginning of this time
148+
range. Only [ErrorGroupStats]
149+
[google.devtools.clouderrorreporting.v1beta1.ErrorGroupStats]
150+
with a non-zero count in the given time range are returned,
151+
unless the request contains an explicit [group_id]
152+
[google.devtools.clouderrorreporting.v1beta1.ListGroupStatsRequest.group_id]
153+
list. If a [group_id]
154+
[google.devtools.clouderrorreporting.v1beta1.ListGroupStatsRequest.group_id]
155+
list is given, also [ErrorGroupStats]
156+
[google.devtools.clouderrorreporting.v1beta1.ErrorGroupStats]
157+
with zero occurrences are returned.
129158
timed_count_duration (google.protobuf.duration_pb2.Duration):
130159
Optional. The preferred duration for a single returned
131-
``TimedCount``. If not set, no timed counts are returned.
160+
[TimedCount]
161+
[google.devtools.clouderrorreporting.v1beta1.TimedCount]. If
162+
not set, no timed counts are returned.
132163
alignment (google.cloud.errorreporting_v1beta1.types.TimedCountAlignment):
133164
Optional. The alignment of the timed counts to be returned.
134165
Default is ``ALIGNMENT_EQUAL_AT_END``.
@@ -143,9 +174,11 @@ class ListGroupStatsRequest(proto.Message):
143174
Optional. The maximum number of results to
144175
return per response. Default is 20.
145176
page_token (str):
146-
Optional. A ``next_page_token`` provided by a previous
147-
response. To view additional results, pass this token along
148-
with the identical query parameters as the first request.
177+
Optional. A [next_page_token]
178+
[google.devtools.clouderrorreporting.v1beta1.ListGroupStatsResponse.next_page_token]
179+
provided by a previous response. To view additional results,
180+
pass this token along with the identical query parameters as
181+
the first request.
149182
"""
150183

151184
project_name: str = proto.Field(
@@ -251,15 +284,16 @@ class ErrorGroupStats(proto.Message):
251284
affected_users_count (int):
252285
Approximate number of affected users in the given group that
253286
match the filter criteria. Users are distinguished by data
254-
in the ``ErrorContext`` of the individual error events, such
255-
as their login name or their remote IP address in case of
256-
HTTP requests. The number of affected users can be zero even
257-
if the number of errors is non-zero if no data was provided
258-
from which the affected user could be deduced. Users are
259-
counted based on data in the request context that was
260-
provided in the error report. If more users are implicitly
261-
affected, such as due to a crash of the whole service, this
262-
is not reflected here.
287+
in the [ErrorContext]
288+
[google.devtools.clouderrorreporting.v1beta1.ErrorContext]
289+
of the individual error events, such as their login name or
290+
their remote IP address in case of HTTP requests. The number
291+
of affected users can be zero even if the number of errors
292+
is non-zero if no data was provided from which the affected
293+
user could be deduced. Users are counted based on data in
294+
the request context that was provided in the error report.
295+
If more users are implicitly affected, such as due to a
296+
crash of the whole service, this is not reflected here.
263297
timed_counts (MutableSequence[google.cloud.errorreporting_v1beta1.types.TimedCount]):
264298
Approximate number of occurrences over time.
265299
Timed counts returned by ListGroups are
@@ -377,14 +411,26 @@ class ListEventsRequest(proto.Message):
377411
Attributes:
378412
project_name (str):
379413
Required. The resource name of the Google Cloud Platform
380-
project. Written as ``projects/{projectID}``, where
414+
project. Written as ``projects/{projectID}`` or
415+
``projects/{projectID}/locations/{location}``, where
381416
``{projectID}`` is the `Google Cloud Platform project
382-
ID <https://support.google.com/cloud/answer/6158840>`__.
417+
ID <https://support.google.com/cloud/answer/6158840>`__ and
418+
``{location}`` is a Cloud region.
383419
384-
Example: ``projects/my-project-123``.
420+
Examples: ``projects/my-project-123``,
421+
``projects/my-project-123/locations/global``.
422+
423+
For a list of supported locations, see `Supported
424+
Regions <https://cloud.google.com/logging/docs/region-support>`__.
425+
``global`` is the default when unspecified.
385426
group_id (str):
386-
Required. The group for which events shall be
387-
returned.
427+
Required. The group for which events shall be returned. The
428+
``group_id`` is a unique identifier for a particular error
429+
group. The identifier is derived from key parts of the
430+
error-log content and is treated as Service Data. For
431+
information about how Service Data is handled, see `Google
432+
Cloud Privacy
433+
Notice <https://cloud.google.com/terms/cloud-privacy-notice>`__.
388434
service_filter (google.cloud.errorreporting_v1beta1.types.ServiceContextFilter):
389435
Optional. List only ErrorGroups which belong
390436
to a service context that matches the filter.
@@ -469,7 +515,13 @@ def raw_page(self):
469515

470516

471517
class QueryTimeRange(proto.Message):
472-
r"""Requests might be rejected or the resulting timed count
518+
r"""A time range for which error group data shall be displayed.
519+
Query time ranges end at 'now'.
520+
When longer time ranges are selected, the resolution of the data
521+
decreases. The description of each time range below indicates
522+
the suggested minimum timed count duration for that range.
523+
524+
Requests might be rejected or the resulting timed count
473525
durations might be adjusted for lower durations.
474526
475527
Attributes:
@@ -555,11 +607,18 @@ class DeleteEventsRequest(proto.Message):
555607
Attributes:
556608
project_name (str):
557609
Required. The resource name of the Google Cloud Platform
558-
project. Written as ``projects/{projectID}``, where
610+
project. Written as ``projects/{projectID}`` or
611+
``projects/{projectID}/locations/{location}``, where
559612
``{projectID}`` is the `Google Cloud Platform project
560-
ID <https://support.google.com/cloud/answer/6158840>`__.
613+
ID <https://support.google.com/cloud/answer/6158840>`__ and
614+
``{location}`` is a Cloud region.
615+
616+
Examples: ``projects/my-project-123``,
617+
``projects/my-project-123/locations/global``.
561618
562-
Example: ``projects/my-project-123``.
619+
For a list of supported locations, see `Supported
620+
Regions <https://cloud.google.com/logging/docs/region-support>`__.
621+
``global`` is the default when unspecified.
563622
"""
564623

565624
project_name: str = proto.Field(

‎google/cloud/errorreporting_v1beta1/types/report_errors_service.py

+10-7
Original file line numberDiff line numberDiff line change
@@ -72,10 +72,13 @@ class ReportedErrorEvent(proto.Message):
7272
7373
Attributes:
7474
event_time (google.protobuf.timestamp_pb2.Timestamp):
75-
Optional. Time when the event occurred.
76-
If not provided, the time when the event was
77-
received by the Error Reporting system will be
78-
used.
75+
Optional. Time when the event occurred. If not provided, the
76+
time when the event was received by the Error Reporting
77+
system is used. If provided, the time must not exceed the
78+
`logs retention
79+
period <https://cloud.google.com/logging/quotas#logs_retention_periods>`__
80+
in the past, or be more than 24 hours in the future. If an
81+
invalid time is provided, then an error is returned.
7982
service_context (google.cloud.errorreporting_v1beta1.types.ServiceContext):
8083
Required. The service context in which this
8184
error has occurred.
@@ -99,10 +102,10 @@ class ReportedErrorEvent(proto.Message):
99102
```Exception.backtrace`` <https://ruby-doc.org/core-2.2.0/Exception.html#method-i-backtrace>`__.
100103
- **C#**: Must be the return value of
101104
```Exception.ToString()`` <https://msdn.microsoft.com/en-us/library/system.exception.tostring.aspx>`__.
102-
- **PHP**: Must start with
103-
``PHP (Notice|Parse error|Fatal error|Warning)`` and
105+
- **PHP**: Must be prefixed with
106+
``"PHP (Notice|Parse error|Fatal error|Warning): "`` and
104107
contain the result of
105-
```(string)$exception`` <http://php.net/manual/en/exception.tostring.php>`__.
108+
```(string)$exception`` <https://php.net/manual/en/exception.tostring.php>`__.
106109
- **Go**: Must be the return value of
107110
```runtime.Stack()`` <https://golang.org/pkg/runtime/debug/#Stack>`__.
108111
context (google.cloud.errorreporting_v1beta1.types.ErrorContext):

0 commit comments

Comments
 (0)
Please sign in to comment.