google-apis-notebooks_v1 0.1.0 → 0.6.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.
@@ -83,11 +83,15 @@ module Google
83
83
  # @param [String] name
84
84
  # The resource that owns the locations collection, if applicable.
85
85
  # @param [String] filter
86
- # The standard list filter.
86
+ # A filter to narrow down results to a preferred subset. The filtering language
87
+ # accepts strings like "displayName=tokyo", and is documented in more detail in [
88
+ # AIP-160](https://google.aip.dev/160).
87
89
  # @param [Fixnum] page_size
88
- # The standard list page size.
90
+ # The maximum number of results to return. If not set, the service will select a
91
+ # default.
89
92
  # @param [String] page_token
90
- # The standard list page token.
93
+ # A page token received from the `next_page_token` field in the response. Send
94
+ # that page token to receive the subsequent page.
91
95
  # @param [String] fields
92
96
  # Selector specifying which fields to include in a partial response.
93
97
  # @param [String] quota_user
@@ -256,6 +260,147 @@ module Google
256
260
  execute_or_queue_command(command, &block)
257
261
  end
258
262
 
263
+ # Creates a new Scheduled Notebook in a given project and location.
264
+ # @param [String] parent
265
+ # Required. Format: `parent=projects/`project_id`/locations/`location``
266
+ # @param [Google::Apis::NotebooksV1::Execution] execution_object
267
+ # @param [String] execution_id
268
+ # Required. User-defined unique ID of this execution.
269
+ # @param [String] fields
270
+ # Selector specifying which fields to include in a partial response.
271
+ # @param [String] quota_user
272
+ # Available to use for quota purposes for server-side applications. Can be any
273
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
274
+ # @param [Google::Apis::RequestOptions] options
275
+ # Request-specific options
276
+ #
277
+ # @yield [result, err] Result & error if block supplied
278
+ # @yieldparam result [Google::Apis::NotebooksV1::Operation] parsed result object
279
+ # @yieldparam err [StandardError] error object if request failed
280
+ #
281
+ # @return [Google::Apis::NotebooksV1::Operation]
282
+ #
283
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
284
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
285
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
286
+ def create_project_location_execution(parent, execution_object = nil, execution_id: nil, fields: nil, quota_user: nil, options: nil, &block)
287
+ command = make_simple_command(:post, 'v1/{+parent}/executions', options)
288
+ command.request_representation = Google::Apis::NotebooksV1::Execution::Representation
289
+ command.request_object = execution_object
290
+ command.response_representation = Google::Apis::NotebooksV1::Operation::Representation
291
+ command.response_class = Google::Apis::NotebooksV1::Operation
292
+ command.params['parent'] = parent unless parent.nil?
293
+ command.query['executionId'] = execution_id unless execution_id.nil?
294
+ command.query['fields'] = fields unless fields.nil?
295
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
296
+ execute_or_queue_command(command, &block)
297
+ end
298
+
299
+ # Deletes execution
300
+ # @param [String] name
301
+ # Required. Format: `projects/`project_id`/locations/`location`/executions/`
302
+ # execution_id``
303
+ # @param [String] fields
304
+ # Selector specifying which fields to include in a partial response.
305
+ # @param [String] quota_user
306
+ # Available to use for quota purposes for server-side applications. Can be any
307
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
308
+ # @param [Google::Apis::RequestOptions] options
309
+ # Request-specific options
310
+ #
311
+ # @yield [result, err] Result & error if block supplied
312
+ # @yieldparam result [Google::Apis::NotebooksV1::Operation] parsed result object
313
+ # @yieldparam err [StandardError] error object if request failed
314
+ #
315
+ # @return [Google::Apis::NotebooksV1::Operation]
316
+ #
317
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
318
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
319
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
320
+ def delete_project_location_execution(name, fields: nil, quota_user: nil, options: nil, &block)
321
+ command = make_simple_command(:delete, 'v1/{+name}', options)
322
+ command.response_representation = Google::Apis::NotebooksV1::Operation::Representation
323
+ command.response_class = Google::Apis::NotebooksV1::Operation
324
+ command.params['name'] = name unless name.nil?
325
+ command.query['fields'] = fields unless fields.nil?
326
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
327
+ execute_or_queue_command(command, &block)
328
+ end
329
+
330
+ # Gets details of executions
331
+ # @param [String] name
332
+ # Required. Format: `projects/`project_id`/locations/`location`/schedules/`
333
+ # execution_id``
334
+ # @param [String] fields
335
+ # Selector specifying which fields to include in a partial response.
336
+ # @param [String] quota_user
337
+ # Available to use for quota purposes for server-side applications. Can be any
338
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
339
+ # @param [Google::Apis::RequestOptions] options
340
+ # Request-specific options
341
+ #
342
+ # @yield [result, err] Result & error if block supplied
343
+ # @yieldparam result [Google::Apis::NotebooksV1::Execution] parsed result object
344
+ # @yieldparam err [StandardError] error object if request failed
345
+ #
346
+ # @return [Google::Apis::NotebooksV1::Execution]
347
+ #
348
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
349
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
350
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
351
+ def get_project_location_execution(name, fields: nil, quota_user: nil, options: nil, &block)
352
+ command = make_simple_command(:get, 'v1/{+name}', options)
353
+ command.response_representation = Google::Apis::NotebooksV1::Execution::Representation
354
+ command.response_class = Google::Apis::NotebooksV1::Execution
355
+ command.params['name'] = name unless name.nil?
356
+ command.query['fields'] = fields unless fields.nil?
357
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
358
+ execute_or_queue_command(command, &block)
359
+ end
360
+
361
+ # Lists executions in a given project and location
362
+ # @param [String] parent
363
+ # Required. Format: `parent=projects/`project_id`/locations/`location``
364
+ # @param [String] filter
365
+ # Filter applied to resulting executions.
366
+ # @param [String] order_by
367
+ # Sort by field.
368
+ # @param [Fixnum] page_size
369
+ # Maximum return size of the list call.
370
+ # @param [String] page_token
371
+ # A previous returned page token that can be used to continue listing from the
372
+ # last result.
373
+ # @param [String] fields
374
+ # Selector specifying which fields to include in a partial response.
375
+ # @param [String] quota_user
376
+ # Available to use for quota purposes for server-side applications. Can be any
377
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
378
+ # @param [Google::Apis::RequestOptions] options
379
+ # Request-specific options
380
+ #
381
+ # @yield [result, err] Result & error if block supplied
382
+ # @yieldparam result [Google::Apis::NotebooksV1::ListExecutionsResponse] parsed result object
383
+ # @yieldparam err [StandardError] error object if request failed
384
+ #
385
+ # @return [Google::Apis::NotebooksV1::ListExecutionsResponse]
386
+ #
387
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
388
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
389
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
390
+ def list_project_location_executions(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
391
+ command = make_simple_command(:get, 'v1/{+parent}/executions', options)
392
+ command.response_representation = Google::Apis::NotebooksV1::ListExecutionsResponse::Representation
393
+ command.response_class = Google::Apis::NotebooksV1::ListExecutionsResponse
394
+ command.params['parent'] = parent unless parent.nil?
395
+ command.query['filter'] = filter unless filter.nil?
396
+ command.query['orderBy'] = order_by unless order_by.nil?
397
+ command.query['pageSize'] = page_size unless page_size.nil?
398
+ command.query['pageToken'] = page_token unless page_token.nil?
399
+ command.query['fields'] = fields unless fields.nil?
400
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
401
+ execute_or_queue_command(command, &block)
402
+ end
403
+
259
404
  # Creates a new Instance in a given project and location.
260
405
  # @param [String] parent
261
406
  # Required. Format: `parent=projects/`project_id`/locations/`location``
@@ -395,6 +540,37 @@ module Google
395
540
  execute_or_queue_command(command, &block)
396
541
  end
397
542
 
543
+ # Check if a notebook instance is healthy.
544
+ # @param [String] name
545
+ # Required. Format: `projects/`project_id`/locations/`location`/instances/`
546
+ # instance_id``
547
+ # @param [String] fields
548
+ # Selector specifying which fields to include in a partial response.
549
+ # @param [String] quota_user
550
+ # Available to use for quota purposes for server-side applications. Can be any
551
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
552
+ # @param [Google::Apis::RequestOptions] options
553
+ # Request-specific options
554
+ #
555
+ # @yield [result, err] Result & error if block supplied
556
+ # @yieldparam result [Google::Apis::NotebooksV1::GetInstanceHealthResponse] parsed result object
557
+ # @yieldparam err [StandardError] error object if request failed
558
+ #
559
+ # @return [Google::Apis::NotebooksV1::GetInstanceHealthResponse]
560
+ #
561
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
562
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
563
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
564
+ def get_project_location_instance_instance_health(name, fields: nil, quota_user: nil, options: nil, &block)
565
+ command = make_simple_command(:get, 'v1/{+name}:getInstanceHealth', options)
566
+ command.response_representation = Google::Apis::NotebooksV1::GetInstanceHealthResponse::Representation
567
+ command.response_class = Google::Apis::NotebooksV1::GetInstanceHealthResponse
568
+ command.params['name'] = name unless name.nil?
569
+ command.query['fields'] = fields unless fields.nil?
570
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
571
+ execute_or_queue_command(command, &block)
572
+ end
573
+
398
574
  # Check if a notebook instance is upgradable.
399
575
  # @param [String] notebook_instance
400
576
  # Required. Format: `projects/`project_id`/locations/`location`/instances/`
@@ -813,6 +989,40 @@ module Google
813
989
  execute_or_queue_command(command, &block)
814
990
  end
815
991
 
992
+ # Updates the Shielded instance configuration of a single Instance.
993
+ # @param [String] name
994
+ # Required. Format: `projects/`project_id`/locations/`location`/instances/`
995
+ # instance_id``
996
+ # @param [Google::Apis::NotebooksV1::UpdateShieldedInstanceConfigRequest] update_shielded_instance_config_request_object
997
+ # @param [String] fields
998
+ # Selector specifying which fields to include in a partial response.
999
+ # @param [String] quota_user
1000
+ # Available to use for quota purposes for server-side applications. Can be any
1001
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1002
+ # @param [Google::Apis::RequestOptions] options
1003
+ # Request-specific options
1004
+ #
1005
+ # @yield [result, err] Result & error if block supplied
1006
+ # @yieldparam result [Google::Apis::NotebooksV1::Operation] parsed result object
1007
+ # @yieldparam err [StandardError] error object if request failed
1008
+ #
1009
+ # @return [Google::Apis::NotebooksV1::Operation]
1010
+ #
1011
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1012
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1013
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1014
+ def update_shielded_instance_config(name, update_shielded_instance_config_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1015
+ command = make_simple_command(:patch, 'v1/{+name}:updateShieldedInstanceConfig', options)
1016
+ command.request_representation = Google::Apis::NotebooksV1::UpdateShieldedInstanceConfigRequest::Representation
1017
+ command.request_object = update_shielded_instance_config_request_object
1018
+ command.response_representation = Google::Apis::NotebooksV1::Operation::Representation
1019
+ command.response_class = Google::Apis::NotebooksV1::Operation
1020
+ command.params['name'] = name unless name.nil?
1021
+ command.query['fields'] = fields unless fields.nil?
1022
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1023
+ execute_or_queue_command(command, &block)
1024
+ end
1025
+
816
1026
  # Upgrades a notebook instance to the latest version.
817
1027
  # @param [String] name
818
1028
  # Required. Format: `projects/`project_id`/locations/`location`/instances/`
@@ -1032,6 +1242,425 @@ module Google
1032
1242
  execute_or_queue_command(command, &block)
1033
1243
  end
1034
1244
 
1245
+ # Creates a new Runtime in a given project and location.
1246
+ # @param [String] parent
1247
+ # Required. Format: `parent=projects/`project_id`/locations/`location``
1248
+ # @param [Google::Apis::NotebooksV1::Runtime] runtime_object
1249
+ # @param [String] runtime_id
1250
+ # Required. User-defined unique ID of this Runtime.
1251
+ # @param [String] fields
1252
+ # Selector specifying which fields to include in a partial response.
1253
+ # @param [String] quota_user
1254
+ # Available to use for quota purposes for server-side applications. Can be any
1255
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1256
+ # @param [Google::Apis::RequestOptions] options
1257
+ # Request-specific options
1258
+ #
1259
+ # @yield [result, err] Result & error if block supplied
1260
+ # @yieldparam result [Google::Apis::NotebooksV1::Operation] parsed result object
1261
+ # @yieldparam err [StandardError] error object if request failed
1262
+ #
1263
+ # @return [Google::Apis::NotebooksV1::Operation]
1264
+ #
1265
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1266
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1267
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1268
+ def create_project_location_runtime(parent, runtime_object = nil, runtime_id: nil, fields: nil, quota_user: nil, options: nil, &block)
1269
+ command = make_simple_command(:post, 'v1/{+parent}/runtimes', options)
1270
+ command.request_representation = Google::Apis::NotebooksV1::Runtime::Representation
1271
+ command.request_object = runtime_object
1272
+ command.response_representation = Google::Apis::NotebooksV1::Operation::Representation
1273
+ command.response_class = Google::Apis::NotebooksV1::Operation
1274
+ command.params['parent'] = parent unless parent.nil?
1275
+ command.query['runtimeId'] = runtime_id unless runtime_id.nil?
1276
+ command.query['fields'] = fields unless fields.nil?
1277
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1278
+ execute_or_queue_command(command, &block)
1279
+ end
1280
+
1281
+ # Deletes a single Runtime.
1282
+ # @param [String] name
1283
+ # Required. Format: `projects/`project_id`/locations/`location`/runtimes/`
1284
+ # runtime_id``
1285
+ # @param [String] fields
1286
+ # Selector specifying which fields to include in a partial response.
1287
+ # @param [String] quota_user
1288
+ # Available to use for quota purposes for server-side applications. Can be any
1289
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1290
+ # @param [Google::Apis::RequestOptions] options
1291
+ # Request-specific options
1292
+ #
1293
+ # @yield [result, err] Result & error if block supplied
1294
+ # @yieldparam result [Google::Apis::NotebooksV1::Operation] parsed result object
1295
+ # @yieldparam err [StandardError] error object if request failed
1296
+ #
1297
+ # @return [Google::Apis::NotebooksV1::Operation]
1298
+ #
1299
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1300
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1301
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1302
+ def delete_project_location_runtime(name, fields: nil, quota_user: nil, options: nil, &block)
1303
+ command = make_simple_command(:delete, 'v1/{+name}', options)
1304
+ command.response_representation = Google::Apis::NotebooksV1::Operation::Representation
1305
+ command.response_class = Google::Apis::NotebooksV1::Operation
1306
+ command.params['name'] = name unless name.nil?
1307
+ command.query['fields'] = fields unless fields.nil?
1308
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1309
+ execute_or_queue_command(command, &block)
1310
+ end
1311
+
1312
+ # Gets details of a single Runtime. The location must be a regional endpoint
1313
+ # rather than zonal.
1314
+ # @param [String] name
1315
+ # Required. Format: `projects/`project_id`/locations/`location`/runtimes/`
1316
+ # runtime_id``
1317
+ # @param [String] fields
1318
+ # Selector specifying which fields to include in a partial response.
1319
+ # @param [String] quota_user
1320
+ # Available to use for quota purposes for server-side applications. Can be any
1321
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1322
+ # @param [Google::Apis::RequestOptions] options
1323
+ # Request-specific options
1324
+ #
1325
+ # @yield [result, err] Result & error if block supplied
1326
+ # @yieldparam result [Google::Apis::NotebooksV1::Runtime] parsed result object
1327
+ # @yieldparam err [StandardError] error object if request failed
1328
+ #
1329
+ # @return [Google::Apis::NotebooksV1::Runtime]
1330
+ #
1331
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1332
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1333
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1334
+ def get_project_location_runtime(name, fields: nil, quota_user: nil, options: nil, &block)
1335
+ command = make_simple_command(:get, 'v1/{+name}', options)
1336
+ command.response_representation = Google::Apis::NotebooksV1::Runtime::Representation
1337
+ command.response_class = Google::Apis::NotebooksV1::Runtime
1338
+ command.params['name'] = name unless name.nil?
1339
+ command.query['fields'] = fields unless fields.nil?
1340
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1341
+ execute_or_queue_command(command, &block)
1342
+ end
1343
+
1344
+ # Lists Runtimes in a given project and location.
1345
+ # @param [String] parent
1346
+ # Required. Format: `parent=projects/`project_id`/locations/`location``
1347
+ # @param [Fixnum] page_size
1348
+ # Maximum return size of the list call.
1349
+ # @param [String] page_token
1350
+ # A previous returned page token that can be used to continue listing from the
1351
+ # last result.
1352
+ # @param [String] fields
1353
+ # Selector specifying which fields to include in a partial response.
1354
+ # @param [String] quota_user
1355
+ # Available to use for quota purposes for server-side applications. Can be any
1356
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1357
+ # @param [Google::Apis::RequestOptions] options
1358
+ # Request-specific options
1359
+ #
1360
+ # @yield [result, err] Result & error if block supplied
1361
+ # @yieldparam result [Google::Apis::NotebooksV1::ListRuntimesResponse] parsed result object
1362
+ # @yieldparam err [StandardError] error object if request failed
1363
+ #
1364
+ # @return [Google::Apis::NotebooksV1::ListRuntimesResponse]
1365
+ #
1366
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1367
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1368
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1369
+ def list_project_location_runtimes(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1370
+ command = make_simple_command(:get, 'v1/{+parent}/runtimes', options)
1371
+ command.response_representation = Google::Apis::NotebooksV1::ListRuntimesResponse::Representation
1372
+ command.response_class = Google::Apis::NotebooksV1::ListRuntimesResponse
1373
+ command.params['parent'] = parent unless parent.nil?
1374
+ command.query['pageSize'] = page_size unless page_size.nil?
1375
+ command.query['pageToken'] = page_token unless page_token.nil?
1376
+ command.query['fields'] = fields unless fields.nil?
1377
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1378
+ execute_or_queue_command(command, &block)
1379
+ end
1380
+
1381
+ # Resets a Managed Notebook Runtime.
1382
+ # @param [String] name
1383
+ # Required. Format: `projects/`project_id`/locations/`location`/runtimes/`
1384
+ # runtime_id``
1385
+ # @param [Google::Apis::NotebooksV1::ResetRuntimeRequest] reset_runtime_request_object
1386
+ # @param [String] fields
1387
+ # Selector specifying which fields to include in a partial response.
1388
+ # @param [String] quota_user
1389
+ # Available to use for quota purposes for server-side applications. Can be any
1390
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1391
+ # @param [Google::Apis::RequestOptions] options
1392
+ # Request-specific options
1393
+ #
1394
+ # @yield [result, err] Result & error if block supplied
1395
+ # @yieldparam result [Google::Apis::NotebooksV1::Operation] parsed result object
1396
+ # @yieldparam err [StandardError] error object if request failed
1397
+ #
1398
+ # @return [Google::Apis::NotebooksV1::Operation]
1399
+ #
1400
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1401
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1402
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1403
+ def reset_runtime(name, reset_runtime_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1404
+ command = make_simple_command(:post, 'v1/{+name}:reset', options)
1405
+ command.request_representation = Google::Apis::NotebooksV1::ResetRuntimeRequest::Representation
1406
+ command.request_object = reset_runtime_request_object
1407
+ command.response_representation = Google::Apis::NotebooksV1::Operation::Representation
1408
+ command.response_class = Google::Apis::NotebooksV1::Operation
1409
+ command.params['name'] = name unless name.nil?
1410
+ command.query['fields'] = fields unless fields.nil?
1411
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1412
+ execute_or_queue_command(command, &block)
1413
+ end
1414
+
1415
+ # Starts a Managed Notebook Runtime. Perform "Start" on GPU instances; "Resume"
1416
+ # on CPU instances See: https://cloud.google.com/compute/docs/instances/stop-
1417
+ # start-instance https://cloud.google.com/compute/docs/instances/suspend-resume-
1418
+ # instance
1419
+ # @param [String] name
1420
+ # Required. Format: `projects/`project_id`/locations/`location`/runtimes/`
1421
+ # runtime_id``
1422
+ # @param [Google::Apis::NotebooksV1::StartRuntimeRequest] start_runtime_request_object
1423
+ # @param [String] fields
1424
+ # Selector specifying which fields to include in a partial response.
1425
+ # @param [String] quota_user
1426
+ # Available to use for quota purposes for server-side applications. Can be any
1427
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1428
+ # @param [Google::Apis::RequestOptions] options
1429
+ # Request-specific options
1430
+ #
1431
+ # @yield [result, err] Result & error if block supplied
1432
+ # @yieldparam result [Google::Apis::NotebooksV1::Operation] parsed result object
1433
+ # @yieldparam err [StandardError] error object if request failed
1434
+ #
1435
+ # @return [Google::Apis::NotebooksV1::Operation]
1436
+ #
1437
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1438
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1439
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1440
+ def start_runtime(name, start_runtime_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1441
+ command = make_simple_command(:post, 'v1/{+name}:start', options)
1442
+ command.request_representation = Google::Apis::NotebooksV1::StartRuntimeRequest::Representation
1443
+ command.request_object = start_runtime_request_object
1444
+ command.response_representation = Google::Apis::NotebooksV1::Operation::Representation
1445
+ command.response_class = Google::Apis::NotebooksV1::Operation
1446
+ command.params['name'] = name unless name.nil?
1447
+ command.query['fields'] = fields unless fields.nil?
1448
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1449
+ execute_or_queue_command(command, &block)
1450
+ end
1451
+
1452
+ # Stops a Managed Notebook Runtime. Perform "Stop" on GPU instances; "Suspend"
1453
+ # on CPU instances See: https://cloud.google.com/compute/docs/instances/stop-
1454
+ # start-instance https://cloud.google.com/compute/docs/instances/suspend-resume-
1455
+ # instance
1456
+ # @param [String] name
1457
+ # Required. Format: `projects/`project_id`/locations/`location`/runtimes/`
1458
+ # runtime_id``
1459
+ # @param [Google::Apis::NotebooksV1::StopRuntimeRequest] stop_runtime_request_object
1460
+ # @param [String] fields
1461
+ # Selector specifying which fields to include in a partial response.
1462
+ # @param [String] quota_user
1463
+ # Available to use for quota purposes for server-side applications. Can be any
1464
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1465
+ # @param [Google::Apis::RequestOptions] options
1466
+ # Request-specific options
1467
+ #
1468
+ # @yield [result, err] Result & error if block supplied
1469
+ # @yieldparam result [Google::Apis::NotebooksV1::Operation] parsed result object
1470
+ # @yieldparam err [StandardError] error object if request failed
1471
+ #
1472
+ # @return [Google::Apis::NotebooksV1::Operation]
1473
+ #
1474
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1475
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1476
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1477
+ def stop_runtime(name, stop_runtime_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1478
+ command = make_simple_command(:post, 'v1/{+name}:stop', options)
1479
+ command.request_representation = Google::Apis::NotebooksV1::StopRuntimeRequest::Representation
1480
+ command.request_object = stop_runtime_request_object
1481
+ command.response_representation = Google::Apis::NotebooksV1::Operation::Representation
1482
+ command.response_class = Google::Apis::NotebooksV1::Operation
1483
+ command.params['name'] = name unless name.nil?
1484
+ command.query['fields'] = fields unless fields.nil?
1485
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1486
+ execute_or_queue_command(command, &block)
1487
+ end
1488
+
1489
+ # Switch a Managed Notebook Runtime.
1490
+ # @param [String] name
1491
+ # Required. Format: `projects/`project_id`/locations/`location`/runtimes/`
1492
+ # runtime_id``
1493
+ # @param [Google::Apis::NotebooksV1::SwitchRuntimeRequest] switch_runtime_request_object
1494
+ # @param [String] fields
1495
+ # Selector specifying which fields to include in a partial response.
1496
+ # @param [String] quota_user
1497
+ # Available to use for quota purposes for server-side applications. Can be any
1498
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1499
+ # @param [Google::Apis::RequestOptions] options
1500
+ # Request-specific options
1501
+ #
1502
+ # @yield [result, err] Result & error if block supplied
1503
+ # @yieldparam result [Google::Apis::NotebooksV1::Operation] parsed result object
1504
+ # @yieldparam err [StandardError] error object if request failed
1505
+ #
1506
+ # @return [Google::Apis::NotebooksV1::Operation]
1507
+ #
1508
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1509
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1510
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1511
+ def switch_runtime(name, switch_runtime_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1512
+ command = make_simple_command(:post, 'v1/{+name}:switch', options)
1513
+ command.request_representation = Google::Apis::NotebooksV1::SwitchRuntimeRequest::Representation
1514
+ command.request_object = switch_runtime_request_object
1515
+ command.response_representation = Google::Apis::NotebooksV1::Operation::Representation
1516
+ command.response_class = Google::Apis::NotebooksV1::Operation
1517
+ command.params['name'] = name unless name.nil?
1518
+ command.query['fields'] = fields unless fields.nil?
1519
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1520
+ execute_or_queue_command(command, &block)
1521
+ end
1522
+
1523
+ # Creates a new Scheduled Notebook in a given project and location.
1524
+ # @param [String] parent
1525
+ # Required. Format: `parent=projects/`project_id`/locations/`location``
1526
+ # @param [Google::Apis::NotebooksV1::Schedule] schedule_object
1527
+ # @param [String] schedule_id
1528
+ # Required. User-defined unique ID of this schedule.
1529
+ # @param [String] fields
1530
+ # Selector specifying which fields to include in a partial response.
1531
+ # @param [String] quota_user
1532
+ # Available to use for quota purposes for server-side applications. Can be any
1533
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1534
+ # @param [Google::Apis::RequestOptions] options
1535
+ # Request-specific options
1536
+ #
1537
+ # @yield [result, err] Result & error if block supplied
1538
+ # @yieldparam result [Google::Apis::NotebooksV1::Operation] parsed result object
1539
+ # @yieldparam err [StandardError] error object if request failed
1540
+ #
1541
+ # @return [Google::Apis::NotebooksV1::Operation]
1542
+ #
1543
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1544
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1545
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1546
+ def create_project_location_schedule(parent, schedule_object = nil, schedule_id: nil, fields: nil, quota_user: nil, options: nil, &block)
1547
+ command = make_simple_command(:post, 'v1/{+parent}/schedules', options)
1548
+ command.request_representation = Google::Apis::NotebooksV1::Schedule::Representation
1549
+ command.request_object = schedule_object
1550
+ command.response_representation = Google::Apis::NotebooksV1::Operation::Representation
1551
+ command.response_class = Google::Apis::NotebooksV1::Operation
1552
+ command.params['parent'] = parent unless parent.nil?
1553
+ command.query['scheduleId'] = schedule_id unless schedule_id.nil?
1554
+ command.query['fields'] = fields unless fields.nil?
1555
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1556
+ execute_or_queue_command(command, &block)
1557
+ end
1558
+
1559
+ # Deletes schedule and all underlying jobs
1560
+ # @param [String] name
1561
+ # Required. Format: `projects/`project_id`/locations/`location`/schedules/`
1562
+ # schedule_id``
1563
+ # @param [String] fields
1564
+ # Selector specifying which fields to include in a partial response.
1565
+ # @param [String] quota_user
1566
+ # Available to use for quota purposes for server-side applications. Can be any
1567
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1568
+ # @param [Google::Apis::RequestOptions] options
1569
+ # Request-specific options
1570
+ #
1571
+ # @yield [result, err] Result & error if block supplied
1572
+ # @yieldparam result [Google::Apis::NotebooksV1::Operation] parsed result object
1573
+ # @yieldparam err [StandardError] error object if request failed
1574
+ #
1575
+ # @return [Google::Apis::NotebooksV1::Operation]
1576
+ #
1577
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1578
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1579
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1580
+ def delete_project_location_schedule(name, fields: nil, quota_user: nil, options: nil, &block)
1581
+ command = make_simple_command(:delete, 'v1/{+name}', options)
1582
+ command.response_representation = Google::Apis::NotebooksV1::Operation::Representation
1583
+ command.response_class = Google::Apis::NotebooksV1::Operation
1584
+ command.params['name'] = name unless name.nil?
1585
+ command.query['fields'] = fields unless fields.nil?
1586
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1587
+ execute_or_queue_command(command, &block)
1588
+ end
1589
+
1590
+ # Gets details of schedule
1591
+ # @param [String] name
1592
+ # Required. Format: `projects/`project_id`/locations/`location`/schedules/`
1593
+ # schedule_id``
1594
+ # @param [String] fields
1595
+ # Selector specifying which fields to include in a partial response.
1596
+ # @param [String] quota_user
1597
+ # Available to use for quota purposes for server-side applications. Can be any
1598
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1599
+ # @param [Google::Apis::RequestOptions] options
1600
+ # Request-specific options
1601
+ #
1602
+ # @yield [result, err] Result & error if block supplied
1603
+ # @yieldparam result [Google::Apis::NotebooksV1::Schedule] parsed result object
1604
+ # @yieldparam err [StandardError] error object if request failed
1605
+ #
1606
+ # @return [Google::Apis::NotebooksV1::Schedule]
1607
+ #
1608
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1609
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1610
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1611
+ def get_project_location_schedule(name, fields: nil, quota_user: nil, options: nil, &block)
1612
+ command = make_simple_command(:get, 'v1/{+name}', options)
1613
+ command.response_representation = Google::Apis::NotebooksV1::Schedule::Representation
1614
+ command.response_class = Google::Apis::NotebooksV1::Schedule
1615
+ command.params['name'] = name unless name.nil?
1616
+ command.query['fields'] = fields unless fields.nil?
1617
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1618
+ execute_or_queue_command(command, &block)
1619
+ end
1620
+
1621
+ # Lists schedules in a given project and location.
1622
+ # @param [String] parent
1623
+ # Required. Format: `parent=projects/`project_id`/locations/`location``
1624
+ # @param [String] filter
1625
+ # Filter applied to resulting schedules.
1626
+ # @param [String] order_by
1627
+ # Field to order results by.
1628
+ # @param [Fixnum] page_size
1629
+ # Maximum return size of the list call.
1630
+ # @param [String] page_token
1631
+ # A previous returned page token that can be used to continue listing from the
1632
+ # last result.
1633
+ # @param [String] fields
1634
+ # Selector specifying which fields to include in a partial response.
1635
+ # @param [String] quota_user
1636
+ # Available to use for quota purposes for server-side applications. Can be any
1637
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1638
+ # @param [Google::Apis::RequestOptions] options
1639
+ # Request-specific options
1640
+ #
1641
+ # @yield [result, err] Result & error if block supplied
1642
+ # @yieldparam result [Google::Apis::NotebooksV1::ListSchedulesResponse] parsed result object
1643
+ # @yieldparam err [StandardError] error object if request failed
1644
+ #
1645
+ # @return [Google::Apis::NotebooksV1::ListSchedulesResponse]
1646
+ #
1647
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1648
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1649
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1650
+ def list_project_location_schedules(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1651
+ command = make_simple_command(:get, 'v1/{+parent}/schedules', options)
1652
+ command.response_representation = Google::Apis::NotebooksV1::ListSchedulesResponse::Representation
1653
+ command.response_class = Google::Apis::NotebooksV1::ListSchedulesResponse
1654
+ command.params['parent'] = parent unless parent.nil?
1655
+ command.query['filter'] = filter unless filter.nil?
1656
+ command.query['orderBy'] = order_by unless order_by.nil?
1657
+ command.query['pageSize'] = page_size unless page_size.nil?
1658
+ command.query['pageToken'] = page_token unless page_token.nil?
1659
+ command.query['fields'] = fields unless fields.nil?
1660
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1661
+ execute_or_queue_command(command, &block)
1662
+ end
1663
+
1035
1664
  # Triggers execution of an existing schedule.
1036
1665
  # @param [String] name
1037
1666
  # Required. Format: `parent=projects/`project_id`/locations/`location`/schedules/