google-apis-checks_v1alpha 0.3.0 → 0.5.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -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,79 +303,17 @@ module Google
234
303
  execute_or_queue_command(command, &block)
235
304
  end
236
305
 
237
- # Analyzes the privacy policy of the given policy URL or content.
238
- # @param [Google::Apis::ChecksV1alpha::AnalyzePrivacyPolicyRequest] analyze_privacy_policy_request_object
239
- # @param [String] fields
240
- # Selector specifying which fields to include in a partial response.
241
- # @param [String] quota_user
242
- # Available to use for quota purposes for server-side applications. Can be any
243
- # arbitrary string assigned to a user, but should not exceed 40 characters.
244
- # @param [Google::Apis::RequestOptions] options
245
- # Request-specific options
246
- #
247
- # @yield [result, err] Result & error if block supplied
248
- # @yieldparam result [Google::Apis::ChecksV1alpha::AnalyzePrivacyPolicyResponse] parsed result object
249
- # @yieldparam err [StandardError] error object if request failed
250
- #
251
- # @return [Google::Apis::ChecksV1alpha::AnalyzePrivacyPolicyResponse]
252
- #
253
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
254
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
255
- # @raise [Google::Apis::AuthorizationError] Authorization is required
256
- def analyze_privacypolicy_privacy_policy(analyze_privacy_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
257
- command = make_simple_command(:post, 'v1alpha/privacypolicy:analyze', options)
258
- command.request_representation = Google::Apis::ChecksV1alpha::AnalyzePrivacyPolicyRequest::Representation
259
- command.request_object = analyze_privacy_policy_request_object
260
- command.response_representation = Google::Apis::ChecksV1alpha::AnalyzePrivacyPolicyResponse::Representation
261
- command.response_class = Google::Apis::ChecksV1alpha::AnalyzePrivacyPolicyResponse
262
- command.query['fields'] = fields unless fields.nil?
263
- command.query['quotaUser'] = quota_user unless quota_user.nil?
264
- execute_or_queue_command(command, &block)
265
- end
266
-
267
- # Starts asynchronous cancellation on a long-running operation. The server makes
268
- # a best effort to cancel the operation, but success is not guaranteed. If the
269
- # server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
270
- # Clients can use Operations.GetOperation or other methods to check whether the
271
- # cancellation succeeded or whether the operation completed despite cancellation.
272
- # On successful cancellation, the operation is not deleted; instead, it becomes
273
- # an operation with an Operation.error value with a google.rpc.Status.code of 1,
274
- # corresponding to `Code.CANCELLED`.
275
- # @param [String] name
276
- # The name of the operation resource to be cancelled.
277
- # @param [String] fields
278
- # Selector specifying which fields to include in a partial response.
279
- # @param [String] quota_user
280
- # Available to use for quota purposes for server-side applications. Can be any
281
- # arbitrary string assigned to a user, but should not exceed 40 characters.
282
- # @param [Google::Apis::RequestOptions] options
283
- # Request-specific options
284
- #
285
- # @yield [result, err] Result & error if block supplied
286
- # @yieldparam result [Google::Apis::ChecksV1alpha::Empty] parsed result object
287
- # @yieldparam err [StandardError] error object if request failed
288
- #
289
- # @return [Google::Apis::ChecksV1alpha::Empty]
290
- #
291
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
292
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
293
- # @raise [Google::Apis::AuthorizationError] Authorization is required
294
- def cancel_project_privacypolicy_operation(name, fields: nil, quota_user: nil, options: nil, &block)
295
- command = make_simple_command(:post, 'v1alpha/{+name}:cancel', options)
296
- command.response_representation = Google::Apis::ChecksV1alpha::Empty::Representation
297
- command.response_class = Google::Apis::ChecksV1alpha::Empty
298
- command.params['name'] = name unless name.nil?
299
- command.query['fields'] = fields unless fields.nil?
300
- command.query['quotaUser'] = quota_user unless quota_user.nil?
301
- execute_or_queue_command(command, &block)
302
- end
303
-
304
- # Deletes a long-running operation. This method indicates that the client is no
305
- # longer interested in the operation result. It does not cancel the operation.
306
- # If the server doesn't support this method, it returns `google.rpc.Code.
307
- # UNIMPLEMENTED`.
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.
308
310
  # @param [String] name
309
- # The name of the operation resource to be deleted.
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`
310
317
  # @param [String] fields
311
318
  # Selector specifying which fields to include in a partial response.
312
319
  # @param [String] quota_user
@@ -316,65 +323,46 @@ module Google
316
323
  # Request-specific options
317
324
  #
318
325
  # @yield [result, err] Result & error if block supplied
319
- # @yieldparam result [Google::Apis::ChecksV1alpha::Empty] parsed result object
326
+ # @yieldparam result [Google::Apis::ChecksV1alpha::GoogleChecksReportV1alphaReport] parsed result object
320
327
  # @yieldparam err [StandardError] error object if request failed
321
328
  #
322
- # @return [Google::Apis::ChecksV1alpha::Empty]
329
+ # @return [Google::Apis::ChecksV1alpha::GoogleChecksReportV1alphaReport]
323
330
  #
324
331
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
325
332
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
326
333
  # @raise [Google::Apis::AuthorizationError] Authorization is required
327
- def delete_project_privacypolicy_operation(name, fields: nil, quota_user: nil, options: nil, &block)
328
- command = make_simple_command(:delete, 'v1alpha/{+name}', options)
329
- command.response_representation = Google::Apis::ChecksV1alpha::Empty::Representation
330
- command.response_class = Google::Apis::ChecksV1alpha::Empty
331
- command.params['name'] = name unless name.nil?
332
- command.query['fields'] = fields unless fields.nil?
333
- command.query['quotaUser'] = quota_user unless quota_user.nil?
334
- execute_or_queue_command(command, &block)
335
- end
336
-
337
- # Gets the latest state of a long-running operation. Clients can use this method
338
- # to poll the operation result at intervals as recommended by the API service.
339
- # @param [String] name
340
- # The name of the operation resource.
341
- # @param [String] fields
342
- # Selector specifying which fields to include in a partial response.
343
- # @param [String] quota_user
344
- # Available to use for quota purposes for server-side applications. Can be any
345
- # arbitrary string assigned to a user, but should not exceed 40 characters.
346
- # @param [Google::Apis::RequestOptions] options
347
- # Request-specific options
348
- #
349
- # @yield [result, err] Result & error if block supplied
350
- # @yieldparam result [Google::Apis::ChecksV1alpha::Operation] parsed result object
351
- # @yieldparam err [StandardError] error object if request failed
352
- #
353
- # @return [Google::Apis::ChecksV1alpha::Operation]
354
- #
355
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
356
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
357
- # @raise [Google::Apis::AuthorizationError] Authorization is required
358
- def get_project_privacypolicy_operation(name, fields: nil, quota_user: nil, options: nil, &block)
334
+ def get_account_app_report(name, checks_filter: nil, fields: nil, quota_user: nil, options: nil, &block)
359
335
  command = make_simple_command(:get, 'v1alpha/{+name}', options)
360
- command.response_representation = Google::Apis::ChecksV1alpha::Operation::Representation
361
- command.response_class = Google::Apis::ChecksV1alpha::Operation
336
+ command.response_representation = Google::Apis::ChecksV1alpha::GoogleChecksReportV1alphaReport::Representation
337
+ command.response_class = Google::Apis::ChecksV1alpha::GoogleChecksReportV1alphaReport
362
338
  command.params['name'] = name unless name.nil?
339
+ command.query['checksFilter'] = checks_filter unless checks_filter.nil?
363
340
  command.query['fields'] = fields unless fields.nil?
364
341
  command.query['quotaUser'] = quota_user unless quota_user.nil?
365
342
  execute_or_queue_command(command, &block)
366
343
  end
367
344
 
368
- # Lists operations that match the specified filter in the request. If the server
369
- # doesn't support this method, it returns `UNIMPLEMENTED`.
370
- # @param [String] name
371
- # The name of the operation's parent resource.
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`
372
355
  # @param [String] filter
373
- # The standard list filter.
356
+ # Optional. An [AIP-160](https://google.aip.dev/160) filter string to filter
357
+ # reports. Example: `appBundle.releaseType = PRE_RELEASE`
374
358
  # @param [Fixnum] page_size
375
- # The standard list 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.
376
362
  # @param [String] page_token
377
- # The standard list 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.
378
366
  # @param [String] fields
379
367
  # Selector specifying which fields to include in a partial response.
380
368
  # @param [String] quota_user
@@ -384,19 +372,20 @@ module Google
384
372
  # Request-specific options
385
373
  #
386
374
  # @yield [result, err] Result & error if block supplied
387
- # @yieldparam result [Google::Apis::ChecksV1alpha::ListOperationsResponse] parsed result object
375
+ # @yieldparam result [Google::Apis::ChecksV1alpha::GoogleChecksReportV1alphaListReportsResponse] parsed result object
388
376
  # @yieldparam err [StandardError] error object if request failed
389
377
  #
390
- # @return [Google::Apis::ChecksV1alpha::ListOperationsResponse]
378
+ # @return [Google::Apis::ChecksV1alpha::GoogleChecksReportV1alphaListReportsResponse]
391
379
  #
392
380
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
393
381
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
394
382
  # @raise [Google::Apis::AuthorizationError] Authorization is required
395
- def list_project_privacypolicy_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
396
- command = make_simple_command(:get, 'v1alpha/{+name}/privacypolicy/operations', options)
397
- command.response_representation = Google::Apis::ChecksV1alpha::ListOperationsResponse::Representation
398
- command.response_class = Google::Apis::ChecksV1alpha::ListOperationsResponse
399
- command.params['name'] = name unless name.nil?
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?
400
389
  command.query['filter'] = filter unless filter.nil?
401
390
  command.query['pageSize'] = page_size unless page_size.nil?
402
391
  command.query['pageToken'] = page_token unless page_token.nil?
@@ -405,25 +394,32 @@ module Google
405
394
  execute_or_queue_command(command, &block)
406
395
  end
407
396
 
408
- # Waits until the specified long-running operation is done or reaches at most a
409
- # specified timeout, returning the latest state. If the operation is already
410
- # done, the latest state is immediately returned. If the timeout specified is
411
- # greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If
412
- # the server does not support this method, it returns `google.rpc.Code.
413
- # UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return
414
- # the latest state before the specified timeout (including immediately), meaning
415
- # even an immediate response is no guarantee that the operation is done.
416
- # @param [String] name
417
- # The name of the operation resource to wait on.
418
- # @param [String] timeout
419
- # The maximum duration to wait before timing out. If left blank, the wait will
420
- # be at most the time permitted by the underlying HTTP/RPC protocol. If RPC
421
- # context deadline is also specified, the shorter one will be used.
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
422
414
  # @param [String] fields
423
415
  # Selector specifying which fields to include in a partial response.
424
416
  # @param [String] quota_user
425
417
  # Available to use for quota purposes for server-side applications. Can be any
426
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.
427
423
  # @param [Google::Apis::RequestOptions] options
428
424
  # Request-specific options
429
425
  #
@@ -436,12 +432,19 @@ module Google
436
432
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
437
433
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
438
434
  # @raise [Google::Apis::AuthorizationError] Authorization is required
439
- def wait_project_privacypolicy_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
440
- command = make_simple_command(:post, 'v1alpha/{+name}:wait', options)
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
441
445
  command.response_representation = Google::Apis::ChecksV1alpha::Operation::Representation
442
446
  command.response_class = Google::Apis::ChecksV1alpha::Operation
443
- command.params['name'] = name unless name.nil?
444
- command.query['timeout'] = timeout unless timeout.nil?
447
+ command.params['parent'] = parent unless parent.nil?
445
448
  command.query['fields'] = fields unless fields.nil?
446
449
  command.query['quotaUser'] = quota_user unless quota_user.nil?
447
450
  execute_or_queue_command(command, &block)
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.3.0
4
+ version: 0.5.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-08-06 00:00:00.000000000 Z
11
+ date: 2023-09-10 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.3.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-checks_v1alpha/v0.5.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.2
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