Skip to content

chore: Update gapic-generator-python to v1.18.3 #517

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jul 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -305,12 +305,26 @@ async def sample_get_group():
The request object. A request to return an individual
group.
group_name (:class:`str`):
Required. The group resource name. Written as
``projects/{projectID}/groups/{group_name}``. Call
```groupStats.list`` <https://cloud.google.com/error-reporting/reference/rest/v1beta1/projects.groupStats/list>`__
Required. The group resource name. Written as either
``projects/{projectID}/groups/{group_id}`` or
``projects/{projectID}/locations/{location}/groups/{group_id}``.
Call [groupStats.list]
[google.devtools.clouderrorreporting.v1beta1.ErrorStatsService.ListGroupStats]
to return a list of groups belonging to this project.

Example: ``projects/my-project-123/groups/my-group``
Examples: ``projects/my-project-123/groups/my-group``,
``projects/my-project-123/locations/global/groups/my-group``

In the group resource name, the ``group_id`` is a unique
identifier for a particular error group. The identifier
is derived from key parts of the error-log content and
is treated as Service Data. For information about how
Service Data is handled, see `Google Cloud Privacy
Notice <https://cloud.google.com/terms/cloud-privacy-notice>`__.

For a list of supported locations, see `Supported
Regions <https://cloud.google.com/logging/docs/region-support>`__.
``global`` is the default when unspecified.

This corresponds to the ``group_name`` field
on the ``request`` instance; if ``request`` is provided, this
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -718,12 +718,26 @@ def sample_get_group():
The request object. A request to return an individual
group.
group_name (str):
Required. The group resource name. Written as
``projects/{projectID}/groups/{group_name}``. Call
```groupStats.list`` <https://cloud.google.com/error-reporting/reference/rest/v1beta1/projects.groupStats/list>`__
Required. The group resource name. Written as either
``projects/{projectID}/groups/{group_id}`` or
``projects/{projectID}/locations/{location}/groups/{group_id}``.
Call [groupStats.list]
[google.devtools.clouderrorreporting.v1beta1.ErrorStatsService.ListGroupStats]
to return a list of groups belonging to this project.

Example: ``projects/my-project-123/groups/my-group``
Examples: ``projects/my-project-123/groups/my-group``,
``projects/my-project-123/locations/global/groups/my-group``

In the group resource name, the ``group_id`` is a unique
identifier for a particular error group. The identifier
is derived from key parts of the error-log content and
is treated as Service Data. For information about how
Service Data is handled, see `Google Cloud Privacy
Notice <https://cloud.google.com/terms/cloud-privacy-notice>`__.

For a list of supported locations, see `Supported
Regions <https://cloud.google.com/logging/docs/region-support>`__.
``global`` is the default when unspecified.

This corresponds to the ``group_name`` field
on the ``request`` instance; if ``request`` is provided, this
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -277,6 +277,10 @@ def __call__(
"method": "get",
"uri": "/v1beta1/{group_name=projects/*/groups/*}",
},
{
"method": "get",
"uri": "/v1beta1/{group_name=projects/*/locations/*/groups/*}",
},
]
request, metadata = self._interceptor.pre_get_group(request, metadata)
pb_request = error_group_service.GetGroupRequest.pb(request)
Expand Down Expand Up @@ -366,6 +370,11 @@ def __call__(
"uri": "/v1beta1/{group.name=projects/*/groups/*}",
"body": "group",
},
{
"method": "put",
"uri": "/v1beta1/{group.name=projects/*/locations/*/groups/*}",
"body": "group",
},
]
request, metadata = self._interceptor.pre_update_group(request, metadata)
pb_request = error_group_service.UpdateGroupRequest.pb(request)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -315,23 +315,41 @@ async def sample_list_group_stats():
project. Written as ``projects/{projectID}`` or
``projects/{projectNumber}``, where ``{projectID}`` and
``{projectNumber}`` can be found in the `Google Cloud
Console <https://support.google.com/cloud/answer/6158840>`__.
console <https://support.google.com/cloud/answer/6158840>`__.
It may also include a location, such as
``projects/{projectID}/locations/{location}`` where
``{location}`` is a cloud region.

Examples: ``projects/my-project-123``,
``projects/5551234``.
``projects/5551234``,
``projects/my-project-123/locations/us-central1``,
``projects/5551234/locations/us-central1``.

For a list of supported locations, see `Supported
Regions <https://cloud.google.com/logging/docs/region-support>`__.
``global`` is the default when unspecified. Use ``-`` as
a wildcard to request group stats from all regions.

This corresponds to the ``project_name`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
time_range (:class:`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.
[time_range_begin]
[google.devtools.clouderrorreporting.v1beta1.ListGroupStatsResponse.time_range_begin]
in the response will specify the beginning of this time
range. Only [ErrorGroupStats]
[google.devtools.clouderrorreporting.v1beta1.ErrorGroupStats]
with a non-zero count in the given time range are
returned, unless the request contains an explicit
[group_id]
[google.devtools.clouderrorreporting.v1beta1.ListGroupStatsRequest.group_id]
list. If a [group_id]
[google.devtools.clouderrorreporting.v1beta1.ListGroupStatsRequest.group_id]
list is given, also [ErrorGroupStats]
[google.devtools.clouderrorreporting.v1beta1.ErrorGroupStats]
with zero occurrences are returned.

This corresponds to the ``time_range`` field
on the ``request`` instance; if ``request`` is provided, this
Expand Down Expand Up @@ -456,18 +474,30 @@ async def sample_list_events():
return.
project_name (:class:`str`):
Required. The resource name of the Google Cloud Platform
project. Written as ``projects/{projectID}``, where
project. Written as ``projects/{projectID}`` or
``projects/{projectID}/locations/{location}``, where
``{projectID}`` is the `Google Cloud Platform project
ID <https://support.google.com/cloud/answer/6158840>`__.
ID <https://support.google.com/cloud/answer/6158840>`__
and ``{location}`` is a Cloud region.

Examples: ``projects/my-project-123``,
``projects/my-project-123/locations/global``.

Example: ``projects/my-project-123``.
For a list of supported locations, see `Supported
Regions <https://cloud.google.com/logging/docs/region-support>`__.
``global`` is the default when unspecified.

This corresponds to the ``project_name`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
group_id (:class:`str`):
Required. The group for which events
shall be returned.
Required. The group for which events shall be returned.
The ``group_id`` is a unique identifier for a particular
error group. The identifier is derived from key parts of
the error-log content and is treated as Service Data.
For information about how Service Data is handled, see
`Google Cloud Privacy
Notice <https://cloud.google.com/terms/cloud-privacy-notice>`__.

This corresponds to the ``group_id`` field
on the ``request`` instance; if ``request`` is provided, this
Expand Down Expand Up @@ -588,11 +618,18 @@ async def sample_delete_events():
The request object. Deletes all events in the project.
project_name (:class:`str`):
Required. The resource name of the Google Cloud Platform
project. Written as ``projects/{projectID}``, where
project. Written as ``projects/{projectID}`` or
``projects/{projectID}/locations/{location}``, where
``{projectID}`` is the `Google Cloud Platform project
ID <https://support.google.com/cloud/answer/6158840>`__.
ID <https://support.google.com/cloud/answer/6158840>`__
and ``{location}`` is a Cloud region.

Examples: ``projects/my-project-123``,
``projects/my-project-123/locations/global``.

Example: ``projects/my-project-123``.
For a list of supported locations, see `Supported
Regions <https://cloud.google.com/logging/docs/region-support>`__.
``global`` is the default when unspecified.

This corresponds to the ``project_name`` field
on the ``request`` instance; if ``request`` is provided, this
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -728,23 +728,41 @@ def sample_list_group_stats():
project. Written as ``projects/{projectID}`` or
``projects/{projectNumber}``, where ``{projectID}`` and
``{projectNumber}`` can be found in the `Google Cloud
Console <https://support.google.com/cloud/answer/6158840>`__.
console <https://support.google.com/cloud/answer/6158840>`__.
It may also include a location, such as
``projects/{projectID}/locations/{location}`` where
``{location}`` is a cloud region.

Examples: ``projects/my-project-123``,
``projects/5551234``.
``projects/5551234``,
``projects/my-project-123/locations/us-central1``,
``projects/5551234/locations/us-central1``.

For a list of supported locations, see `Supported
Regions <https://cloud.google.com/logging/docs/region-support>`__.
``global`` is the default when unspecified. Use ``-`` as
a wildcard to request group stats from all regions.

This corresponds to the ``project_name`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
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.
[time_range_begin]
[google.devtools.clouderrorreporting.v1beta1.ListGroupStatsResponse.time_range_begin]
in the response will specify the beginning of this time
range. Only [ErrorGroupStats]
[google.devtools.clouderrorreporting.v1beta1.ErrorGroupStats]
with a non-zero count in the given time range are
returned, unless the request contains an explicit
[group_id]
[google.devtools.clouderrorreporting.v1beta1.ListGroupStatsRequest.group_id]
list. If a [group_id]
[google.devtools.clouderrorreporting.v1beta1.ListGroupStatsRequest.group_id]
list is given, also [ErrorGroupStats]
[google.devtools.clouderrorreporting.v1beta1.ErrorGroupStats]
with zero occurrences are returned.

This corresponds to the ``time_range`` field
on the ``request`` instance; if ``request`` is provided, this
Expand Down Expand Up @@ -866,18 +884,30 @@ def sample_list_events():
return.
project_name (str):
Required. The resource name of the Google Cloud Platform
project. Written as ``projects/{projectID}``, where
project. Written as ``projects/{projectID}`` or
``projects/{projectID}/locations/{location}``, where
``{projectID}`` is the `Google Cloud Platform project
ID <https://support.google.com/cloud/answer/6158840>`__.
ID <https://support.google.com/cloud/answer/6158840>`__
and ``{location}`` is a Cloud region.

Examples: ``projects/my-project-123``,
``projects/my-project-123/locations/global``.

Example: ``projects/my-project-123``.
For a list of supported locations, see `Supported
Regions <https://cloud.google.com/logging/docs/region-support>`__.
``global`` is the default when unspecified.

This corresponds to the ``project_name`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
group_id (str):
Required. The group for which events
shall be returned.
Required. The group for which events shall be returned.
The ``group_id`` is a unique identifier for a particular
error group. The identifier is derived from key parts of
the error-log content and is treated as Service Data.
For information about how Service Data is handled, see
`Google Cloud Privacy
Notice <https://cloud.google.com/terms/cloud-privacy-notice>`__.

This corresponds to the ``group_id`` field
on the ``request`` instance; if ``request`` is provided, this
Expand Down Expand Up @@ -995,11 +1025,18 @@ def sample_delete_events():
The request object. Deletes all events in the project.
project_name (str):
Required. The resource name of the Google Cloud Platform
project. Written as ``projects/{projectID}``, where
project. Written as ``projects/{projectID}`` or
``projects/{projectID}/locations/{location}``, where
``{projectID}`` is the `Google Cloud Platform project
ID <https://support.google.com/cloud/answer/6158840>`__.
ID <https://support.google.com/cloud/answer/6158840>`__
and ``{location}`` is a Cloud region.

Examples: ``projects/my-project-123``,
``projects/my-project-123/locations/global``.

Example: ``projects/my-project-123``.
For a list of supported locations, see `Supported
Regions <https://cloud.google.com/logging/docs/region-support>`__.
``global`` is the default when unspecified.

This corresponds to the ``project_name`` field
on the ``request`` instance; if ``request`` is provided, this
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -311,6 +311,10 @@ def __call__(
"method": "delete",
"uri": "/v1beta1/{project_name=projects/*}/events",
},
{
"method": "delete",
"uri": "/v1beta1/{project_name=projects/*/locations/*}/events",
},
]
request, metadata = self._interceptor.pre_delete_events(request, metadata)
pb_request = error_stats_service.DeleteEventsRequest.pb(request)
Expand Down Expand Up @@ -401,6 +405,10 @@ def __call__(
"method": "get",
"uri": "/v1beta1/{project_name=projects/*}/events",
},
{
"method": "get",
"uri": "/v1beta1/{project_name=projects/*/locations/*}/events",
},
]
request, metadata = self._interceptor.pre_list_events(request, metadata)
pb_request = error_stats_service.ListEventsRequest.pb(request)
Expand Down Expand Up @@ -488,6 +496,10 @@ def __call__(
"method": "get",
"uri": "/v1beta1/{project_name=projects/*}/groupStats",
},
{
"method": "get",
"uri": "/v1beta1/{project_name=projects/*/locations/*}/groupStats",
},
]
request, metadata = self._interceptor.pre_list_group_stats(
request, metadata
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -280,10 +280,19 @@ async def report_error_event(

``POST https://clouderrorreporting.googleapis.com/v1beta1/{projectName}/events:report?key=123ABC456``

**Note:** `Error Reporting </error-reporting>`__ is a global
service built on Cloud Logging and doesn't analyze logs stored
in regional log buckets or logs routed to other Google Cloud
projects.
**Note:** [Error Reporting]
(https://cloud.google.com/error-reporting) is a service built on
Cloud Logging and can analyze log entries when all of the
following are true:

- Customer-managed encryption keys (CMEK) are disabled on the
log bucket.
- The log bucket satisfies one of the following:

- The log bucket is stored in the same project where the
logs originated.
- The logs were routed to a project, and then that project
stored those logs in a log bucket that it owns.

.. code-block:: python

Expand Down
Loading