source: vendor/google/apiclient-services/src/Clouderrorreporting/Resource/ProjectsGroupStats.php

Last change on this file was e3d4e0a, checked in by Vlado 222039 <vlado.popovski@…>, 6 weeks ago

Upload project files

  • Property mode set to 100644
File size: 4.4 KB
Line 
1<?php
2/*
3 * Copyright 2014 Google Inc.
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
6 * use this file except in compliance with the License. You may obtain a copy of
7 * the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
13 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
14 * License for the specific language governing permissions and limitations under
15 * the License.
16 */
17
18namespace Google\Service\Clouderrorreporting\Resource;
19
20use Google\Service\Clouderrorreporting\ListGroupStatsResponse;
21
22/**
23 * The "groupStats" collection of methods.
24 * Typical usage is:
25 * <code>
26 * $clouderrorreportingService = new Google\Service\Clouderrorreporting(...);
27 * $groupStats = $clouderrorreportingService->projects_groupStats;
28 * </code>
29 */
30class ProjectsGroupStats extends \Google\Service\Resource
31{
32 /**
33 * Lists the specified groups. (groupStats.listProjectsGroupStats)
34 *
35 * @param string $projectName Required. The resource name of the Google Cloud
36 * Platform project. Written as `projects/{projectID}` or
37 * `projects/{projectNumber}`, where `{projectID}` and `{projectNumber}` can be
38 * found in the [Google Cloud
39 * console](https://support.google.com/cloud/answer/6158840). It may also
40 * include a location, such as `projects/{projectID}/locations/{location}` where
41 * `{location}` is a cloud region. Examples: `projects/my-project-123`,
42 * `projects/5551234`, `projects/my-project-123/locations/us-central1`,
43 * `projects/5551234/locations/us-central1`. For a list of supported locations,
44 * see [Supported Regions](https://cloud.google.com/logging/docs/region-
45 * support). `global` is the default when unspecified. Use `-` as a wildcard to
46 * request group stats from all regions.
47 * @param array $optParams Optional parameters.
48 *
49 * @opt_param string alignment Optional. The alignment of the timed counts to be
50 * returned. Default is `ALIGNMENT_EQUAL_AT_END`.
51 * @opt_param string alignmentTime Optional. Time where the timed counts shall
52 * be aligned if rounded alignment is chosen. Default is 00:00 UTC.
53 * @opt_param string groupId Optional. List all ErrorGroupStats with these IDs.
54 * The `group_id` is a unique identifier for a particular error group. The
55 * identifier is derived from key parts of the error-log content and is treated
56 * as Service Data. For information about how Service Data is handled, see
57 * [Google Cloud Privacy Notice] (https://cloud.google.com/terms/cloud-privacy-
58 * notice).
59 * @opt_param string order Optional. The sort order in which the results are
60 * returned. Default is `COUNT_DESC`.
61 * @opt_param int pageSize Optional. The maximum number of results to return per
62 * response. Default is 20.
63 * @opt_param string pageToken Optional. A next_page_token provided by a
64 * previous response. To view additional results, pass this token along with the
65 * identical query parameters as the first request.
66 * @opt_param string serviceFilter.resourceType Optional. The exact value to
67 * match against [`ServiceContext.resource_type`](/error-
68 * reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type).
69 * @opt_param string serviceFilter.service Optional. The exact value to match
70 * against [`ServiceContext.service`](/error-
71 * reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service).
72 * @opt_param string serviceFilter.version Optional. The exact value to match
73 * against [`ServiceContext.version`](/error-
74 * reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version).
75 * @opt_param string timeRange.period Restricts the query to the specified time
76 * range.
77 * @opt_param string timedCountDuration Optional. The preferred duration for a
78 * single returned TimedCount. If not set, no timed counts are returned.
79 * @return ListGroupStatsResponse
80 * @throws \Google\Service\Exception
81 */
82 public function listProjectsGroupStats($projectName, $optParams = [])
83 {
84 $params = ['projectName' => $projectName];
85 $params = array_merge($params, $optParams);
86 return $this->call('list', [$params], ListGroupStatsResponse::class);
87 }
88}
89
90// Adding a class alias for backwards compatibility with the previous class name.
91class_alias(ProjectsGroupStats::class, 'Google_Service_Clouderrorreporting_Resource_ProjectsGroupStats');
Note: See TracBrowser for help on using the repository browser.