google-cloud-ai_platform-v1 0.45.0 → 0.46.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/lib/google/cloud/ai_platform/v1/feature_online_store_admin_service/client.rb +12 -4
- data/lib/google/cloud/ai_platform/v1/feature_online_store_admin_service/rest/client.rb +12 -4
- data/lib/google/cloud/ai_platform/v1/feature_registry_service/client.rb +5 -1
- data/lib/google/cloud/ai_platform/v1/feature_registry_service/rest/client.rb +5 -1
- data/lib/google/cloud/ai_platform/v1/featurestore_service/client.rb +2 -1
- data/lib/google/cloud/ai_platform/v1/featurestore_service/rest/client.rb +2 -1
- data/lib/google/cloud/ai_platform/v1/llm_utility_service/client.rb +15 -4
- data/lib/google/cloud/ai_platform/v1/llm_utility_service/rest/client.rb +15 -4
- data/lib/google/cloud/ai_platform/v1/model_garden_service/client.rb +5 -2
- data/lib/google/cloud/ai_platform/v1/model_garden_service/rest/client.rb +5 -2
- data/lib/google/cloud/ai_platform/v1/notebook_service/client.rb +434 -0
- data/lib/google/cloud/ai_platform/v1/notebook_service/paths.rb +38 -0
- data/lib/google/cloud/ai_platform/v1/notebook_service/rest/client.rb +406 -0
- data/lib/google/cloud/ai_platform/v1/notebook_service/rest/service_stub.rb +237 -0
- data/lib/google/cloud/ai_platform/v1/version.rb +1 -1
- data/lib/google/cloud/aiplatform/v1/accelerator_type_pb.rb +1 -1
- data/lib/google/cloud/aiplatform/v1/content_pb.rb +6 -1
- data/lib/google/cloud/aiplatform/v1/custom_job_pb.rb +2 -1
- data/lib/google/cloud/aiplatform/v1/dataset_pb.rb +1 -1
- data/lib/google/cloud/aiplatform/v1/dataset_version_pb.rb +1 -1
- data/lib/google/cloud/aiplatform/v1/endpoint_pb.rb +1 -1
- data/lib/google/cloud/aiplatform/v1/feature_online_store_service_pb.rb +3 -1
- data/lib/google/cloud/aiplatform/v1/model_garden_service_pb.rb +1 -1
- data/lib/google/cloud/aiplatform/v1/notebook_execution_job_pb.rb +55 -0
- data/lib/google/cloud/aiplatform/v1/notebook_service_pb.rb +10 -1
- data/lib/google/cloud/aiplatform/v1/notebook_service_services_pb.rb +8 -0
- data/lib/google/cloud/aiplatform/v1/persistent_resource_pb.rb +2 -1
- data/lib/google/cloud/aiplatform/v1/prediction_service_pb.rb +1 -1
- data/lib/google/cloud/aiplatform/v1/tool_pb.rb +1 -1
- data/lib/google/cloud/aiplatform/v1/tuning_job_pb.rb +1 -1
- data/proto_docs/google/api/client.rb +14 -10
- data/proto_docs/google/api/resource.rb +7 -2
- data/proto_docs/google/cloud/aiplatform/v1/content.rb +85 -0
- data/proto_docs/google/cloud/aiplatform/v1/custom_job.rb +19 -0
- data/proto_docs/google/cloud/aiplatform/v1/dataset.rb +1 -1
- data/proto_docs/google/cloud/aiplatform/v1/dataset_version.rb +1 -1
- data/proto_docs/google/cloud/aiplatform/v1/endpoint.rb +21 -0
- data/proto_docs/google/cloud/aiplatform/v1/feature_online_store_admin_service.rb +12 -4
- data/proto_docs/google/cloud/aiplatform/v1/feature_online_store_service.rb +57 -0
- data/proto_docs/google/cloud/aiplatform/v1/feature_registry_service.rb +3 -0
- data/proto_docs/google/cloud/aiplatform/v1/featurestore_service.rb +2 -1
- data/proto_docs/google/cloud/aiplatform/v1/model_garden_service.rb +5 -1
- data/proto_docs/google/cloud/aiplatform/v1/notebook_execution_job.rb +144 -0
- data/proto_docs/google/cloud/aiplatform/v1/notebook_service.rb +125 -0
- data/proto_docs/google/cloud/aiplatform/v1/persistent_resource.rb +12 -0
- data/proto_docs/google/cloud/aiplatform/v1/prediction_service.rb +16 -3
- data/proto_docs/google/cloud/aiplatform/v1/study.rb +0 -1
- data/proto_docs/google/cloud/aiplatform/v1/tool.rb +2 -3
- data/proto_docs/google/cloud/aiplatform/v1/tuning_job.rb +7 -0
- metadata +4 -2
@@ -1269,6 +1269,384 @@ module Google
|
|
1269
1269
|
raise ::Google::Cloud::Error.from_error(e)
|
1270
1270
|
end
|
1271
1271
|
|
1272
|
+
##
|
1273
|
+
# Creates a NotebookExecutionJob.
|
1274
|
+
#
|
1275
|
+
# @overload create_notebook_execution_job(request, options = nil)
|
1276
|
+
# Pass arguments to `create_notebook_execution_job` via a request object, either of type
|
1277
|
+
# {::Google::Cloud::AIPlatform::V1::CreateNotebookExecutionJobRequest} or an equivalent Hash.
|
1278
|
+
#
|
1279
|
+
# @param request [::Google::Cloud::AIPlatform::V1::CreateNotebookExecutionJobRequest, ::Hash]
|
1280
|
+
# A request object representing the call parameters. Required. To specify no
|
1281
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
1282
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
1283
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
1284
|
+
#
|
1285
|
+
# @overload create_notebook_execution_job(parent: nil, notebook_execution_job: nil, notebook_execution_job_id: nil)
|
1286
|
+
# Pass arguments to `create_notebook_execution_job` via keyword arguments. Note that at
|
1287
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
1288
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
1289
|
+
#
|
1290
|
+
# @param parent [::String]
|
1291
|
+
# Required. The resource name of the Location to create the
|
1292
|
+
# NotebookExecutionJob. Format: `projects/{project}/locations/{location}`
|
1293
|
+
# @param notebook_execution_job [::Google::Cloud::AIPlatform::V1::NotebookExecutionJob, ::Hash]
|
1294
|
+
# Required. The NotebookExecutionJob to create.
|
1295
|
+
# @param notebook_execution_job_id [::String]
|
1296
|
+
# Optional. User specified ID for the NotebookExecutionJob.
|
1297
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
1298
|
+
# @yieldparam result [::Gapic::Operation]
|
1299
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
1300
|
+
#
|
1301
|
+
# @return [::Gapic::Operation]
|
1302
|
+
#
|
1303
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
1304
|
+
#
|
1305
|
+
# @example Basic example
|
1306
|
+
# require "google/cloud/ai_platform/v1"
|
1307
|
+
#
|
1308
|
+
# # Create a client object. The client can be reused for multiple calls.
|
1309
|
+
# client = Google::Cloud::AIPlatform::V1::NotebookService::Rest::Client.new
|
1310
|
+
#
|
1311
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1312
|
+
# request = Google::Cloud::AIPlatform::V1::CreateNotebookExecutionJobRequest.new
|
1313
|
+
#
|
1314
|
+
# # Call the create_notebook_execution_job method.
|
1315
|
+
# result = client.create_notebook_execution_job request
|
1316
|
+
#
|
1317
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
1318
|
+
# # check the status of an operation, cancel it, or wait for results.
|
1319
|
+
# # Here is how to wait for a response.
|
1320
|
+
# result.wait_until_done! timeout: 60
|
1321
|
+
# if result.response?
|
1322
|
+
# p result.response
|
1323
|
+
# else
|
1324
|
+
# puts "No response received."
|
1325
|
+
# end
|
1326
|
+
#
|
1327
|
+
def create_notebook_execution_job request, options = nil
|
1328
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
1329
|
+
|
1330
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::CreateNotebookExecutionJobRequest
|
1331
|
+
|
1332
|
+
# Converts hash and nil to an options object
|
1333
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
1334
|
+
|
1335
|
+
# Customize the options with defaults
|
1336
|
+
call_metadata = @config.rpcs.create_notebook_execution_job.metadata.to_h
|
1337
|
+
|
1338
|
+
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
|
1339
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
1340
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
1341
|
+
gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION,
|
1342
|
+
transports_version_send: [:rest]
|
1343
|
+
|
1344
|
+
call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
|
1345
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
1346
|
+
|
1347
|
+
options.apply_defaults timeout: @config.rpcs.create_notebook_execution_job.timeout,
|
1348
|
+
metadata: call_metadata,
|
1349
|
+
retry_policy: @config.rpcs.create_notebook_execution_job.retry_policy
|
1350
|
+
|
1351
|
+
options.apply_defaults timeout: @config.timeout,
|
1352
|
+
metadata: @config.metadata,
|
1353
|
+
retry_policy: @config.retry_policy
|
1354
|
+
|
1355
|
+
@notebook_service_stub.create_notebook_execution_job request, options do |result, operation|
|
1356
|
+
result = ::Gapic::Operation.new result, @operations_client, options: options
|
1357
|
+
yield result, operation if block_given?
|
1358
|
+
return result
|
1359
|
+
end
|
1360
|
+
rescue ::Gapic::Rest::Error => e
|
1361
|
+
raise ::Google::Cloud::Error.from_error(e)
|
1362
|
+
end
|
1363
|
+
|
1364
|
+
##
|
1365
|
+
# Gets a NotebookExecutionJob.
|
1366
|
+
#
|
1367
|
+
# @overload get_notebook_execution_job(request, options = nil)
|
1368
|
+
# Pass arguments to `get_notebook_execution_job` via a request object, either of type
|
1369
|
+
# {::Google::Cloud::AIPlatform::V1::GetNotebookExecutionJobRequest} or an equivalent Hash.
|
1370
|
+
#
|
1371
|
+
# @param request [::Google::Cloud::AIPlatform::V1::GetNotebookExecutionJobRequest, ::Hash]
|
1372
|
+
# A request object representing the call parameters. Required. To specify no
|
1373
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
1374
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
1375
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
1376
|
+
#
|
1377
|
+
# @overload get_notebook_execution_job(name: nil, view: nil)
|
1378
|
+
# Pass arguments to `get_notebook_execution_job` via keyword arguments. Note that at
|
1379
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
1380
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
1381
|
+
#
|
1382
|
+
# @param name [::String]
|
1383
|
+
# Required. The name of the NotebookExecutionJob resource.
|
1384
|
+
# @param view [::Google::Cloud::AIPlatform::V1::NotebookExecutionJobView]
|
1385
|
+
# Optional. The NotebookExecutionJob view. Defaults to BASIC.
|
1386
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
1387
|
+
# @yieldparam result [::Google::Cloud::AIPlatform::V1::NotebookExecutionJob]
|
1388
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
1389
|
+
#
|
1390
|
+
# @return [::Google::Cloud::AIPlatform::V1::NotebookExecutionJob]
|
1391
|
+
#
|
1392
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
1393
|
+
#
|
1394
|
+
# @example Basic example
|
1395
|
+
# require "google/cloud/ai_platform/v1"
|
1396
|
+
#
|
1397
|
+
# # Create a client object. The client can be reused for multiple calls.
|
1398
|
+
# client = Google::Cloud::AIPlatform::V1::NotebookService::Rest::Client.new
|
1399
|
+
#
|
1400
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1401
|
+
# request = Google::Cloud::AIPlatform::V1::GetNotebookExecutionJobRequest.new
|
1402
|
+
#
|
1403
|
+
# # Call the get_notebook_execution_job method.
|
1404
|
+
# result = client.get_notebook_execution_job request
|
1405
|
+
#
|
1406
|
+
# # The returned object is of type Google::Cloud::AIPlatform::V1::NotebookExecutionJob.
|
1407
|
+
# p result
|
1408
|
+
#
|
1409
|
+
def get_notebook_execution_job request, options = nil
|
1410
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
1411
|
+
|
1412
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::GetNotebookExecutionJobRequest
|
1413
|
+
|
1414
|
+
# Converts hash and nil to an options object
|
1415
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
1416
|
+
|
1417
|
+
# Customize the options with defaults
|
1418
|
+
call_metadata = @config.rpcs.get_notebook_execution_job.metadata.to_h
|
1419
|
+
|
1420
|
+
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
|
1421
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
1422
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
1423
|
+
gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION,
|
1424
|
+
transports_version_send: [:rest]
|
1425
|
+
|
1426
|
+
call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
|
1427
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
1428
|
+
|
1429
|
+
options.apply_defaults timeout: @config.rpcs.get_notebook_execution_job.timeout,
|
1430
|
+
metadata: call_metadata,
|
1431
|
+
retry_policy: @config.rpcs.get_notebook_execution_job.retry_policy
|
1432
|
+
|
1433
|
+
options.apply_defaults timeout: @config.timeout,
|
1434
|
+
metadata: @config.metadata,
|
1435
|
+
retry_policy: @config.retry_policy
|
1436
|
+
|
1437
|
+
@notebook_service_stub.get_notebook_execution_job request, options do |result, operation|
|
1438
|
+
yield result, operation if block_given?
|
1439
|
+
return result
|
1440
|
+
end
|
1441
|
+
rescue ::Gapic::Rest::Error => e
|
1442
|
+
raise ::Google::Cloud::Error.from_error(e)
|
1443
|
+
end
|
1444
|
+
|
1445
|
+
##
|
1446
|
+
# Lists NotebookExecutionJobs in a Location.
|
1447
|
+
#
|
1448
|
+
# @overload list_notebook_execution_jobs(request, options = nil)
|
1449
|
+
# Pass arguments to `list_notebook_execution_jobs` via a request object, either of type
|
1450
|
+
# {::Google::Cloud::AIPlatform::V1::ListNotebookExecutionJobsRequest} or an equivalent Hash.
|
1451
|
+
#
|
1452
|
+
# @param request [::Google::Cloud::AIPlatform::V1::ListNotebookExecutionJobsRequest, ::Hash]
|
1453
|
+
# A request object representing the call parameters. Required. To specify no
|
1454
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
1455
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
1456
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
1457
|
+
#
|
1458
|
+
# @overload list_notebook_execution_jobs(parent: nil, filter: nil, page_size: nil, page_token: nil, order_by: nil, view: nil)
|
1459
|
+
# Pass arguments to `list_notebook_execution_jobs` via keyword arguments. Note that at
|
1460
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
1461
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
1462
|
+
#
|
1463
|
+
# @param parent [::String]
|
1464
|
+
# Required. The resource name of the Location from which to list the
|
1465
|
+
# NotebookExecutionJobs.
|
1466
|
+
# Format: `projects/{project}/locations/{location}`
|
1467
|
+
# @param filter [::String]
|
1468
|
+
# Optional. An expression for filtering the results of the request. For field
|
1469
|
+
# names both snake_case and camelCase are supported.
|
1470
|
+
#
|
1471
|
+
# * `notebookExecutionJob` supports = and !=. `notebookExecutionJob`
|
1472
|
+
# represents the NotebookExecutionJob ID.
|
1473
|
+
# * `displayName` supports = and != and regex.
|
1474
|
+
# * `schedule` supports = and != and regex.
|
1475
|
+
#
|
1476
|
+
# Some examples:
|
1477
|
+
# * `notebookExecutionJob="123"`
|
1478
|
+
# * `notebookExecutionJob="my-execution-job"`
|
1479
|
+
# * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"`
|
1480
|
+
# @param page_size [::Integer]
|
1481
|
+
# Optional. The standard list page size.
|
1482
|
+
# @param page_token [::String]
|
1483
|
+
# Optional. The standard list page token.
|
1484
|
+
# Typically obtained via
|
1485
|
+
# [ListNotebookExecutionJobs.next_page_token][] of the previous
|
1486
|
+
# {::Google::Cloud::AIPlatform::V1::NotebookService::Rest::Client#list_notebook_execution_jobs NotebookService.ListNotebookExecutionJobs}
|
1487
|
+
# call.
|
1488
|
+
# @param order_by [::String]
|
1489
|
+
# Optional. A comma-separated list of fields to order by, sorted in ascending
|
1490
|
+
# order. Use "desc" after a field name for descending. Supported fields:
|
1491
|
+
#
|
1492
|
+
# * `display_name`
|
1493
|
+
# * `create_time`
|
1494
|
+
# * `update_time`
|
1495
|
+
#
|
1496
|
+
# Example: `display_name, create_time desc`.
|
1497
|
+
# @param view [::Google::Cloud::AIPlatform::V1::NotebookExecutionJobView]
|
1498
|
+
# Optional. The NotebookExecutionJob view. Defaults to BASIC.
|
1499
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
1500
|
+
# @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::AIPlatform::V1::NotebookExecutionJob>]
|
1501
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
1502
|
+
#
|
1503
|
+
# @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::AIPlatform::V1::NotebookExecutionJob>]
|
1504
|
+
#
|
1505
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
1506
|
+
#
|
1507
|
+
# @example Basic example
|
1508
|
+
# require "google/cloud/ai_platform/v1"
|
1509
|
+
#
|
1510
|
+
# # Create a client object. The client can be reused for multiple calls.
|
1511
|
+
# client = Google::Cloud::AIPlatform::V1::NotebookService::Rest::Client.new
|
1512
|
+
#
|
1513
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1514
|
+
# request = Google::Cloud::AIPlatform::V1::ListNotebookExecutionJobsRequest.new
|
1515
|
+
#
|
1516
|
+
# # Call the list_notebook_execution_jobs method.
|
1517
|
+
# result = client.list_notebook_execution_jobs request
|
1518
|
+
#
|
1519
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
|
1520
|
+
# # over elements, and API calls will be issued to fetch pages as needed.
|
1521
|
+
# result.each do |item|
|
1522
|
+
# # Each element is of type ::Google::Cloud::AIPlatform::V1::NotebookExecutionJob.
|
1523
|
+
# p item
|
1524
|
+
# end
|
1525
|
+
#
|
1526
|
+
def list_notebook_execution_jobs request, options = nil
|
1527
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
1528
|
+
|
1529
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::ListNotebookExecutionJobsRequest
|
1530
|
+
|
1531
|
+
# Converts hash and nil to an options object
|
1532
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
1533
|
+
|
1534
|
+
# Customize the options with defaults
|
1535
|
+
call_metadata = @config.rpcs.list_notebook_execution_jobs.metadata.to_h
|
1536
|
+
|
1537
|
+
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
|
1538
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
1539
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
1540
|
+
gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION,
|
1541
|
+
transports_version_send: [:rest]
|
1542
|
+
|
1543
|
+
call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
|
1544
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
1545
|
+
|
1546
|
+
options.apply_defaults timeout: @config.rpcs.list_notebook_execution_jobs.timeout,
|
1547
|
+
metadata: call_metadata,
|
1548
|
+
retry_policy: @config.rpcs.list_notebook_execution_jobs.retry_policy
|
1549
|
+
|
1550
|
+
options.apply_defaults timeout: @config.timeout,
|
1551
|
+
metadata: @config.metadata,
|
1552
|
+
retry_policy: @config.retry_policy
|
1553
|
+
|
1554
|
+
@notebook_service_stub.list_notebook_execution_jobs request, options do |result, operation|
|
1555
|
+
result = ::Gapic::Rest::PagedEnumerable.new @notebook_service_stub, :list_notebook_execution_jobs, "notebook_execution_jobs", request, result, options
|
1556
|
+
yield result, operation if block_given?
|
1557
|
+
return result
|
1558
|
+
end
|
1559
|
+
rescue ::Gapic::Rest::Error => e
|
1560
|
+
raise ::Google::Cloud::Error.from_error(e)
|
1561
|
+
end
|
1562
|
+
|
1563
|
+
##
|
1564
|
+
# Deletes a NotebookExecutionJob.
|
1565
|
+
#
|
1566
|
+
# @overload delete_notebook_execution_job(request, options = nil)
|
1567
|
+
# Pass arguments to `delete_notebook_execution_job` via a request object, either of type
|
1568
|
+
# {::Google::Cloud::AIPlatform::V1::DeleteNotebookExecutionJobRequest} or an equivalent Hash.
|
1569
|
+
#
|
1570
|
+
# @param request [::Google::Cloud::AIPlatform::V1::DeleteNotebookExecutionJobRequest, ::Hash]
|
1571
|
+
# A request object representing the call parameters. Required. To specify no
|
1572
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
1573
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
1574
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
1575
|
+
#
|
1576
|
+
# @overload delete_notebook_execution_job(name: nil)
|
1577
|
+
# Pass arguments to `delete_notebook_execution_job` via keyword arguments. Note that at
|
1578
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
1579
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
1580
|
+
#
|
1581
|
+
# @param name [::String]
|
1582
|
+
# Required. The name of the NotebookExecutionJob resource to be deleted.
|
1583
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
1584
|
+
# @yieldparam result [::Gapic::Operation]
|
1585
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
1586
|
+
#
|
1587
|
+
# @return [::Gapic::Operation]
|
1588
|
+
#
|
1589
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
1590
|
+
#
|
1591
|
+
# @example Basic example
|
1592
|
+
# require "google/cloud/ai_platform/v1"
|
1593
|
+
#
|
1594
|
+
# # Create a client object. The client can be reused for multiple calls.
|
1595
|
+
# client = Google::Cloud::AIPlatform::V1::NotebookService::Rest::Client.new
|
1596
|
+
#
|
1597
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1598
|
+
# request = Google::Cloud::AIPlatform::V1::DeleteNotebookExecutionJobRequest.new
|
1599
|
+
#
|
1600
|
+
# # Call the delete_notebook_execution_job method.
|
1601
|
+
# result = client.delete_notebook_execution_job request
|
1602
|
+
#
|
1603
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
1604
|
+
# # check the status of an operation, cancel it, or wait for results.
|
1605
|
+
# # Here is how to wait for a response.
|
1606
|
+
# result.wait_until_done! timeout: 60
|
1607
|
+
# if result.response?
|
1608
|
+
# p result.response
|
1609
|
+
# else
|
1610
|
+
# puts "No response received."
|
1611
|
+
# end
|
1612
|
+
#
|
1613
|
+
def delete_notebook_execution_job request, options = nil
|
1614
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
1615
|
+
|
1616
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::DeleteNotebookExecutionJobRequest
|
1617
|
+
|
1618
|
+
# Converts hash and nil to an options object
|
1619
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
1620
|
+
|
1621
|
+
# Customize the options with defaults
|
1622
|
+
call_metadata = @config.rpcs.delete_notebook_execution_job.metadata.to_h
|
1623
|
+
|
1624
|
+
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
|
1625
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
1626
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
1627
|
+
gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION,
|
1628
|
+
transports_version_send: [:rest]
|
1629
|
+
|
1630
|
+
call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
|
1631
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
1632
|
+
|
1633
|
+
options.apply_defaults timeout: @config.rpcs.delete_notebook_execution_job.timeout,
|
1634
|
+
metadata: call_metadata,
|
1635
|
+
retry_policy: @config.rpcs.delete_notebook_execution_job.retry_policy
|
1636
|
+
|
1637
|
+
options.apply_defaults timeout: @config.timeout,
|
1638
|
+
metadata: @config.metadata,
|
1639
|
+
retry_policy: @config.retry_policy
|
1640
|
+
|
1641
|
+
@notebook_service_stub.delete_notebook_execution_job request, options do |result, operation|
|
1642
|
+
result = ::Gapic::Operation.new result, @operations_client, options: options
|
1643
|
+
yield result, operation if block_given?
|
1644
|
+
return result
|
1645
|
+
end
|
1646
|
+
rescue ::Gapic::Rest::Error => e
|
1647
|
+
raise ::Google::Cloud::Error.from_error(e)
|
1648
|
+
end
|
1649
|
+
|
1272
1650
|
##
|
1273
1651
|
# Configuration class for the NotebookService REST API.
|
1274
1652
|
#
|
@@ -1464,6 +1842,26 @@ module Google
|
|
1464
1842
|
# @return [::Gapic::Config::Method]
|
1465
1843
|
#
|
1466
1844
|
attr_reader :start_notebook_runtime
|
1845
|
+
##
|
1846
|
+
# RPC-specific configuration for `create_notebook_execution_job`
|
1847
|
+
# @return [::Gapic::Config::Method]
|
1848
|
+
#
|
1849
|
+
attr_reader :create_notebook_execution_job
|
1850
|
+
##
|
1851
|
+
# RPC-specific configuration for `get_notebook_execution_job`
|
1852
|
+
# @return [::Gapic::Config::Method]
|
1853
|
+
#
|
1854
|
+
attr_reader :get_notebook_execution_job
|
1855
|
+
##
|
1856
|
+
# RPC-specific configuration for `list_notebook_execution_jobs`
|
1857
|
+
# @return [::Gapic::Config::Method]
|
1858
|
+
#
|
1859
|
+
attr_reader :list_notebook_execution_jobs
|
1860
|
+
##
|
1861
|
+
# RPC-specific configuration for `delete_notebook_execution_job`
|
1862
|
+
# @return [::Gapic::Config::Method]
|
1863
|
+
#
|
1864
|
+
attr_reader :delete_notebook_execution_job
|
1467
1865
|
|
1468
1866
|
# @private
|
1469
1867
|
def initialize parent_rpcs = nil
|
@@ -1489,6 +1887,14 @@ module Google
|
|
1489
1887
|
@upgrade_notebook_runtime = ::Gapic::Config::Method.new upgrade_notebook_runtime_config
|
1490
1888
|
start_notebook_runtime_config = parent_rpcs.start_notebook_runtime if parent_rpcs.respond_to? :start_notebook_runtime
|
1491
1889
|
@start_notebook_runtime = ::Gapic::Config::Method.new start_notebook_runtime_config
|
1890
|
+
create_notebook_execution_job_config = parent_rpcs.create_notebook_execution_job if parent_rpcs.respond_to? :create_notebook_execution_job
|
1891
|
+
@create_notebook_execution_job = ::Gapic::Config::Method.new create_notebook_execution_job_config
|
1892
|
+
get_notebook_execution_job_config = parent_rpcs.get_notebook_execution_job if parent_rpcs.respond_to? :get_notebook_execution_job
|
1893
|
+
@get_notebook_execution_job = ::Gapic::Config::Method.new get_notebook_execution_job_config
|
1894
|
+
list_notebook_execution_jobs_config = parent_rpcs.list_notebook_execution_jobs if parent_rpcs.respond_to? :list_notebook_execution_jobs
|
1895
|
+
@list_notebook_execution_jobs = ::Gapic::Config::Method.new list_notebook_execution_jobs_config
|
1896
|
+
delete_notebook_execution_job_config = parent_rpcs.delete_notebook_execution_job if parent_rpcs.respond_to? :delete_notebook_execution_job
|
1897
|
+
@delete_notebook_execution_job = ::Gapic::Config::Method.new delete_notebook_execution_job_config
|
1492
1898
|
|
1493
1899
|
yield self if block_given?
|
1494
1900
|
end
|