1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
|
# Copyright 2015 Google Inc.
#
# 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.
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module ClouderrorreportingV1beta1
# Error Reporting API
#
# Groups and counts similar errors from cloud services and applications, reports
# new errors, and provides access to error groups and their associated errors.
#
# @example
# require 'google/apis/clouderrorreporting_v1beta1'
#
# Clouderrorreporting = Google::Apis::ClouderrorreportingV1beta1 # Alias the module
# service = Clouderrorreporting::ClouderrorreportingService.new
#
# @see https://cloud.google.com/error-reporting/
class ClouderrorreportingService < Google::Apis::Core::BaseService
# @return [String]
# API key. Your API key identifies your project and provides you with API access,
# quota, and reports. Required unless you provide an OAuth 2.0 token.
attr_accessor :key
# @return [String]
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
attr_accessor :quota_user
def initialize
super('https://clouderrorreporting.googleapis.com/', '')
@batch_path = 'batch'
end
# Deletes all error events of a given project.
# @param [String] project_name
# Required. The resource name of the Google Cloud Platform project. Written as `
# projects/`projectID``, where ``projectID`` is the [Google Cloud Platform
# project ID](https://support.google.com/cloud/answer/6158840). Example: `
# projects/my-project-123`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ClouderrorreportingV1beta1::DeleteEventsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ClouderrorreportingV1beta1::DeleteEventsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_project_events(project_name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1beta1/{+projectName}/events', options)
command.response_representation = Google::Apis::ClouderrorreportingV1beta1::DeleteEventsResponse::Representation
command.response_class = Google::Apis::ClouderrorreportingV1beta1::DeleteEventsResponse
command.params['projectName'] = project_name unless project_name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists the specified events.
# @param [String] project_name
# Required. The resource name of the Google Cloud Platform project. Written as `
# projects/`projectID``, where ``projectID`` is the [Google Cloud Platform
# project ID](https://support.google.com/cloud/answer/6158840). Example: `
# projects/my-project-123`.
# @param [String] group_id
# Required. The group for which events shall be returned.
# @param [Fixnum] page_size
# Optional. The maximum number of results to return per response.
# @param [String] page_token
# Optional. A `next_page_token` provided by a previous response.
# @param [String] service_filter_resource_type
# Optional. The exact value to match against [`ServiceContext.resource_type`](/
# error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type).
# @param [String] service_filter_service
# Optional. The exact value to match against [`ServiceContext.service`](/error-
# reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service).
# @param [String] service_filter_version
# Optional. The exact value to match against [`ServiceContext.version`](/error-
# reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version).
# @param [String] time_range_period
# Restricts the query to the specified time range.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ClouderrorreportingV1beta1::ListEventsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ClouderrorreportingV1beta1::ListEventsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_project_events(project_name, group_id: nil, page_size: nil, page_token: nil, service_filter_resource_type: nil, service_filter_service: nil, service_filter_version: nil, time_range_period: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/{+projectName}/events', options)
command.response_representation = Google::Apis::ClouderrorreportingV1beta1::ListEventsResponse::Representation
command.response_class = Google::Apis::ClouderrorreportingV1beta1::ListEventsResponse
command.params['projectName'] = project_name unless project_name.nil?
command.query['groupId'] = group_id unless group_id.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['serviceFilter.resourceType'] = service_filter_resource_type unless service_filter_resource_type.nil?
command.query['serviceFilter.service'] = service_filter_service unless service_filter_service.nil?
command.query['serviceFilter.version'] = service_filter_version unless service_filter_version.nil?
command.query['timeRange.period'] = time_range_period unless time_range_period.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Report an individual error event. This endpoint accepts **either** an OAuth
# token, **or** an [API key](https://support.google.com/cloud/answer/6158862)
# for authentication. To use an API key, append it to the URL as the value of a `
# key` parameter. For example: `POST https://clouderrorreporting.googleapis.com/
# v1beta1/`projectName`/events:report?key=123ABC456`
# @param [String] project_name
# Required. The resource name of the Google Cloud Platform project. Written as `
# projects/`projectId``, where ``projectId`` is the [Google Cloud Platform
# project ID](https://support.google.com/cloud/answer/6158840). Example: // `
# projects/my-project-123`.
# @param [Google::Apis::ClouderrorreportingV1beta1::ReportedErrorEvent] reported_error_event_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ClouderrorreportingV1beta1::ReportErrorEventResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ClouderrorreportingV1beta1::ReportErrorEventResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def report_project_event(project_name, reported_error_event_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/{+projectName}/events:report', options)
command.request_representation = Google::Apis::ClouderrorreportingV1beta1::ReportedErrorEvent::Representation
command.request_object = reported_error_event_object
command.response_representation = Google::Apis::ClouderrorreportingV1beta1::ReportErrorEventResponse::Representation
command.response_class = Google::Apis::ClouderrorreportingV1beta1::ReportErrorEventResponse
command.params['projectName'] = project_name unless project_name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists the specified groups.
# @param [String] project_name
# Required. The resource name of the Google Cloud Platform project. Written as `
# projects/`projectID``, where ``projectID`` is the [Google Cloud Platform
# project ID](https://support.google.com/cloud/answer/6158840). Example: `
# projects/my-project-123`.
# @param [String] alignment
# Optional. The alignment of the timed counts to be returned. Default is `
# ALIGNMENT_EQUAL_AT_END`.
# @param [String] alignment_time
# Optional. Time where the timed counts shall be aligned if rounded alignment is
# chosen. Default is 00:00 UTC.
# @param [Array<String>, String] group_id
# Optional. List all ErrorGroupStats with these IDs.
# @param [String] order
# Optional. The sort order in which the results are returned. Default is `
# COUNT_DESC`.
# @param [Fixnum] page_size
# Optional. The maximum number of results to return per response. Default is 20.
# @param [String] page_token
# 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.
# @param [String] service_filter_resource_type
# Optional. The exact value to match against [`ServiceContext.resource_type`](/
# error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type).
# @param [String] service_filter_service
# Optional. The exact value to match against [`ServiceContext.service`](/error-
# reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service).
# @param [String] service_filter_version
# Optional. The exact value to match against [`ServiceContext.version`](/error-
# reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version).
# @param [String] time_range_period
# Restricts the query to the specified time range.
# @param [String] timed_count_duration
# Optional. The preferred duration for a single returned `TimedCount`. If not
# set, no timed counts are returned.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ClouderrorreportingV1beta1::ListGroupStatsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ClouderrorreportingV1beta1::ListGroupStatsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_project_group_stats(project_name, alignment: nil, alignment_time: nil, group_id: nil, order: nil, page_size: nil, page_token: nil, service_filter_resource_type: nil, service_filter_service: nil, service_filter_version: nil, time_range_period: nil, timed_count_duration: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/{+projectName}/groupStats', options)
command.response_representation = Google::Apis::ClouderrorreportingV1beta1::ListGroupStatsResponse::Representation
command.response_class = Google::Apis::ClouderrorreportingV1beta1::ListGroupStatsResponse
command.params['projectName'] = project_name unless project_name.nil?
command.query['alignment'] = alignment unless alignment.nil?
command.query['alignmentTime'] = alignment_time unless alignment_time.nil?
command.query['groupId'] = group_id unless group_id.nil?
command.query['order'] = order unless order.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['serviceFilter.resourceType'] = service_filter_resource_type unless service_filter_resource_type.nil?
command.query['serviceFilter.service'] = service_filter_service unless service_filter_service.nil?
command.query['serviceFilter.version'] = service_filter_version unless service_filter_version.nil?
command.query['timeRange.period'] = time_range_period unless time_range_period.nil?
command.query['timedCountDuration'] = timed_count_duration unless timed_count_duration.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Get the specified group.
# @param [String] group_name
# 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) to return a list of
# groups belonging to this project. Example: `projects/my-project-123/groups/my-
# group`
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ClouderrorreportingV1beta1::ErrorGroup] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ClouderrorreportingV1beta1::ErrorGroup]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_group(group_name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/{+groupName}', options)
command.response_representation = Google::Apis::ClouderrorreportingV1beta1::ErrorGroup::Representation
command.response_class = Google::Apis::ClouderrorreportingV1beta1::ErrorGroup
command.params['groupName'] = group_name unless group_name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Replace the data for the specified group. Fails if the group does not exist.
# @param [String] name
# The group resource name. Example: projects/my-project-123/groups/
# CNSgkpnppqKCUw
# @param [Google::Apis::ClouderrorreportingV1beta1::ErrorGroup] error_group_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ClouderrorreportingV1beta1::ErrorGroup] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ClouderrorreportingV1beta1::ErrorGroup]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def update_project_group(name, error_group_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:put, 'v1beta1/{+name}', options)
command.request_representation = Google::Apis::ClouderrorreportingV1beta1::ErrorGroup::Representation
command.request_object = error_group_object
command.response_representation = Google::Apis::ClouderrorreportingV1beta1::ErrorGroup::Representation
command.response_class = Google::Apis::ClouderrorreportingV1beta1::ErrorGroup
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
protected
def apply_command_defaults(command)
command.query['key'] = key unless key.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
end
end
end
end
end
|
