google-apis-firebasecrashlytics_v1alpha 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,606 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require 'google/apis/core/base_service'
16
+ require 'google/apis/core/json_representation'
17
+ require 'google/apis/core/hashable'
18
+ require 'google/apis/errors'
19
+
20
+ module Google
21
+ module Apis
22
+ module FirebasecrashlyticsV1alpha
23
+ # Firebase Crashlytics API
24
+ #
25
+ # This service provides an API for mobile app developers to request deletion of
26
+ # user's crash reports.
27
+ #
28
+ # @example
29
+ # require 'google/apis/firebasecrashlytics_v1alpha'
30
+ #
31
+ # Firebasecrashlytics = Google::Apis::FirebasecrashlyticsV1alpha # Alias the module
32
+ # service = Firebasecrashlytics::FirebaseCrashlyticsService.new
33
+ #
34
+ # @see https://firebase.google.com/docs/crashlytics
35
+ class FirebaseCrashlyticsService < Google::Apis::Core::BaseService
36
+ DEFAULT_ENDPOINT_TEMPLATE = "https://firebasecrashlytics.$UNIVERSE_DOMAIN$/"
37
+
38
+ # @return [String]
39
+ # API key. Your API key identifies your project and provides you with API access,
40
+ # quota, and reports. Required unless you provide an OAuth 2.0 token.
41
+ attr_accessor :key
42
+
43
+ # @return [String]
44
+ # Available to use for quota purposes for server-side applications. Can be any
45
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
46
+ attr_accessor :quota_user
47
+
48
+ def initialize
49
+ super(DEFAULT_ENDPOINT_TEMPLATE, '',
50
+ client_name: 'google-apis-firebasecrashlytics_v1alpha',
51
+ client_version: Google::Apis::FirebasecrashlyticsV1alpha::GEM_VERSION)
52
+ @batch_path = 'batch'
53
+ end
54
+
55
+ # Fetch a batch of up to 100 events by name.
56
+ # @param [String] parent
57
+ # Required. The firebase application. Format: "projects/`project`/apps/`app_id`".
58
+ # @param [Array<String>, String] names
59
+ # Required. The resource names of the desired events. A maximum of 100 events
60
+ # can be retrieved in a batch. Format: "projects/`project`/apps/`app_id`/events/`
61
+ # event_id`". The app_id and event_id are required, but project may be "-" to
62
+ # conserve space in long URIs.
63
+ # @param [String] read_mask
64
+ # Optional. The list of Event fields to include in the response. If omitted, the
65
+ # full event is returned.
66
+ # @param [String] fields
67
+ # Selector specifying which fields to include in a partial response.
68
+ # @param [String] quota_user
69
+ # Available to use for quota purposes for server-side applications. Can be any
70
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
71
+ # @param [Google::Apis::RequestOptions] options
72
+ # Request-specific options
73
+ #
74
+ # @yield [result, err] Result & error if block supplied
75
+ # @yieldparam result [Google::Apis::FirebasecrashlyticsV1alpha::BatchGetEventsResponse] parsed result object
76
+ # @yieldparam err [StandardError] error object if request failed
77
+ #
78
+ # @return [Google::Apis::FirebasecrashlyticsV1alpha::BatchGetEventsResponse]
79
+ #
80
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
81
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
82
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
83
+ def batch_project_app_event_get(parent, names: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
84
+ command = make_simple_command(:get, 'v1alpha/{+parent}/events:batchGet', options)
85
+ command.response_representation = Google::Apis::FirebasecrashlyticsV1alpha::BatchGetEventsResponse::Representation
86
+ command.response_class = Google::Apis::FirebasecrashlyticsV1alpha::BatchGetEventsResponse
87
+ command.params['parent'] = parent unless parent.nil?
88
+ command.query['names'] = names unless names.nil?
89
+ command.query['readMask'] = read_mask unless read_mask.nil?
90
+ command.query['fields'] = fields unless fields.nil?
91
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
92
+ execute_or_queue_command(command, &block)
93
+ end
94
+
95
+ # List the events for an issue matching filter criteria, sorted in descending
96
+ # order by timestamp.
97
+ # @param [String] parent
98
+ # Required. The Firebase application. Format: "projects/`project`/apps/`app_id`".
99
+ # @param [Array<String>, String] filter_browser_display_names
100
+ # Optional. Only count events from the given browser. This string matches
101
+ # Browser.display_name. Format: "name (display_version)" e.g. "Chrome (123)", or
102
+ # just "name" for all possible versions, e.g. simply "Chrome".
103
+ # @param [Array<String>, String] filter_device_display_names
104
+ # Only counts events from the given Device model. This string matches Device.
105
+ # display_name. Format: "manufacturer (model)" e.g. "Google (Pixel 6)", or just "
106
+ # manufacturer" for all possible models, e.g. simply "Google". Note that a
107
+ # device's marketing_name field can not be used for filtering.
108
+ # @param [Array<String>, String] filter_device_form_factors
109
+ # Only counts events from devices with the given form factor (e.g. phone or
110
+ # tablet).
111
+ # @param [String] filter_interval_end_time
112
+ # Optional. Exclusive end of the interval. If specified, a Timestamp matching
113
+ # this interval will have to be before the end.
114
+ # @param [String] filter_interval_start_time
115
+ # Optional. Inclusive start of the interval. If specified, a Timestamp matching
116
+ # this interval will have to be the same or after the start.
117
+ # @param [String] filter_issue_content
118
+ # Optional. A space separated list of filter terms matched against the contents
119
+ # of the issue. Contents include the title and the stack trace. Matches must
120
+ # begin at alphanumeric tokens, i.e., 'util.Sorted' matches 'java.util.SortedSet'
121
+ # but not 'myutil.SortedArray'. The filter matches if all filter terms match.
122
+ # All non-alphanumeric characters are ignored for matching. Filtering is assumed
123
+ # to be prefix-search and order-independent unless phrases are surrounded by "".
124
+ # Any terms contained in quotes are searched using exact-match (given filter
125
+ # term "foo", we will not return "foobar"), and must appear in the order given
126
+ # exactly. To get order-dependence but prefix-search, use a * within the quotes (
127
+ # "abc foo*" will match "abc foobar", but not "foo abc" "abcd foobar", or "abc
128
+ # xyz foobar").
129
+ # @param [Array<String>, String] filter_issue_error_types
130
+ # Optional. Only counts events of the given error types. This field matches [
131
+ # Issue.error_type].
132
+ # @param [String] filter_issue_id
133
+ # Optional. Only counts events in the given issue ID. This field matches [Issue.
134
+ # id].
135
+ # @param [Array<String>, String] filter_issue_signals
136
+ # Optional. Only returns issues currently marked with the given signals. This
137
+ # field matches [Issue.signals.signal].
138
+ # @param [String] filter_issue_state
139
+ # Optional. Deprecated: Prefer `states` field. Only includes events for issues
140
+ # with the given issue state. Only available for `topIssues` reports.
141
+ # @param [Array<String>, String] filter_issue_states
142
+ # Optional. Only includes events for issues with the given issue states. Only
143
+ # available for `topIssues` reports.
144
+ # @param [String] filter_issue_variant_id
145
+ # Optional. Only counts events for the given issue variant ID. This field
146
+ # matches [IssueVariant.id].
147
+ # @param [Array<String>, String] filter_operating_system_display_names
148
+ # Only counts events in the given operating system and version. This string
149
+ # matches OperatingSystem.display_name. Format: "osName (osVersion)" e.g. "
150
+ # Android (11)". or just "osName" for all versions, e.g. simply "iPadOS".
151
+ # @param [Array<String>, String] filter_version_display_names
152
+ # Only counts events in the given app version. This string matches Version.
153
+ # display_name. Format: "display_version (build_version)" e.g. "1.2.3 (456)".
154
+ # @param [Fixnum] page_size
155
+ # Optional. The maximum number of events per page. If omitted, defaults to 10.
156
+ # @param [String] page_token
157
+ # Optional. A page token, received from a previous calls.
158
+ # @param [String] read_mask
159
+ # Optional. The list of Event fields to include in the response. If omitted, the
160
+ # full event is returned.
161
+ # @param [String] fields
162
+ # Selector specifying which fields to include in a partial response.
163
+ # @param [String] quota_user
164
+ # Available to use for quota purposes for server-side applications. Can be any
165
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
166
+ # @param [Google::Apis::RequestOptions] options
167
+ # Request-specific options
168
+ #
169
+ # @yield [result, err] Result & error if block supplied
170
+ # @yieldparam result [Google::Apis::FirebasecrashlyticsV1alpha::ListEventsResponse] parsed result object
171
+ # @yieldparam err [StandardError] error object if request failed
172
+ #
173
+ # @return [Google::Apis::FirebasecrashlyticsV1alpha::ListEventsResponse]
174
+ #
175
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
176
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
177
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
178
+ def list_project_app_events(parent, filter_browser_display_names: nil, filter_device_display_names: nil, filter_device_form_factors: nil, filter_interval_end_time: nil, filter_interval_start_time: nil, filter_issue_content: nil, filter_issue_error_types: nil, filter_issue_id: nil, filter_issue_signals: nil, filter_issue_state: nil, filter_issue_states: nil, filter_issue_variant_id: nil, filter_operating_system_display_names: nil, filter_version_display_names: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
179
+ command = make_simple_command(:get, 'v1alpha/{+parent}/events', options)
180
+ command.response_representation = Google::Apis::FirebasecrashlyticsV1alpha::ListEventsResponse::Representation
181
+ command.response_class = Google::Apis::FirebasecrashlyticsV1alpha::ListEventsResponse
182
+ command.params['parent'] = parent unless parent.nil?
183
+ command.query['filter.browser.displayNames'] = filter_browser_display_names unless filter_browser_display_names.nil?
184
+ command.query['filter.device.displayNames'] = filter_device_display_names unless filter_device_display_names.nil?
185
+ command.query['filter.device.formFactors'] = filter_device_form_factors unless filter_device_form_factors.nil?
186
+ command.query['filter.interval.endTime'] = filter_interval_end_time unless filter_interval_end_time.nil?
187
+ command.query['filter.interval.startTime'] = filter_interval_start_time unless filter_interval_start_time.nil?
188
+ command.query['filter.issue.content'] = filter_issue_content unless filter_issue_content.nil?
189
+ command.query['filter.issue.errorTypes'] = filter_issue_error_types unless filter_issue_error_types.nil?
190
+ command.query['filter.issue.id'] = filter_issue_id unless filter_issue_id.nil?
191
+ command.query['filter.issue.signals'] = filter_issue_signals unless filter_issue_signals.nil?
192
+ command.query['filter.issue.state'] = filter_issue_state unless filter_issue_state.nil?
193
+ command.query['filter.issue.states'] = filter_issue_states unless filter_issue_states.nil?
194
+ command.query['filter.issue.variantId'] = filter_issue_variant_id unless filter_issue_variant_id.nil?
195
+ command.query['filter.operatingSystem.displayNames'] = filter_operating_system_display_names unless filter_operating_system_display_names.nil?
196
+ command.query['filter.version.displayNames'] = filter_version_display_names unless filter_version_display_names.nil?
197
+ command.query['pageSize'] = page_size unless page_size.nil?
198
+ command.query['pageToken'] = page_token unless page_token.nil?
199
+ command.query['readMask'] = read_mask unless read_mask.nil?
200
+ command.query['fields'] = fields unless fields.nil?
201
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
202
+ execute_or_queue_command(command, &block)
203
+ end
204
+
205
+ # Change the state of a group of issues. This method is not atomic, so partial
206
+ # failures can occur. In the event of a partial failure, the request will fail
207
+ # and you will need to call `GetIssue` to see which issues were not updated.
208
+ # @param [String] parent
209
+ # Required. The parent resource shared by all issues being updated. Format:
210
+ # projects/`project`/apps/`app`. If this is set, the parent field in the
211
+ # UpdateIssueRequest messages must either be empty or match this field.
212
+ # @param [Google::Apis::FirebasecrashlyticsV1alpha::BatchUpdateIssuesRequest] batch_update_issues_request_object
213
+ # @param [String] fields
214
+ # Selector specifying which fields to include in a partial response.
215
+ # @param [String] quota_user
216
+ # Available to use for quota purposes for server-side applications. Can be any
217
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
218
+ # @param [Google::Apis::RequestOptions] options
219
+ # Request-specific options
220
+ #
221
+ # @yield [result, err] Result & error if block supplied
222
+ # @yieldparam result [Google::Apis::FirebasecrashlyticsV1alpha::BatchUpdateIssuesResponse] parsed result object
223
+ # @yieldparam err [StandardError] error object if request failed
224
+ #
225
+ # @return [Google::Apis::FirebasecrashlyticsV1alpha::BatchUpdateIssuesResponse]
226
+ #
227
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
228
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
229
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
230
+ def batch_update_issues(parent, batch_update_issues_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
231
+ command = make_simple_command(:post, 'v1alpha/{+parent}/issues:batchUpdate', options)
232
+ command.request_representation = Google::Apis::FirebasecrashlyticsV1alpha::BatchUpdateIssuesRequest::Representation
233
+ command.request_object = batch_update_issues_request_object
234
+ command.response_representation = Google::Apis::FirebasecrashlyticsV1alpha::BatchUpdateIssuesResponse::Representation
235
+ command.response_class = Google::Apis::FirebasecrashlyticsV1alpha::BatchUpdateIssuesResponse
236
+ command.params['parent'] = parent unless parent.nil?
237
+ command.query['fields'] = fields unless fields.nil?
238
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
239
+ execute_or_queue_command(command, &block)
240
+ end
241
+
242
+ # Retrieve an issue.
243
+ # @param [String] name
244
+ # Required. The name of the issue to retrieve. Format: "projects/`project`/apps/`
245
+ # app`/issues/`issue`".
246
+ # @param [String] fields
247
+ # Selector specifying which fields to include in a partial response.
248
+ # @param [String] quota_user
249
+ # Available to use for quota purposes for server-side applications. Can be any
250
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
251
+ # @param [Google::Apis::RequestOptions] options
252
+ # Request-specific options
253
+ #
254
+ # @yield [result, err] Result & error if block supplied
255
+ # @yieldparam result [Google::Apis::FirebasecrashlyticsV1alpha::Issue] parsed result object
256
+ # @yieldparam err [StandardError] error object if request failed
257
+ #
258
+ # @return [Google::Apis::FirebasecrashlyticsV1alpha::Issue]
259
+ #
260
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
261
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
262
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
263
+ def get_project_app_issue(name, fields: nil, quota_user: nil, options: nil, &block)
264
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
265
+ command.response_representation = Google::Apis::FirebasecrashlyticsV1alpha::Issue::Representation
266
+ command.response_class = Google::Apis::FirebasecrashlyticsV1alpha::Issue
267
+ command.params['name'] = name unless name.nil?
268
+ command.query['fields'] = fields unless fields.nil?
269
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
270
+ execute_or_queue_command(command, &block)
271
+ end
272
+
273
+ # Change the state of an issue.
274
+ # @param [String] name
275
+ # Required. Output only. Immutable. Identifier. The name of the issue resource.
276
+ # Format: "projects/`project`/apps/`app`/issues/`issue`".
277
+ # @param [Google::Apis::FirebasecrashlyticsV1alpha::Issue] issue_object
278
+ # @param [String] update_mask
279
+ # Optional. The list of Issue fields to update. Currently only "state" is
280
+ # mutable.
281
+ # @param [String] fields
282
+ # Selector specifying which fields to include in a partial response.
283
+ # @param [String] quota_user
284
+ # Available to use for quota purposes for server-side applications. Can be any
285
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
286
+ # @param [Google::Apis::RequestOptions] options
287
+ # Request-specific options
288
+ #
289
+ # @yield [result, err] Result & error if block supplied
290
+ # @yieldparam result [Google::Apis::FirebasecrashlyticsV1alpha::Issue] parsed result object
291
+ # @yieldparam err [StandardError] error object if request failed
292
+ #
293
+ # @return [Google::Apis::FirebasecrashlyticsV1alpha::Issue]
294
+ #
295
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
296
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
297
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
298
+ def patch_project_app_issue(name, issue_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
299
+ command = make_simple_command(:patch, 'v1alpha/{+name}', options)
300
+ command.request_representation = Google::Apis::FirebasecrashlyticsV1alpha::Issue::Representation
301
+ command.request_object = issue_object
302
+ command.response_representation = Google::Apis::FirebasecrashlyticsV1alpha::Issue::Representation
303
+ command.response_class = Google::Apis::FirebasecrashlyticsV1alpha::Issue
304
+ command.params['name'] = name unless name.nil?
305
+ command.query['updateMask'] = update_mask unless update_mask.nil?
306
+ command.query['fields'] = fields unless fields.nil?
307
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
308
+ execute_or_queue_command(command, &block)
309
+ end
310
+
311
+ # Create a new note for an issue.
312
+ # @param [String] parent
313
+ # Required. The parent resource where this note will be created. Format: "
314
+ # projects/`project`/apps/`app`/issues/`issue`".
315
+ # @param [Google::Apis::FirebasecrashlyticsV1alpha::Note] note_object
316
+ # @param [String] fields
317
+ # Selector specifying which fields to include in a partial response.
318
+ # @param [String] quota_user
319
+ # Available to use for quota purposes for server-side applications. Can be any
320
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
321
+ # @param [Google::Apis::RequestOptions] options
322
+ # Request-specific options
323
+ #
324
+ # @yield [result, err] Result & error if block supplied
325
+ # @yieldparam result [Google::Apis::FirebasecrashlyticsV1alpha::Note] parsed result object
326
+ # @yieldparam err [StandardError] error object if request failed
327
+ #
328
+ # @return [Google::Apis::FirebasecrashlyticsV1alpha::Note]
329
+ #
330
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
331
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
332
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
333
+ def create_project_app_issue_note(parent, note_object = nil, fields: nil, quota_user: nil, options: nil, &block)
334
+ command = make_simple_command(:post, 'v1alpha/{+parent}/notes', options)
335
+ command.request_representation = Google::Apis::FirebasecrashlyticsV1alpha::Note::Representation
336
+ command.request_object = note_object
337
+ command.response_representation = Google::Apis::FirebasecrashlyticsV1alpha::Note::Representation
338
+ command.response_class = Google::Apis::FirebasecrashlyticsV1alpha::Note
339
+ command.params['parent'] = parent unless parent.nil?
340
+ command.query['fields'] = fields unless fields.nil?
341
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
342
+ execute_or_queue_command(command, &block)
343
+ end
344
+
345
+ # Delete a note by its name.
346
+ # @param [String] name
347
+ # Required. The name of the note to delete. Format: projects/`project`/apps/`app`
348
+ # /issues/`issue`/notes/`note`.
349
+ # @param [String] fields
350
+ # Selector specifying which fields to include in a partial response.
351
+ # @param [String] quota_user
352
+ # Available to use for quota purposes for server-side applications. Can be any
353
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
354
+ # @param [Google::Apis::RequestOptions] options
355
+ # Request-specific options
356
+ #
357
+ # @yield [result, err] Result & error if block supplied
358
+ # @yieldparam result [Google::Apis::FirebasecrashlyticsV1alpha::Empty] parsed result object
359
+ # @yieldparam err [StandardError] error object if request failed
360
+ #
361
+ # @return [Google::Apis::FirebasecrashlyticsV1alpha::Empty]
362
+ #
363
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
364
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
365
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
366
+ def delete_project_app_issue_note(name, fields: nil, quota_user: nil, options: nil, &block)
367
+ command = make_simple_command(:delete, 'v1alpha/{+name}', options)
368
+ command.response_representation = Google::Apis::FirebasecrashlyticsV1alpha::Empty::Representation
369
+ command.response_class = Google::Apis::FirebasecrashlyticsV1alpha::Empty
370
+ command.params['name'] = name unless name.nil?
371
+ command.query['fields'] = fields unless fields.nil?
372
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
373
+ execute_or_queue_command(command, &block)
374
+ end
375
+
376
+ # List all notes for a certain issue, sorted in descending order by timestamp.
377
+ # @param [String] parent
378
+ # Required. The issue the notes belongs to. Format: "projects/`project`/apps/`
379
+ # app`/issues/`issue`".
380
+ # @param [Fixnum] page_size
381
+ # Optional. The maximum number of notes per page. If omitted, defaults to 10.
382
+ # @param [String] page_token
383
+ # Optional. A page token, received from a previous calls.
384
+ # @param [String] fields
385
+ # Selector specifying which fields to include in a partial response.
386
+ # @param [String] quota_user
387
+ # Available to use for quota purposes for server-side applications. Can be any
388
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
389
+ # @param [Google::Apis::RequestOptions] options
390
+ # Request-specific options
391
+ #
392
+ # @yield [result, err] Result & error if block supplied
393
+ # @yieldparam result [Google::Apis::FirebasecrashlyticsV1alpha::ListNotesResponse] parsed result object
394
+ # @yieldparam err [StandardError] error object if request failed
395
+ #
396
+ # @return [Google::Apis::FirebasecrashlyticsV1alpha::ListNotesResponse]
397
+ #
398
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
399
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
400
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
401
+ def list_project_app_issue_notes(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
402
+ command = make_simple_command(:get, 'v1alpha/{+parent}/notes', options)
403
+ command.response_representation = Google::Apis::FirebasecrashlyticsV1alpha::ListNotesResponse::Representation
404
+ command.response_class = Google::Apis::FirebasecrashlyticsV1alpha::ListNotesResponse
405
+ command.params['parent'] = parent unless parent.nil?
406
+ command.query['pageSize'] = page_size unless page_size.nil?
407
+ command.query['pageToken'] = page_token unless page_token.nil?
408
+ command.query['fields'] = fields unless fields.nil?
409
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
410
+ execute_or_queue_command(command, &block)
411
+ end
412
+
413
+ # Get a report with its computed results.
414
+ # @param [String] name
415
+ # Required. The report name. Format: "projects/`project`/apps/`app_id`/reports/`
416
+ # report`".
417
+ # @param [Array<String>, String] filter_browser_display_names
418
+ # Optional. Only count events from the given browser. This string matches
419
+ # Browser.display_name. Format: "name (display_version)" e.g. "Chrome (123)", or
420
+ # just "name" for all possible versions, e.g. simply "Chrome".
421
+ # @param [Array<String>, String] filter_device_display_names
422
+ # Only counts events from the given Device model. This string matches Device.
423
+ # display_name. Format: "manufacturer (model)" e.g. "Google (Pixel 6)", or just "
424
+ # manufacturer" for all possible models, e.g. simply "Google". Note that a
425
+ # device's marketing_name field can not be used for filtering.
426
+ # @param [Array<String>, String] filter_device_form_factors
427
+ # Only counts events from devices with the given form factor (e.g. phone or
428
+ # tablet).
429
+ # @param [String] filter_interval_end_time
430
+ # Optional. Exclusive end of the interval. If specified, a Timestamp matching
431
+ # this interval will have to be before the end.
432
+ # @param [String] filter_interval_start_time
433
+ # Optional. Inclusive start of the interval. If specified, a Timestamp matching
434
+ # this interval will have to be the same or after the start.
435
+ # @param [String] filter_issue_content
436
+ # Optional. A space separated list of filter terms matched against the contents
437
+ # of the issue. Contents include the title and the stack trace. Matches must
438
+ # begin at alphanumeric tokens, i.e., 'util.Sorted' matches 'java.util.SortedSet'
439
+ # but not 'myutil.SortedArray'. The filter matches if all filter terms match.
440
+ # All non-alphanumeric characters are ignored for matching. Filtering is assumed
441
+ # to be prefix-search and order-independent unless phrases are surrounded by "".
442
+ # Any terms contained in quotes are searched using exact-match (given filter
443
+ # term "foo", we will not return "foobar"), and must appear in the order given
444
+ # exactly. To get order-dependence but prefix-search, use a * within the quotes (
445
+ # "abc foo*" will match "abc foobar", but not "foo abc" "abcd foobar", or "abc
446
+ # xyz foobar").
447
+ # @param [Array<String>, String] filter_issue_error_types
448
+ # Optional. Only counts events of the given error types. This field matches [
449
+ # Issue.error_type].
450
+ # @param [String] filter_issue_id
451
+ # Optional. Only counts events in the given issue ID. This field matches [Issue.
452
+ # id].
453
+ # @param [Array<String>, String] filter_issue_signals
454
+ # Optional. Only returns issues currently marked with the given signals. This
455
+ # field matches [Issue.signals.signal].
456
+ # @param [String] filter_issue_state
457
+ # Optional. Deprecated: Prefer `states` field. Only includes events for issues
458
+ # with the given issue state. Only available for `topIssues` reports.
459
+ # @param [Array<String>, String] filter_issue_states
460
+ # Optional. Only includes events for issues with the given issue states. Only
461
+ # available for `topIssues` reports.
462
+ # @param [String] filter_issue_variant_id
463
+ # Optional. Only counts events for the given issue variant ID. This field
464
+ # matches [IssueVariant.id].
465
+ # @param [Array<String>, String] filter_operating_system_display_names
466
+ # Only counts events in the given operating system and version. This string
467
+ # matches OperatingSystem.display_name. Format: "osName (osVersion)" e.g. "
468
+ # Android (11)". or just "osName" for all versions, e.g. simply "iPadOS".
469
+ # @param [Array<String>, String] filter_version_display_names
470
+ # Only counts events in the given app version. This string matches Version.
471
+ # display_name. Format: "display_version (build_version)" e.g. "1.2.3 (456)".
472
+ # @param [String] granularity
473
+ # Optional. The report response will contain one data point per time grain. If
474
+ # omitted, the report will contain a single data point for the complete interval.
475
+ # @param [Fixnum] page_size
476
+ # Optional. The maximum number of result groups to return. If omitted, defaults
477
+ # to 25.
478
+ # @param [String] page_token
479
+ # Optional. A page token, received from a previous call. The page token is only
480
+ # valid for the exact same set of filters, which must also be sent in subsequent
481
+ # requests. This token is valid for 10 minutes after the first request.
482
+ # @param [String] fields
483
+ # Selector specifying which fields to include in a partial response.
484
+ # @param [String] quota_user
485
+ # Available to use for quota purposes for server-side applications. Can be any
486
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
487
+ # @param [Google::Apis::RequestOptions] options
488
+ # Request-specific options
489
+ #
490
+ # @yield [result, err] Result & error if block supplied
491
+ # @yieldparam result [Google::Apis::FirebasecrashlyticsV1alpha::Report] parsed result object
492
+ # @yieldparam err [StandardError] error object if request failed
493
+ #
494
+ # @return [Google::Apis::FirebasecrashlyticsV1alpha::Report]
495
+ #
496
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
497
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
498
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
499
+ def get_project_app_report(name, filter_browser_display_names: nil, filter_device_display_names: nil, filter_device_form_factors: nil, filter_interval_end_time: nil, filter_interval_start_time: nil, filter_issue_content: nil, filter_issue_error_types: nil, filter_issue_id: nil, filter_issue_signals: nil, filter_issue_state: nil, filter_issue_states: nil, filter_issue_variant_id: nil, filter_operating_system_display_names: nil, filter_version_display_names: nil, granularity: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
500
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
501
+ command.response_representation = Google::Apis::FirebasecrashlyticsV1alpha::Report::Representation
502
+ command.response_class = Google::Apis::FirebasecrashlyticsV1alpha::Report
503
+ command.params['name'] = name unless name.nil?
504
+ command.query['filter.browser.displayNames'] = filter_browser_display_names unless filter_browser_display_names.nil?
505
+ command.query['filter.device.displayNames'] = filter_device_display_names unless filter_device_display_names.nil?
506
+ command.query['filter.device.formFactors'] = filter_device_form_factors unless filter_device_form_factors.nil?
507
+ command.query['filter.interval.endTime'] = filter_interval_end_time unless filter_interval_end_time.nil?
508
+ command.query['filter.interval.startTime'] = filter_interval_start_time unless filter_interval_start_time.nil?
509
+ command.query['filter.issue.content'] = filter_issue_content unless filter_issue_content.nil?
510
+ command.query['filter.issue.errorTypes'] = filter_issue_error_types unless filter_issue_error_types.nil?
511
+ command.query['filter.issue.id'] = filter_issue_id unless filter_issue_id.nil?
512
+ command.query['filter.issue.signals'] = filter_issue_signals unless filter_issue_signals.nil?
513
+ command.query['filter.issue.state'] = filter_issue_state unless filter_issue_state.nil?
514
+ command.query['filter.issue.states'] = filter_issue_states unless filter_issue_states.nil?
515
+ command.query['filter.issue.variantId'] = filter_issue_variant_id unless filter_issue_variant_id.nil?
516
+ command.query['filter.operatingSystem.displayNames'] = filter_operating_system_display_names unless filter_operating_system_display_names.nil?
517
+ command.query['filter.version.displayNames'] = filter_version_display_names unless filter_version_display_names.nil?
518
+ command.query['granularity'] = granularity unless granularity.nil?
519
+ command.query['pageSize'] = page_size unless page_size.nil?
520
+ command.query['pageToken'] = page_token unless page_token.nil?
521
+ command.query['fields'] = fields unless fields.nil?
522
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
523
+ execute_or_queue_command(command, &block)
524
+ end
525
+
526
+ # List all of the available reports.
527
+ # @param [String] parent
528
+ # Required. The firebase application. Format: "projects/`project`/apps/`app_id`".
529
+ # @param [String] fields
530
+ # Selector specifying which fields to include in a partial response.
531
+ # @param [String] quota_user
532
+ # Available to use for quota purposes for server-side applications. Can be any
533
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
534
+ # @param [Google::Apis::RequestOptions] options
535
+ # Request-specific options
536
+ #
537
+ # @yield [result, err] Result & error if block supplied
538
+ # @yieldparam result [Google::Apis::FirebasecrashlyticsV1alpha::ListReportsResponse] parsed result object
539
+ # @yieldparam err [StandardError] error object if request failed
540
+ #
541
+ # @return [Google::Apis::FirebasecrashlyticsV1alpha::ListReportsResponse]
542
+ #
543
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
544
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
545
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
546
+ def list_project_app_reports(parent, fields: nil, quota_user: nil, options: nil, &block)
547
+ command = make_simple_command(:get, 'v1alpha/{+parent}/reports', options)
548
+ command.response_representation = Google::Apis::FirebasecrashlyticsV1alpha::ListReportsResponse::Representation
549
+ command.response_class = Google::Apis::FirebasecrashlyticsV1alpha::ListReportsResponse
550
+ command.params['parent'] = parent unless parent.nil?
551
+ command.query['fields'] = fields unless fields.nil?
552
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
553
+ execute_or_queue_command(command, &block)
554
+ end
555
+
556
+ # Enqueues a request to permanently remove crash reports associated with the
557
+ # specified user. All reports belonging to the specified user will be deleted
558
+ # typically within 24 hours of receiving the crash report.
559
+ # @param [String] name
560
+ # Required. Resource name for user reports, in the format: projects/
561
+ # PROJECT_IDENTIFIER/apps/APP_ID/users/USER_ID/crashReports - PROJECT_IDENTIFIER:
562
+ # The Firebase project's project number (recommended) or its project ID. Learn
563
+ # more about using project identifiers in Google's [AIP 2510 standard](https://
564
+ # google.aip.dev/cloud/2510). - APP_ID: The globally unique, Firebase-assigned
565
+ # identifier for the Firebase App. This is not your package name or bundle ID.
566
+ # Learn how to [find your app ID](https://firebase.google.com/support/faq/#find-
567
+ # app-id). - USER_ID: The user ID set using the Crashlytics SDK. Learn how to [
568
+ # set user identifiers](https://firebase.google.com/docs/crashlytics/customize-
569
+ # crash-reports#set-user-ids).
570
+ # @param [String] fields
571
+ # Selector specifying which fields to include in a partial response.
572
+ # @param [String] quota_user
573
+ # Available to use for quota purposes for server-side applications. Can be any
574
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
575
+ # @param [Google::Apis::RequestOptions] options
576
+ # Request-specific options
577
+ #
578
+ # @yield [result, err] Result & error if block supplied
579
+ # @yieldparam result [Google::Apis::FirebasecrashlyticsV1alpha::DeleteUserCrashReportsResponse] parsed result object
580
+ # @yieldparam err [StandardError] error object if request failed
581
+ #
582
+ # @return [Google::Apis::FirebasecrashlyticsV1alpha::DeleteUserCrashReportsResponse]
583
+ #
584
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
585
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
586
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
587
+ def delete_project_app_user_crash_reports(name, fields: nil, quota_user: nil, options: nil, &block)
588
+ command = make_simple_command(:delete, 'v1alpha/{+name}', options)
589
+ command.response_representation = Google::Apis::FirebasecrashlyticsV1alpha::DeleteUserCrashReportsResponse::Representation
590
+ command.response_class = Google::Apis::FirebasecrashlyticsV1alpha::DeleteUserCrashReportsResponse
591
+ command.params['name'] = name unless name.nil?
592
+ command.query['fields'] = fields unless fields.nil?
593
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
594
+ execute_or_queue_command(command, &block)
595
+ end
596
+
597
+ protected
598
+
599
+ def apply_command_defaults(command)
600
+ command.query['key'] = key unless key.nil?
601
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
602
+ end
603
+ end
604
+ end
605
+ end
606
+ end
@@ -0,0 +1,40 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require 'google/apis/firebasecrashlytics_v1alpha/service.rb'
16
+ require 'google/apis/firebasecrashlytics_v1alpha/classes.rb'
17
+ require 'google/apis/firebasecrashlytics_v1alpha/representations.rb'
18
+ require 'google/apis/firebasecrashlytics_v1alpha/gem_version.rb'
19
+
20
+ module Google
21
+ module Apis
22
+ # Firebase Crashlytics API
23
+ #
24
+ # This service provides an API for mobile app developers to request deletion of
25
+ # user's crash reports.
26
+ #
27
+ # @see https://firebase.google.com/docs/crashlytics
28
+ module FirebasecrashlyticsV1alpha
29
+ # Version of the Firebase Crashlytics API this client connects to.
30
+ # This is NOT the gem version.
31
+ VERSION = 'V1alpha'
32
+
33
+ # See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
34
+ AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
35
+
36
+ # View and administer all your Firebase data and settings
37
+ AUTH_FIREBASE = 'https://www.googleapis.com/auth/firebase'
38
+ end
39
+ end
40
+ end