Skip to content

Commit 183c876

Browse files
gcf-owl-bot[bot]bshaffer
gcf-owl-bot[bot]
and
bshaffer
authored
docs: Updates documentation with regional resource names for multiple requests (#7529)
docs: Removes references as a "global-only" service PiperOrigin-RevId: 652832022 Source-Link: googleapis/googleapis@72b7238 Source-Link: googleapis/googleapis-gen@fa6a37c Copy-Tag: eyJwIjoiRXJyb3JSZXBvcnRpbmcvLk93bEJvdC55YW1sIiwiaCI6ImZhNmEzN2MxMDA0MGJlODAwYTliZmUzMjg2ZjI2Nzg1NTM1YzM3MzcifQ== Co-authored-by: Brent Shaffer <betterbrent@google.com>
1 parent ca1b29a commit 183c876

22 files changed

Lines changed: 742 additions & 251 deletions

‎ErrorReporting/metadata/V1Beta1/ErrorGroupService.php‎

Lines changed: 7 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎ErrorReporting/metadata/V1Beta1/ErrorStatsService.php‎

177 Bytes
Binary file not shown.

‎ErrorReporting/samples/V1beta1/ErrorGroupServiceClient/get_group.php‎

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,26 @@
3131
/**
3232
* Get the specified group.
3333
*
34-
* @param string $formattedGroupName The group resource name. Written as
35-
* `projects/{projectID}/groups/{group_name}`. Call
36-
* [`groupStats.list`](https://cloud.google.com/error-reporting/reference/rest/v1beta1/projects.groupStats/list)
34+
* @param string $formattedGroupName The group resource name. Written as either
35+
* `projects/{projectID}/groups/{group_id}` or
36+
* `projects/{projectID}/locations/{location}/groups/{group_id}`. Call
37+
* [groupStats.list]
38+
* [google.devtools.clouderrorreporting.v1beta1.ErrorStatsService.ListGroupStats]
3739
* to return a list of groups belonging to this project.
3840
*
39-
* Example: `projects/my-project-123/groups/my-group`
40-
* Please see {@see ErrorGroupServiceClient::errorGroupName()} for help formatting this field.
41+
* Examples: `projects/my-project-123/groups/my-group`,
42+
* `projects/my-project-123/locations/global/groups/my-group`
43+
*
44+
* In the group resource name, the `group_id` is a unique identifier for a
45+
* particular error group. The identifier is derived from key parts of the
46+
* error-log content and is treated as Service Data. For information about
47+
* how Service Data is handled, see [Google Cloud Privacy
48+
* Notice](https://cloud.google.com/terms/cloud-privacy-notice).
49+
*
50+
* For a list of supported locations, see [Supported
51+
* Regions](https://cloud.google.com/logging/docs/region-support). `global` is
52+
* the default when unspecified. Please see
53+
* {@see ErrorGroupServiceClient::errorGroupName()} for help formatting this field.
4154
*/
4255
function get_group_sample(string $formattedGroupName): void
4356
{

‎ErrorReporting/samples/V1beta1/ErrorStatsServiceClient/delete_events.php‎

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,17 @@
3232
* Deletes all error events of a given project.
3333
*
3434
* @param string $formattedProjectName The resource name of the Google Cloud Platform project. Written
35-
* as `projects/{projectID}`, where `{projectID}` is the
36-
* [Google Cloud Platform project
37-
* ID](https://support.google.com/cloud/answer/6158840).
35+
* as `projects/{projectID}` or `projects/{projectID}/locations/{location}`,
36+
* where `{projectID}` is the [Google Cloud Platform project
37+
* ID](https://support.google.com/cloud/answer/6158840) and `{location}` is
38+
* a Cloud region.
3839
*
39-
* Example: `projects/my-project-123`. Please see
40+
* Examples: `projects/my-project-123`,
41+
* `projects/my-project-123/locations/global`.
42+
*
43+
* For a list of supported locations, see [Supported
44+
* Regions](https://cloud.google.com/logging/docs/region-support). `global` is
45+
* the default when unspecified. Please see
4046
* {@see ErrorStatsServiceClient::projectName()} for help formatting this field.
4147
*/
4248
function delete_events_sample(string $formattedProjectName): void

‎ErrorReporting/samples/V1beta1/ErrorStatsServiceClient/list_events.php‎

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,13 +33,24 @@
3333
* Lists the specified events.
3434
*
3535
* @param string $formattedProjectName The resource name of the Google Cloud Platform project. Written
36-
* as `projects/{projectID}`, where `{projectID}` is the
37-
* [Google Cloud Platform project
38-
* ID](https://support.google.com/cloud/answer/6158840).
36+
* as `projects/{projectID}` or `projects/{projectID}/locations/{location}`,
37+
* where `{projectID}` is the [Google Cloud Platform project
38+
* ID](https://support.google.com/cloud/answer/6158840) and `{location}` is
39+
* a Cloud region.
3940
*
40-
* Example: `projects/my-project-123`. Please see
41+
* Examples: `projects/my-project-123`,
42+
* `projects/my-project-123/locations/global`.
43+
*
44+
* For a list of supported locations, see [Supported
45+
* Regions](https://cloud.google.com/logging/docs/region-support). `global` is
46+
* the default when unspecified. Please see
4147
* {@see ErrorStatsServiceClient::projectName()} for help formatting this field.
4248
* @param string $groupId The group for which events shall be returned.
49+
* The `group_id` is a unique identifier for a particular error group. The
50+
* identifier is derived from key parts of the error-log content and is
51+
* treated as Service Data. For information about how Service Data
52+
* is handled, see [Google Cloud Privacy
53+
* Notice](https://cloud.google.com/terms/cloud-privacy-notice).
4354
*/
4455
function list_events_sample(string $formattedProjectName, string $groupId): void
4556
{

‎ErrorReporting/samples/V1beta1/ErrorStatsServiceClient/list_group_stats.php‎

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,21 @@
3333
* Lists the specified groups.
3434
*
3535
* @param string $formattedProjectName The resource name of the Google Cloud Platform project. Written
36-
* as `projects/{projectID}` or `projects/{projectNumber}`, where `{projectID}`
37-
* and `{projectNumber}` can be found in the
38-
* [Google Cloud Console](https://support.google.com/cloud/answer/6158840).
36+
* as `projects/{projectID}` or `projects/{projectNumber}`, where
37+
* `{projectID}` and `{projectNumber}` can be found in the
38+
* [Google Cloud console](https://support.google.com/cloud/answer/6158840).
39+
* It may also include a location, such as
40+
* `projects/{projectID}/locations/{location}` where `{location}` is a cloud
41+
* region.
3942
*
40-
* Examples: `projects/my-project-123`, `projects/5551234`. Please see
43+
* Examples: `projects/my-project-123`, `projects/5551234`,
44+
* `projects/my-project-123/locations/us-central1`,
45+
* `projects/5551234/locations/us-central1`.
46+
*
47+
* For a list of supported locations, see [Supported
48+
* Regions](https://cloud.google.com/logging/docs/region-support). `global` is
49+
* the default when unspecified. Use `-` as a wildcard to request group stats
50+
* from all regions. Please see
4151
* {@see ErrorStatsServiceClient::projectName()} for help formatting this field.
4252
*/
4353
function list_group_stats_sample(string $formattedProjectName): void

‎ErrorReporting/samples/V1beta1/ReportErrorsServiceClient/report_error_event.php‎

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,16 @@
4141
* `POST
4242
* https://clouderrorreporting.googleapis.com/v1beta1/{projectName}/events:report?key=123ABC456`
4343
*
44-
* **Note:** [Error Reporting](/error-reporting) is a global service built
45-
* on Cloud Logging and doesn't analyze logs stored
46-
* in regional log buckets or logs routed to other Google Cloud projects.
44+
* **Note:** [Error Reporting] (https://cloud.google.com/error-reporting)
45+
* is a service built on Cloud Logging and can analyze log entries when all of
46+
* the following are true:
4747
*
48+
* * Customer-managed encryption keys (CMEK) are disabled on the log bucket.
49+
* * The log bucket satisfies one of the following:
50+
* * The log bucket is stored in the same project where the logs
51+
* originated.
52+
* * The logs were routed to a project, and then that project stored those
53+
* logs in a log bucket that it owns.
4854
*
4955
* @param string $formattedProjectName The resource name of the Google Cloud Platform project. Written
5056
* as `projects/{projectId}`, where `{projectId}` is the
@@ -72,9 +78,9 @@
7278
* [`Exception.backtrace`](https://ruby-doc.org/core-2.2.0/Exception.html#method-i-backtrace).
7379
* * **C#**: Must be the return value of
7480
* [`Exception.ToString()`](https://msdn.microsoft.com/en-us/library/system.exception.tostring.aspx).
75-
* * **PHP**: Must start with `PHP (Notice|Parse error|Fatal error|Warning)`
76-
* and contain the result of
77-
* [`(string)$exception`](http://php.net/manual/en/exception.tostring.php).
81+
* * **PHP**: Must be prefixed with `"PHP (Notice|Parse error|Fatal
82+
* error|Warning): "` and contain the result of
83+
* [`(string)$exception`](https://php.net/manual/en/exception.tostring.php).
7884
* * **Go**: Must be the return value of
7985
* [`runtime.Stack()`](https://golang.org/pkg/runtime/debug/#Stack).
8086
*/

‎ErrorReporting/src/V1beta1/Client/ReportErrorsServiceClient.php‎

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -228,10 +228,16 @@ public function __call($method, $args)
228228
* `POST
229229
* https://clouderrorreporting.googleapis.com/v1beta1/{projectName}/events:report?key=123ABC456`
230230
*
231-
* **Note:** [Error Reporting](https://cloud.google.com/error-reporting) is a global service built
232-
* on Cloud Logging and doesn't analyze logs stored
233-
* in regional log buckets or logs routed to other Google Cloud projects.
231+
* **Note:** [Error Reporting] (https://cloud.google.com/error-reporting)
232+
* is a service built on Cloud Logging and can analyze log entries when all of
233+
* the following are true:
234234
*
235+
* * Customer-managed encryption keys (CMEK) are disabled on the log bucket.
236+
* * The log bucket satisfies one of the following:
237+
* * The log bucket is stored in the same project where the logs
238+
* originated.
239+
* * The logs were routed to a project, and then that project stored those
240+
* logs in a log bucket that it owns.
235241
*
236242
* The async variant is {@see ReportErrorsServiceClient::reportErrorEventAsync()} .
237243
*

‎ErrorReporting/src/V1beta1/DeleteEventsRequest.php‎

Lines changed: 46 additions & 20 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)