google-apis-aiplatform_v1 0.25.0 → 0.27.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -13002,6 +13002,189 @@ module Google
13002
13002
  execute_or_queue_command(command, &block)
13003
13003
  end
13004
13004
 
13005
+ # Starts asynchronous cancellation on a long-running operation. The server makes
13006
+ # a best effort to cancel the operation, but success is not guaranteed. If the
13007
+ # server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
13008
+ # Clients can use Operations.GetOperation or other methods to check whether the
13009
+ # cancellation succeeded or whether the operation completed despite cancellation.
13010
+ # On successful cancellation, the operation is not deleted; instead, it becomes
13011
+ # an operation with an Operation.error value with a google.rpc.Status.code of 1,
13012
+ # corresponding to `Code.CANCELLED`.
13013
+ # @param [String] name
13014
+ # The name of the operation resource to be cancelled.
13015
+ # @param [String] fields
13016
+ # Selector specifying which fields to include in a partial response.
13017
+ # @param [String] quota_user
13018
+ # Available to use for quota purposes for server-side applications. Can be any
13019
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
13020
+ # @param [Google::Apis::RequestOptions] options
13021
+ # Request-specific options
13022
+ #
13023
+ # @yield [result, err] Result & error if block supplied
13024
+ # @yieldparam result [Google::Apis::AiplatformV1::GoogleProtobufEmpty] parsed result object
13025
+ # @yieldparam err [StandardError] error object if request failed
13026
+ #
13027
+ # @return [Google::Apis::AiplatformV1::GoogleProtobufEmpty]
13028
+ #
13029
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
13030
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
13031
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
13032
+ def cancel_project_location_notebook_execution_job_operation(name, fields: nil, quota_user: nil, options: nil, &block)
13033
+ command = make_simple_command(:post, 'v1/{+name}:cancel', options)
13034
+ command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
13035
+ command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
13036
+ command.params['name'] = name unless name.nil?
13037
+ command.query['fields'] = fields unless fields.nil?
13038
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
13039
+ execute_or_queue_command(command, &block)
13040
+ end
13041
+
13042
+ # Deletes a long-running operation. This method indicates that the client is no
13043
+ # longer interested in the operation result. It does not cancel the operation.
13044
+ # If the server doesn't support this method, it returns `google.rpc.Code.
13045
+ # UNIMPLEMENTED`.
13046
+ # @param [String] name
13047
+ # The name of the operation resource to be deleted.
13048
+ # @param [String] fields
13049
+ # Selector specifying which fields to include in a partial response.
13050
+ # @param [String] quota_user
13051
+ # Available to use for quota purposes for server-side applications. Can be any
13052
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
13053
+ # @param [Google::Apis::RequestOptions] options
13054
+ # Request-specific options
13055
+ #
13056
+ # @yield [result, err] Result & error if block supplied
13057
+ # @yieldparam result [Google::Apis::AiplatformV1::GoogleProtobufEmpty] parsed result object
13058
+ # @yieldparam err [StandardError] error object if request failed
13059
+ #
13060
+ # @return [Google::Apis::AiplatformV1::GoogleProtobufEmpty]
13061
+ #
13062
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
13063
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
13064
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
13065
+ def delete_project_location_notebook_execution_job_operation(name, fields: nil, quota_user: nil, options: nil, &block)
13066
+ command = make_simple_command(:delete, 'v1/{+name}', options)
13067
+ command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
13068
+ command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
13069
+ command.params['name'] = name unless name.nil?
13070
+ command.query['fields'] = fields unless fields.nil?
13071
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
13072
+ execute_or_queue_command(command, &block)
13073
+ end
13074
+
13075
+ # Gets the latest state of a long-running operation. Clients can use this method
13076
+ # to poll the operation result at intervals as recommended by the API service.
13077
+ # @param [String] name
13078
+ # The name of the operation resource.
13079
+ # @param [String] fields
13080
+ # Selector specifying which fields to include in a partial response.
13081
+ # @param [String] quota_user
13082
+ # Available to use for quota purposes for server-side applications. Can be any
13083
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
13084
+ # @param [Google::Apis::RequestOptions] options
13085
+ # Request-specific options
13086
+ #
13087
+ # @yield [result, err] Result & error if block supplied
13088
+ # @yieldparam result [Google::Apis::AiplatformV1::GoogleLongrunningOperation] parsed result object
13089
+ # @yieldparam err [StandardError] error object if request failed
13090
+ #
13091
+ # @return [Google::Apis::AiplatformV1::GoogleLongrunningOperation]
13092
+ #
13093
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
13094
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
13095
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
13096
+ def get_project_location_notebook_execution_job_operation(name, fields: nil, quota_user: nil, options: nil, &block)
13097
+ command = make_simple_command(:get, 'v1/{+name}', options)
13098
+ command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
13099
+ command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
13100
+ command.params['name'] = name unless name.nil?
13101
+ command.query['fields'] = fields unless fields.nil?
13102
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
13103
+ execute_or_queue_command(command, &block)
13104
+ end
13105
+
13106
+ # Lists operations that match the specified filter in the request. If the server
13107
+ # doesn't support this method, it returns `UNIMPLEMENTED`.
13108
+ # @param [String] name
13109
+ # The name of the operation's parent resource.
13110
+ # @param [String] filter
13111
+ # The standard list filter.
13112
+ # @param [Fixnum] page_size
13113
+ # The standard list page size.
13114
+ # @param [String] page_token
13115
+ # The standard list page token.
13116
+ # @param [String] fields
13117
+ # Selector specifying which fields to include in a partial response.
13118
+ # @param [String] quota_user
13119
+ # Available to use for quota purposes for server-side applications. Can be any
13120
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
13121
+ # @param [Google::Apis::RequestOptions] options
13122
+ # Request-specific options
13123
+ #
13124
+ # @yield [result, err] Result & error if block supplied
13125
+ # @yieldparam result [Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse] parsed result object
13126
+ # @yieldparam err [StandardError] error object if request failed
13127
+ #
13128
+ # @return [Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse]
13129
+ #
13130
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
13131
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
13132
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
13133
+ def list_project_location_notebook_execution_job_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
13134
+ command = make_simple_command(:get, 'v1/{+name}/operations', options)
13135
+ command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse::Representation
13136
+ command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse
13137
+ command.params['name'] = name unless name.nil?
13138
+ command.query['filter'] = filter unless filter.nil?
13139
+ command.query['pageSize'] = page_size unless page_size.nil?
13140
+ command.query['pageToken'] = page_token unless page_token.nil?
13141
+ command.query['fields'] = fields unless fields.nil?
13142
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
13143
+ execute_or_queue_command(command, &block)
13144
+ end
13145
+
13146
+ # Waits until the specified long-running operation is done or reaches at most a
13147
+ # specified timeout, returning the latest state. If the operation is already
13148
+ # done, the latest state is immediately returned. If the timeout specified is
13149
+ # greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If
13150
+ # the server does not support this method, it returns `google.rpc.Code.
13151
+ # UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return
13152
+ # the latest state before the specified timeout (including immediately), meaning
13153
+ # even an immediate response is no guarantee that the operation is done.
13154
+ # @param [String] name
13155
+ # The name of the operation resource to wait on.
13156
+ # @param [String] timeout
13157
+ # The maximum duration to wait before timing out. If left blank, the wait will
13158
+ # be at most the time permitted by the underlying HTTP/RPC protocol. If RPC
13159
+ # context deadline is also specified, the shorter one will be used.
13160
+ # @param [String] fields
13161
+ # Selector specifying which fields to include in a partial response.
13162
+ # @param [String] quota_user
13163
+ # Available to use for quota purposes for server-side applications. Can be any
13164
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
13165
+ # @param [Google::Apis::RequestOptions] options
13166
+ # Request-specific options
13167
+ #
13168
+ # @yield [result, err] Result & error if block supplied
13169
+ # @yieldparam result [Google::Apis::AiplatformV1::GoogleLongrunningOperation] parsed result object
13170
+ # @yieldparam err [StandardError] error object if request failed
13171
+ #
13172
+ # @return [Google::Apis::AiplatformV1::GoogleLongrunningOperation]
13173
+ #
13174
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
13175
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
13176
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
13177
+ def wait_project_location_notebook_execution_job_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
13178
+ command = make_simple_command(:post, 'v1/{+name}:wait', options)
13179
+ command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
13180
+ command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
13181
+ command.params['name'] = name unless name.nil?
13182
+ command.query['timeout'] = timeout unless timeout.nil?
13183
+ command.query['fields'] = fields unless fields.nil?
13184
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
13185
+ execute_or_queue_command(command, &block)
13186
+ end
13187
+
13005
13188
  # Creates a NotebookRuntimeTemplate.
13006
13189
  # @param [String] parent
13007
13190
  # Required. The resource name of the Location to create the
@@ -13325,12 +13508,16 @@ module Google
13325
13508
  execute_or_queue_command(command, &block)
13326
13509
  end
13327
13510
 
13328
- # Assigns a NotebookRuntime to a user for a particular Notebook file. This
13329
- # method will either returns an existing assignment or generates a new one.
13330
- # @param [String] parent
13331
- # Required. The resource name of the Location to get the NotebookRuntime
13332
- # assignment. Format: `projects/`project`/locations/`location``
13333
- # @param [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1AssignNotebookRuntimeRequest] google_cloud_aiplatform_v1_assign_notebook_runtime_request_object
13511
+ # Starts asynchronous cancellation on a long-running operation. The server makes
13512
+ # a best effort to cancel the operation, but success is not guaranteed. If the
13513
+ # server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
13514
+ # Clients can use Operations.GetOperation or other methods to check whether the
13515
+ # cancellation succeeded or whether the operation completed despite cancellation.
13516
+ # On successful cancellation, the operation is not deleted; instead, it becomes
13517
+ # an operation with an Operation.error value with a google.rpc.Status.code of 1,
13518
+ # corresponding to `Code.CANCELLED`.
13519
+ # @param [String] name
13520
+ # The name of the operation resource to be cancelled.
13334
13521
  # @param [String] fields
13335
13522
  # Selector specifying which fields to include in a partial response.
13336
13523
  # @param [String] quota_user
@@ -13340,32 +13527,30 @@ module Google
13340
13527
  # Request-specific options
13341
13528
  #
13342
13529
  # @yield [result, err] Result & error if block supplied
13343
- # @yieldparam result [Google::Apis::AiplatformV1::GoogleLongrunningOperation] parsed result object
13530
+ # @yieldparam result [Google::Apis::AiplatformV1::GoogleProtobufEmpty] parsed result object
13344
13531
  # @yieldparam err [StandardError] error object if request failed
13345
13532
  #
13346
- # @return [Google::Apis::AiplatformV1::GoogleLongrunningOperation]
13533
+ # @return [Google::Apis::AiplatformV1::GoogleProtobufEmpty]
13347
13534
  #
13348
13535
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
13349
13536
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
13350
13537
  # @raise [Google::Apis::AuthorizationError] Authorization is required
13351
- def assign_project_location_notebook_runtime(parent, google_cloud_aiplatform_v1_assign_notebook_runtime_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
13352
- command = make_simple_command(:post, 'v1/{+parent}/notebookRuntimes:assign', options)
13353
- command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1AssignNotebookRuntimeRequest::Representation
13354
- command.request_object = google_cloud_aiplatform_v1_assign_notebook_runtime_request_object
13355
- command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
13356
- command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
13357
- command.params['parent'] = parent unless parent.nil?
13538
+ def cancel_project_location_notebook_runtime_template_operation(name, fields: nil, quota_user: nil, options: nil, &block)
13539
+ command = make_simple_command(:post, 'v1/{+name}:cancel', options)
13540
+ command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
13541
+ command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
13542
+ command.params['name'] = name unless name.nil?
13358
13543
  command.query['fields'] = fields unless fields.nil?
13359
13544
  command.query['quotaUser'] = quota_user unless quota_user.nil?
13360
13545
  execute_or_queue_command(command, &block)
13361
13546
  end
13362
13547
 
13363
- # Deletes a NotebookRuntime.
13548
+ # Deletes a long-running operation. This method indicates that the client is no
13549
+ # longer interested in the operation result. It does not cancel the operation.
13550
+ # If the server doesn't support this method, it returns `google.rpc.Code.
13551
+ # UNIMPLEMENTED`.
13364
13552
  # @param [String] name
13365
- # Required. The name of the NotebookRuntime resource to be deleted. Instead of
13366
- # checking whether the name is in valid NotebookRuntime resource name format,
13367
- # directly throw NotFound exception if there is no such NotebookRuntime in
13368
- # spanner.
13553
+ # The name of the operation resource to be deleted.
13369
13554
  # @param [String] fields
13370
13555
  # Selector specifying which fields to include in a partial response.
13371
13556
  # @param [String] quota_user
@@ -13375,29 +13560,28 @@ module Google
13375
13560
  # Request-specific options
13376
13561
  #
13377
13562
  # @yield [result, err] Result & error if block supplied
13378
- # @yieldparam result [Google::Apis::AiplatformV1::GoogleLongrunningOperation] parsed result object
13563
+ # @yieldparam result [Google::Apis::AiplatformV1::GoogleProtobufEmpty] parsed result object
13379
13564
  # @yieldparam err [StandardError] error object if request failed
13380
13565
  #
13381
- # @return [Google::Apis::AiplatformV1::GoogleLongrunningOperation]
13566
+ # @return [Google::Apis::AiplatformV1::GoogleProtobufEmpty]
13382
13567
  #
13383
13568
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
13384
13569
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
13385
13570
  # @raise [Google::Apis::AuthorizationError] Authorization is required
13386
- def delete_project_location_notebook_runtime(name, fields: nil, quota_user: nil, options: nil, &block)
13571
+ def delete_project_location_notebook_runtime_template_operation(name, fields: nil, quota_user: nil, options: nil, &block)
13387
13572
  command = make_simple_command(:delete, 'v1/{+name}', options)
13388
- command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
13389
- command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
13573
+ command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
13574
+ command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
13390
13575
  command.params['name'] = name unless name.nil?
13391
13576
  command.query['fields'] = fields unless fields.nil?
13392
13577
  command.query['quotaUser'] = quota_user unless quota_user.nil?
13393
13578
  execute_or_queue_command(command, &block)
13394
13579
  end
13395
13580
 
13396
- # Gets a NotebookRuntime.
13581
+ # Gets the latest state of a long-running operation. Clients can use this method
13582
+ # to poll the operation result at intervals as recommended by the API service.
13397
13583
  # @param [String] name
13398
- # Required. The name of the NotebookRuntime resource. Instead of checking
13399
- # whether the name is in valid NotebookRuntime resource name format, directly
13400
- # throw NotFound exception if there is no such NotebookRuntime in spanner.
13584
+ # The name of the operation resource.
13401
13585
  # @param [String] fields
13402
13586
  # Selector specifying which fields to include in a partial response.
13403
13587
  # @param [String] quota_user
@@ -13407,33 +13591,215 @@ module Google
13407
13591
  # Request-specific options
13408
13592
  #
13409
13593
  # @yield [result, err] Result & error if block supplied
13410
- # @yieldparam result [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NotebookRuntime] parsed result object
13594
+ # @yieldparam result [Google::Apis::AiplatformV1::GoogleLongrunningOperation] parsed result object
13411
13595
  # @yieldparam err [StandardError] error object if request failed
13412
13596
  #
13413
- # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NotebookRuntime]
13597
+ # @return [Google::Apis::AiplatformV1::GoogleLongrunningOperation]
13414
13598
  #
13415
13599
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
13416
13600
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
13417
13601
  # @raise [Google::Apis::AuthorizationError] Authorization is required
13418
- def get_project_location_notebook_runtime(name, fields: nil, quota_user: nil, options: nil, &block)
13602
+ def get_project_location_notebook_runtime_template_operation(name, fields: nil, quota_user: nil, options: nil, &block)
13419
13603
  command = make_simple_command(:get, 'v1/{+name}', options)
13420
- command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NotebookRuntime::Representation
13421
- command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NotebookRuntime
13604
+ command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
13605
+ command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
13422
13606
  command.params['name'] = name unless name.nil?
13423
13607
  command.query['fields'] = fields unless fields.nil?
13424
13608
  command.query['quotaUser'] = quota_user unless quota_user.nil?
13425
13609
  execute_or_queue_command(command, &block)
13426
13610
  end
13427
13611
 
13428
- # Lists NotebookRuntimes in a Location.
13429
- # @param [String] parent
13430
- # Required. The resource name of the Location from which to list the
13431
- # NotebookRuntimes. Format: `projects/`project`/locations/`location``
13612
+ # Lists operations that match the specified filter in the request. If the server
13613
+ # doesn't support this method, it returns `UNIMPLEMENTED`.
13614
+ # @param [String] name
13615
+ # The name of the operation's parent resource.
13432
13616
  # @param [String] filter
13433
- # Optional. An expression for filtering the results of the request. For field
13434
- # names both snake_case and camelCase are supported. * `notebookRuntime`
13435
- # supports = and !=. `notebookRuntime` represents the NotebookRuntime ID, i.e.
13436
- # the last segment of the NotebookRuntime's resource name. * `displayName`
13617
+ # The standard list filter.
13618
+ # @param [Fixnum] page_size
13619
+ # The standard list page size.
13620
+ # @param [String] page_token
13621
+ # The standard list page token.
13622
+ # @param [String] fields
13623
+ # Selector specifying which fields to include in a partial response.
13624
+ # @param [String] quota_user
13625
+ # Available to use for quota purposes for server-side applications. Can be any
13626
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
13627
+ # @param [Google::Apis::RequestOptions] options
13628
+ # Request-specific options
13629
+ #
13630
+ # @yield [result, err] Result & error if block supplied
13631
+ # @yieldparam result [Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse] parsed result object
13632
+ # @yieldparam err [StandardError] error object if request failed
13633
+ #
13634
+ # @return [Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse]
13635
+ #
13636
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
13637
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
13638
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
13639
+ def list_project_location_notebook_runtime_template_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
13640
+ command = make_simple_command(:get, 'v1/{+name}/operations', options)
13641
+ command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse::Representation
13642
+ command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse
13643
+ command.params['name'] = name unless name.nil?
13644
+ command.query['filter'] = filter unless filter.nil?
13645
+ command.query['pageSize'] = page_size unless page_size.nil?
13646
+ command.query['pageToken'] = page_token unless page_token.nil?
13647
+ command.query['fields'] = fields unless fields.nil?
13648
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
13649
+ execute_or_queue_command(command, &block)
13650
+ end
13651
+
13652
+ # Waits until the specified long-running operation is done or reaches at most a
13653
+ # specified timeout, returning the latest state. If the operation is already
13654
+ # done, the latest state is immediately returned. If the timeout specified is
13655
+ # greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If
13656
+ # the server does not support this method, it returns `google.rpc.Code.
13657
+ # UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return
13658
+ # the latest state before the specified timeout (including immediately), meaning
13659
+ # even an immediate response is no guarantee that the operation is done.
13660
+ # @param [String] name
13661
+ # The name of the operation resource to wait on.
13662
+ # @param [String] timeout
13663
+ # The maximum duration to wait before timing out. If left blank, the wait will
13664
+ # be at most the time permitted by the underlying HTTP/RPC protocol. If RPC
13665
+ # context deadline is also specified, the shorter one will be used.
13666
+ # @param [String] fields
13667
+ # Selector specifying which fields to include in a partial response.
13668
+ # @param [String] quota_user
13669
+ # Available to use for quota purposes for server-side applications. Can be any
13670
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
13671
+ # @param [Google::Apis::RequestOptions] options
13672
+ # Request-specific options
13673
+ #
13674
+ # @yield [result, err] Result & error if block supplied
13675
+ # @yieldparam result [Google::Apis::AiplatformV1::GoogleLongrunningOperation] parsed result object
13676
+ # @yieldparam err [StandardError] error object if request failed
13677
+ #
13678
+ # @return [Google::Apis::AiplatformV1::GoogleLongrunningOperation]
13679
+ #
13680
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
13681
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
13682
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
13683
+ def wait_project_location_notebook_runtime_template_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
13684
+ command = make_simple_command(:post, 'v1/{+name}:wait', options)
13685
+ command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
13686
+ command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
13687
+ command.params['name'] = name unless name.nil?
13688
+ command.query['timeout'] = timeout unless timeout.nil?
13689
+ command.query['fields'] = fields unless fields.nil?
13690
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
13691
+ execute_or_queue_command(command, &block)
13692
+ end
13693
+
13694
+ # Assigns a NotebookRuntime to a user for a particular Notebook file. This
13695
+ # method will either returns an existing assignment or generates a new one.
13696
+ # @param [String] parent
13697
+ # Required. The resource name of the Location to get the NotebookRuntime
13698
+ # assignment. Format: `projects/`project`/locations/`location``
13699
+ # @param [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1AssignNotebookRuntimeRequest] google_cloud_aiplatform_v1_assign_notebook_runtime_request_object
13700
+ # @param [String] fields
13701
+ # Selector specifying which fields to include in a partial response.
13702
+ # @param [String] quota_user
13703
+ # Available to use for quota purposes for server-side applications. Can be any
13704
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
13705
+ # @param [Google::Apis::RequestOptions] options
13706
+ # Request-specific options
13707
+ #
13708
+ # @yield [result, err] Result & error if block supplied
13709
+ # @yieldparam result [Google::Apis::AiplatformV1::GoogleLongrunningOperation] parsed result object
13710
+ # @yieldparam err [StandardError] error object if request failed
13711
+ #
13712
+ # @return [Google::Apis::AiplatformV1::GoogleLongrunningOperation]
13713
+ #
13714
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
13715
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
13716
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
13717
+ def assign_project_location_notebook_runtime(parent, google_cloud_aiplatform_v1_assign_notebook_runtime_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
13718
+ command = make_simple_command(:post, 'v1/{+parent}/notebookRuntimes:assign', options)
13719
+ command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1AssignNotebookRuntimeRequest::Representation
13720
+ command.request_object = google_cloud_aiplatform_v1_assign_notebook_runtime_request_object
13721
+ command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
13722
+ command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
13723
+ command.params['parent'] = parent unless parent.nil?
13724
+ command.query['fields'] = fields unless fields.nil?
13725
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
13726
+ execute_or_queue_command(command, &block)
13727
+ end
13728
+
13729
+ # Deletes a NotebookRuntime.
13730
+ # @param [String] name
13731
+ # Required. The name of the NotebookRuntime resource to be deleted. Instead of
13732
+ # checking whether the name is in valid NotebookRuntime resource name format,
13733
+ # directly throw NotFound exception if there is no such NotebookRuntime in
13734
+ # spanner.
13735
+ # @param [String] fields
13736
+ # Selector specifying which fields to include in a partial response.
13737
+ # @param [String] quota_user
13738
+ # Available to use for quota purposes for server-side applications. Can be any
13739
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
13740
+ # @param [Google::Apis::RequestOptions] options
13741
+ # Request-specific options
13742
+ #
13743
+ # @yield [result, err] Result & error if block supplied
13744
+ # @yieldparam result [Google::Apis::AiplatformV1::GoogleLongrunningOperation] parsed result object
13745
+ # @yieldparam err [StandardError] error object if request failed
13746
+ #
13747
+ # @return [Google::Apis::AiplatformV1::GoogleLongrunningOperation]
13748
+ #
13749
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
13750
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
13751
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
13752
+ def delete_project_location_notebook_runtime(name, fields: nil, quota_user: nil, options: nil, &block)
13753
+ command = make_simple_command(:delete, 'v1/{+name}', options)
13754
+ command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
13755
+ command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
13756
+ command.params['name'] = name unless name.nil?
13757
+ command.query['fields'] = fields unless fields.nil?
13758
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
13759
+ execute_or_queue_command(command, &block)
13760
+ end
13761
+
13762
+ # Gets a NotebookRuntime.
13763
+ # @param [String] name
13764
+ # Required. The name of the NotebookRuntime resource. Instead of checking
13765
+ # whether the name is in valid NotebookRuntime resource name format, directly
13766
+ # throw NotFound exception if there is no such NotebookRuntime in spanner.
13767
+ # @param [String] fields
13768
+ # Selector specifying which fields to include in a partial response.
13769
+ # @param [String] quota_user
13770
+ # Available to use for quota purposes for server-side applications. Can be any
13771
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
13772
+ # @param [Google::Apis::RequestOptions] options
13773
+ # Request-specific options
13774
+ #
13775
+ # @yield [result, err] Result & error if block supplied
13776
+ # @yieldparam result [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NotebookRuntime] parsed result object
13777
+ # @yieldparam err [StandardError] error object if request failed
13778
+ #
13779
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NotebookRuntime]
13780
+ #
13781
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
13782
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
13783
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
13784
+ def get_project_location_notebook_runtime(name, fields: nil, quota_user: nil, options: nil, &block)
13785
+ command = make_simple_command(:get, 'v1/{+name}', options)
13786
+ command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NotebookRuntime::Representation
13787
+ command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NotebookRuntime
13788
+ command.params['name'] = name unless name.nil?
13789
+ command.query['fields'] = fields unless fields.nil?
13790
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
13791
+ execute_or_queue_command(command, &block)
13792
+ end
13793
+
13794
+ # Lists NotebookRuntimes in a Location.
13795
+ # @param [String] parent
13796
+ # Required. The resource name of the Location from which to list the
13797
+ # NotebookRuntimes. Format: `projects/`project`/locations/`location``
13798
+ # @param [String] filter
13799
+ # Optional. An expression for filtering the results of the request. For field
13800
+ # names both snake_case and camelCase are supported. * `notebookRuntime`
13801
+ # supports = and !=. `notebookRuntime` represents the NotebookRuntime ID, i.e.
13802
+ # the last segment of the NotebookRuntime's resource name. * `displayName`
13437
13803
  # supports = and != and regex. * `notebookRuntimeTemplate` supports = and !=. `
13438
13804
  # notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the
13439
13805
  # last segment of the NotebookRuntimeTemplate's resource name. * `healthState`
@@ -13568,6 +13934,189 @@ module Google
13568
13934
  execute_or_queue_command(command, &block)
13569
13935
  end
13570
13936
 
13937
+ # Starts asynchronous cancellation on a long-running operation. The server makes
13938
+ # a best effort to cancel the operation, but success is not guaranteed. If the
13939
+ # server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
13940
+ # Clients can use Operations.GetOperation or other methods to check whether the
13941
+ # cancellation succeeded or whether the operation completed despite cancellation.
13942
+ # On successful cancellation, the operation is not deleted; instead, it becomes
13943
+ # an operation with an Operation.error value with a google.rpc.Status.code of 1,
13944
+ # corresponding to `Code.CANCELLED`.
13945
+ # @param [String] name
13946
+ # The name of the operation resource to be cancelled.
13947
+ # @param [String] fields
13948
+ # Selector specifying which fields to include in a partial response.
13949
+ # @param [String] quota_user
13950
+ # Available to use for quota purposes for server-side applications. Can be any
13951
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
13952
+ # @param [Google::Apis::RequestOptions] options
13953
+ # Request-specific options
13954
+ #
13955
+ # @yield [result, err] Result & error if block supplied
13956
+ # @yieldparam result [Google::Apis::AiplatformV1::GoogleProtobufEmpty] parsed result object
13957
+ # @yieldparam err [StandardError] error object if request failed
13958
+ #
13959
+ # @return [Google::Apis::AiplatformV1::GoogleProtobufEmpty]
13960
+ #
13961
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
13962
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
13963
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
13964
+ def cancel_project_location_notebook_runtime_operation(name, fields: nil, quota_user: nil, options: nil, &block)
13965
+ command = make_simple_command(:post, 'v1/{+name}:cancel', options)
13966
+ command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
13967
+ command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
13968
+ command.params['name'] = name unless name.nil?
13969
+ command.query['fields'] = fields unless fields.nil?
13970
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
13971
+ execute_or_queue_command(command, &block)
13972
+ end
13973
+
13974
+ # Deletes a long-running operation. This method indicates that the client is no
13975
+ # longer interested in the operation result. It does not cancel the operation.
13976
+ # If the server doesn't support this method, it returns `google.rpc.Code.
13977
+ # UNIMPLEMENTED`.
13978
+ # @param [String] name
13979
+ # The name of the operation resource to be deleted.
13980
+ # @param [String] fields
13981
+ # Selector specifying which fields to include in a partial response.
13982
+ # @param [String] quota_user
13983
+ # Available to use for quota purposes for server-side applications. Can be any
13984
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
13985
+ # @param [Google::Apis::RequestOptions] options
13986
+ # Request-specific options
13987
+ #
13988
+ # @yield [result, err] Result & error if block supplied
13989
+ # @yieldparam result [Google::Apis::AiplatformV1::GoogleProtobufEmpty] parsed result object
13990
+ # @yieldparam err [StandardError] error object if request failed
13991
+ #
13992
+ # @return [Google::Apis::AiplatformV1::GoogleProtobufEmpty]
13993
+ #
13994
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
13995
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
13996
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
13997
+ def delete_project_location_notebook_runtime_operation(name, fields: nil, quota_user: nil, options: nil, &block)
13998
+ command = make_simple_command(:delete, 'v1/{+name}', options)
13999
+ command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
14000
+ command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
14001
+ command.params['name'] = name unless name.nil?
14002
+ command.query['fields'] = fields unless fields.nil?
14003
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
14004
+ execute_or_queue_command(command, &block)
14005
+ end
14006
+
14007
+ # Gets the latest state of a long-running operation. Clients can use this method
14008
+ # to poll the operation result at intervals as recommended by the API service.
14009
+ # @param [String] name
14010
+ # The name of the operation resource.
14011
+ # @param [String] fields
14012
+ # Selector specifying which fields to include in a partial response.
14013
+ # @param [String] quota_user
14014
+ # Available to use for quota purposes for server-side applications. Can be any
14015
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
14016
+ # @param [Google::Apis::RequestOptions] options
14017
+ # Request-specific options
14018
+ #
14019
+ # @yield [result, err] Result & error if block supplied
14020
+ # @yieldparam result [Google::Apis::AiplatformV1::GoogleLongrunningOperation] parsed result object
14021
+ # @yieldparam err [StandardError] error object if request failed
14022
+ #
14023
+ # @return [Google::Apis::AiplatformV1::GoogleLongrunningOperation]
14024
+ #
14025
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
14026
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
14027
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
14028
+ def get_project_location_notebook_runtime_operation(name, fields: nil, quota_user: nil, options: nil, &block)
14029
+ command = make_simple_command(:get, 'v1/{+name}', options)
14030
+ command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
14031
+ command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
14032
+ command.params['name'] = name unless name.nil?
14033
+ command.query['fields'] = fields unless fields.nil?
14034
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
14035
+ execute_or_queue_command(command, &block)
14036
+ end
14037
+
14038
+ # Lists operations that match the specified filter in the request. If the server
14039
+ # doesn't support this method, it returns `UNIMPLEMENTED`.
14040
+ # @param [String] name
14041
+ # The name of the operation's parent resource.
14042
+ # @param [String] filter
14043
+ # The standard list filter.
14044
+ # @param [Fixnum] page_size
14045
+ # The standard list page size.
14046
+ # @param [String] page_token
14047
+ # The standard list page token.
14048
+ # @param [String] fields
14049
+ # Selector specifying which fields to include in a partial response.
14050
+ # @param [String] quota_user
14051
+ # Available to use for quota purposes for server-side applications. Can be any
14052
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
14053
+ # @param [Google::Apis::RequestOptions] options
14054
+ # Request-specific options
14055
+ #
14056
+ # @yield [result, err] Result & error if block supplied
14057
+ # @yieldparam result [Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse] parsed result object
14058
+ # @yieldparam err [StandardError] error object if request failed
14059
+ #
14060
+ # @return [Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse]
14061
+ #
14062
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
14063
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
14064
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
14065
+ def list_project_location_notebook_runtime_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
14066
+ command = make_simple_command(:get, 'v1/{+name}/operations', options)
14067
+ command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse::Representation
14068
+ command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse
14069
+ command.params['name'] = name unless name.nil?
14070
+ command.query['filter'] = filter unless filter.nil?
14071
+ command.query['pageSize'] = page_size unless page_size.nil?
14072
+ command.query['pageToken'] = page_token unless page_token.nil?
14073
+ command.query['fields'] = fields unless fields.nil?
14074
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
14075
+ execute_or_queue_command(command, &block)
14076
+ end
14077
+
14078
+ # Waits until the specified long-running operation is done or reaches at most a
14079
+ # specified timeout, returning the latest state. If the operation is already
14080
+ # done, the latest state is immediately returned. If the timeout specified is
14081
+ # greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If
14082
+ # the server does not support this method, it returns `google.rpc.Code.
14083
+ # UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return
14084
+ # the latest state before the specified timeout (including immediately), meaning
14085
+ # even an immediate response is no guarantee that the operation is done.
14086
+ # @param [String] name
14087
+ # The name of the operation resource to wait on.
14088
+ # @param [String] timeout
14089
+ # The maximum duration to wait before timing out. If left blank, the wait will
14090
+ # be at most the time permitted by the underlying HTTP/RPC protocol. If RPC
14091
+ # context deadline is also specified, the shorter one will be used.
14092
+ # @param [String] fields
14093
+ # Selector specifying which fields to include in a partial response.
14094
+ # @param [String] quota_user
14095
+ # Available to use for quota purposes for server-side applications. Can be any
14096
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
14097
+ # @param [Google::Apis::RequestOptions] options
14098
+ # Request-specific options
14099
+ #
14100
+ # @yield [result, err] Result & error if block supplied
14101
+ # @yieldparam result [Google::Apis::AiplatformV1::GoogleLongrunningOperation] parsed result object
14102
+ # @yieldparam err [StandardError] error object if request failed
14103
+ #
14104
+ # @return [Google::Apis::AiplatformV1::GoogleLongrunningOperation]
14105
+ #
14106
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
14107
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
14108
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
14109
+ def wait_project_location_notebook_runtime_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
14110
+ command = make_simple_command(:post, 'v1/{+name}:wait', options)
14111
+ command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
14112
+ command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
14113
+ command.params['name'] = name unless name.nil?
14114
+ command.query['timeout'] = timeout unless timeout.nil?
14115
+ command.query['fields'] = fields unless fields.nil?
14116
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
14117
+ execute_or_queue_command(command, &block)
14118
+ end
14119
+
13571
14120
  # Starts asynchronous cancellation on a long-running operation. The server makes
13572
14121
  # a best effort to cancel the operation, but success is not guaranteed. If the
13573
14122
  # server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.