google-apis-checks_v1alpha 0.2.0 → 0.4.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +8 -0
- data/lib/google/apis/checks_v1alpha/classes.rb +1101 -69
- data/lib/google/apis/checks_v1alpha/gem_version.rb +2 -2
- data/lib/google/apis/checks_v1alpha/representations.rb +633 -17
- data/lib/google/apis/checks_v1alpha/service.rb +187 -30
- data/lib/google/apis/checks_v1alpha.rb +0 -3
- metadata +4 -4
@@ -50,6 +50,75 @@ module Google
|
|
50
50
|
@batch_path = 'batch'
|
51
51
|
end
|
52
52
|
|
53
|
+
# Gets an app.
|
54
|
+
# @param [String] name
|
55
|
+
# Required. Resource name of the app. Example: `accounts/123/apps/456`
|
56
|
+
# @param [String] fields
|
57
|
+
# Selector specifying which fields to include in a partial response.
|
58
|
+
# @param [String] quota_user
|
59
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
60
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
61
|
+
# @param [Google::Apis::RequestOptions] options
|
62
|
+
# Request-specific options
|
63
|
+
#
|
64
|
+
# @yield [result, err] Result & error if block supplied
|
65
|
+
# @yieldparam result [Google::Apis::ChecksV1alpha::GoogleChecksAccountV1alphaApp] parsed result object
|
66
|
+
# @yieldparam err [StandardError] error object if request failed
|
67
|
+
#
|
68
|
+
# @return [Google::Apis::ChecksV1alpha::GoogleChecksAccountV1alphaApp]
|
69
|
+
#
|
70
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
71
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
72
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
73
|
+
def get_account_app(name, fields: nil, quota_user: nil, options: nil, &block)
|
74
|
+
command = make_simple_command(:get, 'v1alpha/{+name}', options)
|
75
|
+
command.response_representation = Google::Apis::ChecksV1alpha::GoogleChecksAccountV1alphaApp::Representation
|
76
|
+
command.response_class = Google::Apis::ChecksV1alpha::GoogleChecksAccountV1alphaApp
|
77
|
+
command.params['name'] = name unless name.nil?
|
78
|
+
command.query['fields'] = fields unless fields.nil?
|
79
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
80
|
+
execute_or_queue_command(command, &block)
|
81
|
+
end
|
82
|
+
|
83
|
+
# Lists the apps under the given account.
|
84
|
+
# @param [String] parent
|
85
|
+
# Required. The parent account. Example: `accounts/123`
|
86
|
+
# @param [Fixnum] page_size
|
87
|
+
# Optional. The maximum number of results to return. The server may further
|
88
|
+
# constrain the maximum number of results returned in a single page. If
|
89
|
+
# unspecified, the server will decide the number of results to be returned.
|
90
|
+
# @param [String] page_token
|
91
|
+
# Optional. A page token received from a previous `ListApps` call. Provide this
|
92
|
+
# to retrieve the subsequent page.
|
93
|
+
# @param [String] fields
|
94
|
+
# Selector specifying which fields to include in a partial response.
|
95
|
+
# @param [String] quota_user
|
96
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
97
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
98
|
+
# @param [Google::Apis::RequestOptions] options
|
99
|
+
# Request-specific options
|
100
|
+
#
|
101
|
+
# @yield [result, err] Result & error if block supplied
|
102
|
+
# @yieldparam result [Google::Apis::ChecksV1alpha::GoogleChecksAccountV1alphaListAppsResponse] parsed result object
|
103
|
+
# @yieldparam err [StandardError] error object if request failed
|
104
|
+
#
|
105
|
+
# @return [Google::Apis::ChecksV1alpha::GoogleChecksAccountV1alphaListAppsResponse]
|
106
|
+
#
|
107
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
108
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
109
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
110
|
+
def list_account_apps(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
111
|
+
command = make_simple_command(:get, 'v1alpha/{+parent}/apps', options)
|
112
|
+
command.response_representation = Google::Apis::ChecksV1alpha::GoogleChecksAccountV1alphaListAppsResponse::Representation
|
113
|
+
command.response_class = Google::Apis::ChecksV1alpha::GoogleChecksAccountV1alphaListAppsResponse
|
114
|
+
command.params['parent'] = parent unless parent.nil?
|
115
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
116
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
117
|
+
command.query['fields'] = fields unless fields.nil?
|
118
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
119
|
+
execute_or_queue_command(command, &block)
|
120
|
+
end
|
121
|
+
|
53
122
|
# Starts asynchronous cancellation on a long-running operation. The server makes
|
54
123
|
# a best effort to cancel the operation, but success is not guaranteed. If the
|
55
124
|
# server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
|
@@ -234,8 +303,17 @@ module Google
|
|
234
303
|
execute_or_queue_command(command, &block)
|
235
304
|
end
|
236
305
|
|
237
|
-
#
|
238
|
-
#
|
306
|
+
# Gets a report. By default, only the name and results_uri fields are returned.
|
307
|
+
# You can include other fields by listing them in the `fields` URL query
|
308
|
+
# parameter. For example, `?fields=name,checks` will return the name and checks
|
309
|
+
# fields.
|
310
|
+
# @param [String] name
|
311
|
+
# Required. Resource name of the report. Example: `accounts/123/apps/456/reports/
|
312
|
+
# 789`
|
313
|
+
# @param [String] checks_filter
|
314
|
+
# Optional. An [AIP-160](https://google.aip.dev/160) filter string to filter
|
315
|
+
# checks within the report. Only checks that match the filter string are
|
316
|
+
# included in the response. Example: `state = FAILED`
|
239
317
|
# @param [String] fields
|
240
318
|
# Selector specifying which fields to include in a partial response.
|
241
319
|
# @param [String] quota_user
|
@@ -245,28 +323,46 @@ module Google
|
|
245
323
|
# Request-specific options
|
246
324
|
#
|
247
325
|
# @yield [result, err] Result & error if block supplied
|
248
|
-
# @yieldparam result [Google::Apis::ChecksV1alpha::
|
326
|
+
# @yieldparam result [Google::Apis::ChecksV1alpha::GoogleChecksReportV1alphaReport] parsed result object
|
249
327
|
# @yieldparam err [StandardError] error object if request failed
|
250
328
|
#
|
251
|
-
# @return [Google::Apis::ChecksV1alpha::
|
329
|
+
# @return [Google::Apis::ChecksV1alpha::GoogleChecksReportV1alphaReport]
|
252
330
|
#
|
253
331
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
254
332
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
255
333
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
256
|
-
def
|
257
|
-
command = make_simple_command(:
|
258
|
-
command.
|
259
|
-
command.
|
260
|
-
command.
|
261
|
-
command.
|
334
|
+
def get_account_app_report(name, checks_filter: nil, fields: nil, quota_user: nil, options: nil, &block)
|
335
|
+
command = make_simple_command(:get, 'v1alpha/{+name}', options)
|
336
|
+
command.response_representation = Google::Apis::ChecksV1alpha::GoogleChecksReportV1alphaReport::Representation
|
337
|
+
command.response_class = Google::Apis::ChecksV1alpha::GoogleChecksReportV1alphaReport
|
338
|
+
command.params['name'] = name unless name.nil?
|
339
|
+
command.query['checksFilter'] = checks_filter unless checks_filter.nil?
|
262
340
|
command.query['fields'] = fields unless fields.nil?
|
263
341
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
264
342
|
execute_or_queue_command(command, &block)
|
265
343
|
end
|
266
344
|
|
267
|
-
#
|
268
|
-
#
|
269
|
-
#
|
345
|
+
# Lists reports for the specified app. By default, only the name and results_uri
|
346
|
+
# fields are returned. You can include other fields by listing them in the `
|
347
|
+
# fields` URL query parameter. For example, `?fields=reports(name,checks)` will
|
348
|
+
# return the name and checks fields.
|
349
|
+
# @param [String] parent
|
350
|
+
# Required. Resource name of the app. Example: `accounts/123/apps/456`
|
351
|
+
# @param [String] checks_filter
|
352
|
+
# Optional. An [AIP-160](https://google.aip.dev/160) filter string to filter
|
353
|
+
# checks within reports. Only checks that match the filter string are included
|
354
|
+
# in the response. Example: `state = FAILED`
|
355
|
+
# @param [String] filter
|
356
|
+
# Optional. An [AIP-160](https://google.aip.dev/160) filter string to filter
|
357
|
+
# reports. Example: `appBundle.releaseType = PRE_RELEASE`
|
358
|
+
# @param [Fixnum] page_size
|
359
|
+
# Optional. The maximum number of reports to return. If unspecified, at most 10
|
360
|
+
# reports will be returned. The maximum value is 50; values above 50 will be
|
361
|
+
# coerced to 50.
|
362
|
+
# @param [String] page_token
|
363
|
+
# Optional. A page token received from a previous `ListReports` call. Provide
|
364
|
+
# this to retrieve the subsequent page. When paginating, all other parameters
|
365
|
+
# provided to `ListReports` must match the call that provided the page token.
|
270
366
|
# @param [String] fields
|
271
367
|
# Selector specifying which fields to include in a partial response.
|
272
368
|
# @param [String] quota_user
|
@@ -276,49 +372,110 @@ module Google
|
|
276
372
|
# Request-specific options
|
277
373
|
#
|
278
374
|
# @yield [result, err] Result & error if block supplied
|
279
|
-
# @yieldparam result [Google::Apis::ChecksV1alpha::
|
375
|
+
# @yieldparam result [Google::Apis::ChecksV1alpha::GoogleChecksReportV1alphaListReportsResponse] parsed result object
|
280
376
|
# @yieldparam err [StandardError] error object if request failed
|
281
377
|
#
|
282
|
-
# @return [Google::Apis::ChecksV1alpha::
|
378
|
+
# @return [Google::Apis::ChecksV1alpha::GoogleChecksReportV1alphaListReportsResponse]
|
283
379
|
#
|
284
380
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
285
381
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
286
382
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
287
|
-
def
|
288
|
-
command = make_simple_command(:
|
289
|
-
command.response_representation = Google::Apis::ChecksV1alpha::
|
290
|
-
command.response_class = Google::Apis::ChecksV1alpha::
|
291
|
-
command.params['
|
383
|
+
def list_account_app_reports(parent, checks_filter: nil, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
384
|
+
command = make_simple_command(:get, 'v1alpha/{+parent}/reports', options)
|
385
|
+
command.response_representation = Google::Apis::ChecksV1alpha::GoogleChecksReportV1alphaListReportsResponse::Representation
|
386
|
+
command.response_class = Google::Apis::ChecksV1alpha::GoogleChecksReportV1alphaListReportsResponse
|
387
|
+
command.params['parent'] = parent unless parent.nil?
|
388
|
+
command.query['checksFilter'] = checks_filter unless checks_filter.nil?
|
389
|
+
command.query['filter'] = filter unless filter.nil?
|
390
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
391
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
292
392
|
command.query['fields'] = fields unless fields.nil?
|
293
393
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
294
394
|
execute_or_queue_command(command, &block)
|
295
395
|
end
|
296
396
|
|
297
|
-
#
|
298
|
-
#
|
299
|
-
#
|
397
|
+
# Analyzes the uploaded app bundle and returns a google.longrunning.Operation
|
398
|
+
# containing the generated Report. ## Example (upload only) Send a regular POST
|
399
|
+
# request with the header `X-Goog-Upload-Protocol: raw`. ``` POST https://checks.
|
400
|
+
# googleapis.com/upload/v1alpha/`parent=accounts/*/apps/*`/reports:analyzeUpload
|
401
|
+
# HTTP/1.1 X-Goog-Upload-Protocol: raw Content-Length: Content-Type: application/
|
402
|
+
# octet-stream ``` ## Example (upload with metadata) Send a multipart POST
|
403
|
+
# request where the first body part contains the metadata JSON and the second
|
404
|
+
# body part contains the binary upload. Include the header `X-Goog-Upload-
|
405
|
+
# Protocol: multipart`. ``` POST https://checks.googleapis.com/upload/v1alpha/`
|
406
|
+
# parent=accounts/*/apps/*`/reports:analyzeUpload HTTP/1.1 X-Goog-Upload-
|
407
|
+
# Protocol: multipart Content-Length: ? Content-Type: multipart/related;
|
408
|
+
# boundary=BOUNDARY --BOUNDARY Content-Type: application/json `"
|
409
|
+
# code_reference_id":"db5bcc20f94055fb5bc08cbb9b0e7a5530308786"` --BOUNDARY --
|
410
|
+
# BOUNDARY-- ``` *Note:* Metadata-only requests are not supported.
|
411
|
+
# @param [String] parent
|
412
|
+
# Required. Resource name of the app. Example: `accounts/123/apps/456`
|
413
|
+
# @param [Google::Apis::ChecksV1alpha::GoogleChecksReportV1alphaAnalyzeUploadRequest] google_checks_report_v1alpha_analyze_upload_request_object
|
300
414
|
# @param [String] fields
|
301
415
|
# Selector specifying which fields to include in a partial response.
|
302
416
|
# @param [String] quota_user
|
303
417
|
# Available to use for quota purposes for server-side applications. Can be any
|
304
418
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
419
|
+
# @param [IO, String] upload_source
|
420
|
+
# IO stream or filename containing content to upload
|
421
|
+
# @param [String] content_type
|
422
|
+
# Content type of the uploaded content.
|
305
423
|
# @param [Google::Apis::RequestOptions] options
|
306
424
|
# Request-specific options
|
307
425
|
#
|
308
426
|
# @yield [result, err] Result & error if block supplied
|
309
|
-
# @yieldparam result [Google::Apis::ChecksV1alpha::
|
427
|
+
# @yieldparam result [Google::Apis::ChecksV1alpha::Operation] parsed result object
|
310
428
|
# @yieldparam err [StandardError] error object if request failed
|
311
429
|
#
|
312
|
-
# @return [Google::Apis::ChecksV1alpha::
|
430
|
+
# @return [Google::Apis::ChecksV1alpha::Operation]
|
313
431
|
#
|
314
432
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
315
433
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
316
434
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
317
|
-
def
|
318
|
-
|
319
|
-
|
320
|
-
|
321
|
-
|
435
|
+
def upload_medium(parent, google_checks_report_v1alpha_analyze_upload_request_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
|
436
|
+
if upload_source.nil?
|
437
|
+
command = make_simple_command(:post, 'v1alpha/{+parent}/reports:analyzeUpload', options)
|
438
|
+
else
|
439
|
+
command = make_upload_command(:post, 'v1alpha/{+parent}/reports:analyzeUpload', options)
|
440
|
+
command.upload_source = upload_source
|
441
|
+
command.upload_content_type = content_type
|
442
|
+
end
|
443
|
+
command.request_representation = Google::Apis::ChecksV1alpha::GoogleChecksReportV1alphaAnalyzeUploadRequest::Representation
|
444
|
+
command.request_object = google_checks_report_v1alpha_analyze_upload_request_object
|
445
|
+
command.response_representation = Google::Apis::ChecksV1alpha::Operation::Representation
|
446
|
+
command.response_class = Google::Apis::ChecksV1alpha::Operation
|
447
|
+
command.params['parent'] = parent unless parent.nil?
|
448
|
+
command.query['fields'] = fields unless fields.nil?
|
449
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
450
|
+
execute_or_queue_command(command, &block)
|
451
|
+
end
|
452
|
+
|
453
|
+
# Performs a synchronous analysis of a privacy policy, where the policy content
|
454
|
+
# is mapped to privacy categories, data types, and purposes.
|
455
|
+
# @param [Google::Apis::ChecksV1alpha::AnalyzePrivacyPolicyRequest] analyze_privacy_policy_request_object
|
456
|
+
# @param [String] fields
|
457
|
+
# Selector specifying which fields to include in a partial response.
|
458
|
+
# @param [String] quota_user
|
459
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
460
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
461
|
+
# @param [Google::Apis::RequestOptions] options
|
462
|
+
# Request-specific options
|
463
|
+
#
|
464
|
+
# @yield [result, err] Result & error if block supplied
|
465
|
+
# @yieldparam result [Google::Apis::ChecksV1alpha::AnalyzePrivacyPolicyResponse] parsed result object
|
466
|
+
# @yieldparam err [StandardError] error object if request failed
|
467
|
+
#
|
468
|
+
# @return [Google::Apis::ChecksV1alpha::AnalyzePrivacyPolicyResponse]
|
469
|
+
#
|
470
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
471
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
472
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
473
|
+
def analyze_privacypolicy_privacy_policy(analyze_privacy_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
474
|
+
command = make_simple_command(:post, 'v1alpha/privacypolicy:analyze', options)
|
475
|
+
command.request_representation = Google::Apis::ChecksV1alpha::AnalyzePrivacyPolicyRequest::Representation
|
476
|
+
command.request_object = analyze_privacy_policy_request_object
|
477
|
+
command.response_representation = Google::Apis::ChecksV1alpha::AnalyzePrivacyPolicyResponse::Representation
|
478
|
+
command.response_class = Google::Apis::ChecksV1alpha::AnalyzePrivacyPolicyResponse
|
322
479
|
command.query['fields'] = fields unless fields.nil?
|
323
480
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
324
481
|
execute_or_queue_command(command, &block)
|
@@ -29,9 +29,6 @@ module Google
|
|
29
29
|
# Version of the Checks API this client connects to.
|
30
30
|
# This is NOT the gem version.
|
31
31
|
VERSION = 'V1alpha'
|
32
|
-
|
33
|
-
# Test scope for access to the Zoo service
|
34
|
-
AUTH_XAPI_ZOO = 'https://www.googleapis.com/auth/xapi.zoo'
|
35
32
|
end
|
36
33
|
end
|
37
34
|
end
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-apis-checks_v1alpha
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.4.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2023-
|
11
|
+
date: 2023-09-03 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: google-apis-core
|
@@ -58,7 +58,7 @@ licenses:
|
|
58
58
|
metadata:
|
59
59
|
bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
|
60
60
|
changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-checks_v1alpha/CHANGELOG.md
|
61
|
-
documentation_uri: https://googleapis.dev/ruby/google-apis-checks_v1alpha/v0.
|
61
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-checks_v1alpha/v0.4.0
|
62
62
|
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-checks_v1alpha
|
63
63
|
post_install_message:
|
64
64
|
rdoc_options: []
|
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
75
75
|
- !ruby/object:Gem::Version
|
76
76
|
version: '0'
|
77
77
|
requirements: []
|
78
|
-
rubygems_version: 3.4.
|
78
|
+
rubygems_version: 3.4.19
|
79
79
|
signing_key:
|
80
80
|
specification_version: 4
|
81
81
|
summary: Simple REST client for Checks API V1alpha
|