google-apis-aiplatform_v1beta1 0.30.0 → 0.31.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -998,8 +998,9 @@ module Google
998
998
 
999
999
  # Updates cached content configurations
1000
1000
  # @param [String] name
1001
- # Immutable. Identifier. The resource name of the cached content Format:
1002
- # projects/`project`/locations/`location`/cachedContents/`cached_content`
1001
+ # Immutable. Identifier. The server-generated resource name of the cached
1002
+ # content Format: projects/`project`/locations/`location`/cachedContents/`
1003
+ # cached_content`
1003
1004
  # @param [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CachedContent] google_cloud_aiplatform_v1beta1_cached_content_object
1004
1005
  # @param [String] update_mask
1005
1006
  # Required. The list of fields to update.
@@ -16079,6 +16080,189 @@ module Google
16079
16080
  execute_or_queue_command(command, &block)
16080
16081
  end
16081
16082
 
16083
+ # Starts asynchronous cancellation on a long-running operation. The server makes
16084
+ # a best effort to cancel the operation, but success is not guaranteed. If the
16085
+ # server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
16086
+ # Clients can use Operations.GetOperation or other methods to check whether the
16087
+ # cancellation succeeded or whether the operation completed despite cancellation.
16088
+ # On successful cancellation, the operation is not deleted; instead, it becomes
16089
+ # an operation with an Operation.error value with a google.rpc.Status.code of 1,
16090
+ # corresponding to `Code.CANCELLED`.
16091
+ # @param [String] name
16092
+ # The name of the operation resource to be cancelled.
16093
+ # @param [String] fields
16094
+ # Selector specifying which fields to include in a partial response.
16095
+ # @param [String] quota_user
16096
+ # Available to use for quota purposes for server-side applications. Can be any
16097
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
16098
+ # @param [Google::Apis::RequestOptions] options
16099
+ # Request-specific options
16100
+ #
16101
+ # @yield [result, err] Result & error if block supplied
16102
+ # @yieldparam result [Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty] parsed result object
16103
+ # @yieldparam err [StandardError] error object if request failed
16104
+ #
16105
+ # @return [Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty]
16106
+ #
16107
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
16108
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
16109
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
16110
+ def cancel_project_location_notebook_execution_job_operation(name, fields: nil, quota_user: nil, options: nil, &block)
16111
+ command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
16112
+ command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
16113
+ command.response_class = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty
16114
+ command.params['name'] = name unless name.nil?
16115
+ command.query['fields'] = fields unless fields.nil?
16116
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
16117
+ execute_or_queue_command(command, &block)
16118
+ end
16119
+
16120
+ # Deletes a long-running operation. This method indicates that the client is no
16121
+ # longer interested in the operation result. It does not cancel the operation.
16122
+ # If the server doesn't support this method, it returns `google.rpc.Code.
16123
+ # UNIMPLEMENTED`.
16124
+ # @param [String] name
16125
+ # The name of the operation resource to be deleted.
16126
+ # @param [String] fields
16127
+ # Selector specifying which fields to include in a partial response.
16128
+ # @param [String] quota_user
16129
+ # Available to use for quota purposes for server-side applications. Can be any
16130
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
16131
+ # @param [Google::Apis::RequestOptions] options
16132
+ # Request-specific options
16133
+ #
16134
+ # @yield [result, err] Result & error if block supplied
16135
+ # @yieldparam result [Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty] parsed result object
16136
+ # @yieldparam err [StandardError] error object if request failed
16137
+ #
16138
+ # @return [Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty]
16139
+ #
16140
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
16141
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
16142
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
16143
+ def delete_project_location_notebook_execution_job_operation(name, fields: nil, quota_user: nil, options: nil, &block)
16144
+ command = make_simple_command(:delete, 'v1beta1/{+name}', options)
16145
+ command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
16146
+ command.response_class = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty
16147
+ command.params['name'] = name unless name.nil?
16148
+ command.query['fields'] = fields unless fields.nil?
16149
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
16150
+ execute_or_queue_command(command, &block)
16151
+ end
16152
+
16153
+ # Gets the latest state of a long-running operation. Clients can use this method
16154
+ # to poll the operation result at intervals as recommended by the API service.
16155
+ # @param [String] name
16156
+ # The name of the operation resource.
16157
+ # @param [String] fields
16158
+ # Selector specifying which fields to include in a partial response.
16159
+ # @param [String] quota_user
16160
+ # Available to use for quota purposes for server-side applications. Can be any
16161
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
16162
+ # @param [Google::Apis::RequestOptions] options
16163
+ # Request-specific options
16164
+ #
16165
+ # @yield [result, err] Result & error if block supplied
16166
+ # @yieldparam result [Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation] parsed result object
16167
+ # @yieldparam err [StandardError] error object if request failed
16168
+ #
16169
+ # @return [Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation]
16170
+ #
16171
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
16172
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
16173
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
16174
+ def get_project_location_notebook_execution_job_operation(name, fields: nil, quota_user: nil, options: nil, &block)
16175
+ command = make_simple_command(:get, 'v1beta1/{+name}', options)
16176
+ command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
16177
+ command.response_class = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation
16178
+ command.params['name'] = name unless name.nil?
16179
+ command.query['fields'] = fields unless fields.nil?
16180
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
16181
+ execute_or_queue_command(command, &block)
16182
+ end
16183
+
16184
+ # Lists operations that match the specified filter in the request. If the server
16185
+ # doesn't support this method, it returns `UNIMPLEMENTED`.
16186
+ # @param [String] name
16187
+ # The name of the operation's parent resource.
16188
+ # @param [String] filter
16189
+ # The standard list filter.
16190
+ # @param [Fixnum] page_size
16191
+ # The standard list page size.
16192
+ # @param [String] page_token
16193
+ # The standard list page token.
16194
+ # @param [String] fields
16195
+ # Selector specifying which fields to include in a partial response.
16196
+ # @param [String] quota_user
16197
+ # Available to use for quota purposes for server-side applications. Can be any
16198
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
16199
+ # @param [Google::Apis::RequestOptions] options
16200
+ # Request-specific options
16201
+ #
16202
+ # @yield [result, err] Result & error if block supplied
16203
+ # @yieldparam result [Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse] parsed result object
16204
+ # @yieldparam err [StandardError] error object if request failed
16205
+ #
16206
+ # @return [Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse]
16207
+ #
16208
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
16209
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
16210
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
16211
+ 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)
16212
+ command = make_simple_command(:get, 'v1beta1/{+name}/operations', options)
16213
+ command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse::Representation
16214
+ command.response_class = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse
16215
+ command.params['name'] = name unless name.nil?
16216
+ command.query['filter'] = filter unless filter.nil?
16217
+ command.query['pageSize'] = page_size unless page_size.nil?
16218
+ command.query['pageToken'] = page_token unless page_token.nil?
16219
+ command.query['fields'] = fields unless fields.nil?
16220
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
16221
+ execute_or_queue_command(command, &block)
16222
+ end
16223
+
16224
+ # Waits until the specified long-running operation is done or reaches at most a
16225
+ # specified timeout, returning the latest state. If the operation is already
16226
+ # done, the latest state is immediately returned. If the timeout specified is
16227
+ # greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If
16228
+ # the server does not support this method, it returns `google.rpc.Code.
16229
+ # UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return
16230
+ # the latest state before the specified timeout (including immediately), meaning
16231
+ # even an immediate response is no guarantee that the operation is done.
16232
+ # @param [String] name
16233
+ # The name of the operation resource to wait on.
16234
+ # @param [String] timeout
16235
+ # The maximum duration to wait before timing out. If left blank, the wait will
16236
+ # be at most the time permitted by the underlying HTTP/RPC protocol. If RPC
16237
+ # context deadline is also specified, the shorter one will be used.
16238
+ # @param [String] fields
16239
+ # Selector specifying which fields to include in a partial response.
16240
+ # @param [String] quota_user
16241
+ # Available to use for quota purposes for server-side applications. Can be any
16242
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
16243
+ # @param [Google::Apis::RequestOptions] options
16244
+ # Request-specific options
16245
+ #
16246
+ # @yield [result, err] Result & error if block supplied
16247
+ # @yieldparam result [Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation] parsed result object
16248
+ # @yieldparam err [StandardError] error object if request failed
16249
+ #
16250
+ # @return [Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation]
16251
+ #
16252
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
16253
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
16254
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
16255
+ def wait_project_location_notebook_execution_job_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
16256
+ command = make_simple_command(:post, 'v1beta1/{+name}:wait', options)
16257
+ command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
16258
+ command.response_class = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation
16259
+ command.params['name'] = name unless name.nil?
16260
+ command.query['timeout'] = timeout unless timeout.nil?
16261
+ command.query['fields'] = fields unless fields.nil?
16262
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
16263
+ execute_or_queue_command(command, &block)
16264
+ end
16265
+
16082
16266
  # Creates a NotebookRuntimeTemplate.
16083
16267
  # @param [String] parent
16084
16268
  # Required. The resource name of the Location to create the
@@ -16402,12 +16586,16 @@ module Google
16402
16586
  execute_or_queue_command(command, &block)
16403
16587
  end
16404
16588
 
16405
- # Assigns a NotebookRuntime to a user for a particular Notebook file. This
16406
- # method will either returns an existing assignment or generates a new one.
16407
- # @param [String] parent
16408
- # Required. The resource name of the Location to get the NotebookRuntime
16409
- # assignment. Format: `projects/`project`/locations/`location``
16410
- # @param [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1AssignNotebookRuntimeRequest] google_cloud_aiplatform_v1beta1_assign_notebook_runtime_request_object
16589
+ # Starts asynchronous cancellation on a long-running operation. The server makes
16590
+ # a best effort to cancel the operation, but success is not guaranteed. If the
16591
+ # server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
16592
+ # Clients can use Operations.GetOperation or other methods to check whether the
16593
+ # cancellation succeeded or whether the operation completed despite cancellation.
16594
+ # On successful cancellation, the operation is not deleted; instead, it becomes
16595
+ # an operation with an Operation.error value with a google.rpc.Status.code of 1,
16596
+ # corresponding to `Code.CANCELLED`.
16597
+ # @param [String] name
16598
+ # The name of the operation resource to be cancelled.
16411
16599
  # @param [String] fields
16412
16600
  # Selector specifying which fields to include in a partial response.
16413
16601
  # @param [String] quota_user
@@ -16417,32 +16605,30 @@ module Google
16417
16605
  # Request-specific options
16418
16606
  #
16419
16607
  # @yield [result, err] Result & error if block supplied
16420
- # @yieldparam result [Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation] parsed result object
16608
+ # @yieldparam result [Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty] parsed result object
16421
16609
  # @yieldparam err [StandardError] error object if request failed
16422
16610
  #
16423
- # @return [Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation]
16611
+ # @return [Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty]
16424
16612
  #
16425
16613
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
16426
16614
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
16427
16615
  # @raise [Google::Apis::AuthorizationError] Authorization is required
16428
- def assign_project_location_notebook_runtime(parent, google_cloud_aiplatform_v1beta1_assign_notebook_runtime_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
16429
- command = make_simple_command(:post, 'v1beta1/{+parent}/notebookRuntimes:assign', options)
16430
- command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1AssignNotebookRuntimeRequest::Representation
16431
- command.request_object = google_cloud_aiplatform_v1beta1_assign_notebook_runtime_request_object
16432
- command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
16433
- command.response_class = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation
16434
- command.params['parent'] = parent unless parent.nil?
16616
+ def cancel_project_location_notebook_runtime_template_operation(name, fields: nil, quota_user: nil, options: nil, &block)
16617
+ command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
16618
+ command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
16619
+ command.response_class = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty
16620
+ command.params['name'] = name unless name.nil?
16435
16621
  command.query['fields'] = fields unless fields.nil?
16436
16622
  command.query['quotaUser'] = quota_user unless quota_user.nil?
16437
16623
  execute_or_queue_command(command, &block)
16438
16624
  end
16439
16625
 
16440
- # Deletes a NotebookRuntime.
16626
+ # Deletes a long-running operation. This method indicates that the client is no
16627
+ # longer interested in the operation result. It does not cancel the operation.
16628
+ # If the server doesn't support this method, it returns `google.rpc.Code.
16629
+ # UNIMPLEMENTED`.
16441
16630
  # @param [String] name
16442
- # Required. The name of the NotebookRuntime resource to be deleted. Instead of
16443
- # checking whether the name is in valid NotebookRuntime resource name format,
16444
- # directly throw NotFound exception if there is no such NotebookRuntime in
16445
- # spanner.
16631
+ # The name of the operation resource to be deleted.
16446
16632
  # @param [String] fields
16447
16633
  # Selector specifying which fields to include in a partial response.
16448
16634
  # @param [String] quota_user
@@ -16452,33 +16638,28 @@ module Google
16452
16638
  # Request-specific options
16453
16639
  #
16454
16640
  # @yield [result, err] Result & error if block supplied
16455
- # @yieldparam result [Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation] parsed result object
16641
+ # @yieldparam result [Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty] parsed result object
16456
16642
  # @yieldparam err [StandardError] error object if request failed
16457
16643
  #
16458
- # @return [Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation]
16644
+ # @return [Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty]
16459
16645
  #
16460
16646
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
16461
16647
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
16462
16648
  # @raise [Google::Apis::AuthorizationError] Authorization is required
16463
- def delete_project_location_notebook_runtime(name, fields: nil, quota_user: nil, options: nil, &block)
16649
+ def delete_project_location_notebook_runtime_template_operation(name, fields: nil, quota_user: nil, options: nil, &block)
16464
16650
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
16465
- command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
16466
- command.response_class = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation
16651
+ command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
16652
+ command.response_class = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty
16467
16653
  command.params['name'] = name unless name.nil?
16468
16654
  command.query['fields'] = fields unless fields.nil?
16469
16655
  command.query['quotaUser'] = quota_user unless quota_user.nil?
16470
16656
  execute_or_queue_command(command, &block)
16471
16657
  end
16472
16658
 
16473
- # Internal only: Called from Compute Engine instance to obtain EUC for owner
16474
- # Anonymous access: authenticates caller using VM identity JWT. Design doc: go/
16475
- # colab-on-vertex-euc-dd
16659
+ # Gets the latest state of a long-running operation. Clients can use this method
16660
+ # to poll the operation result at intervals as recommended by the API service.
16476
16661
  # @param [String] name
16477
- # Required. The name of the resource requesting the OAuth2 token. Format: `
16478
- # projects/`project`/locations/`location`/notebookRuntimes/`notebook_runtime`` `
16479
- # projects/`project`/locations/`location`/notebookExecutionJobs/`
16480
- # notebook_execution_job``
16481
- # @param [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerateAccessTokenRequest] google_cloud_aiplatform_v1beta1_generate_access_token_request_object
16662
+ # The name of the operation resource.
16482
16663
  # @param [String] fields
16483
16664
  # Selector specifying which fields to include in a partial response.
16484
16665
  # @param [String] quota_user
@@ -16488,29 +16669,215 @@ module Google
16488
16669
  # Request-specific options
16489
16670
  #
16490
16671
  # @yield [result, err] Result & error if block supplied
16491
- # @yieldparam result [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerateAccessTokenResponse] parsed result object
16672
+ # @yieldparam result [Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation] parsed result object
16492
16673
  # @yieldparam err [StandardError] error object if request failed
16493
16674
  #
16494
- # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerateAccessTokenResponse]
16675
+ # @return [Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation]
16495
16676
  #
16496
16677
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
16497
16678
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
16498
16679
  # @raise [Google::Apis::AuthorizationError] Authorization is required
16499
- def generate_project_location_notebook_runtime_access_token(name, google_cloud_aiplatform_v1beta1_generate_access_token_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
16500
- command = make_simple_command(:post, 'v1beta1/{+name}:generateAccessToken', options)
16501
- command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerateAccessTokenRequest::Representation
16502
- command.request_object = google_cloud_aiplatform_v1beta1_generate_access_token_request_object
16503
- command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerateAccessTokenResponse::Representation
16504
- command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerateAccessTokenResponse
16680
+ def get_project_location_notebook_runtime_template_operation(name, fields: nil, quota_user: nil, options: nil, &block)
16681
+ command = make_simple_command(:get, 'v1beta1/{+name}', options)
16682
+ command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
16683
+ command.response_class = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation
16505
16684
  command.params['name'] = name unless name.nil?
16506
16685
  command.query['fields'] = fields unless fields.nil?
16507
16686
  command.query['quotaUser'] = quota_user unless quota_user.nil?
16508
16687
  execute_or_queue_command(command, &block)
16509
16688
  end
16510
16689
 
16511
- # Gets a NotebookRuntime.
16690
+ # Lists operations that match the specified filter in the request. If the server
16691
+ # doesn't support this method, it returns `UNIMPLEMENTED`.
16512
16692
  # @param [String] name
16513
- # Required. The name of the NotebookRuntime resource. Instead of checking
16693
+ # The name of the operation's parent resource.
16694
+ # @param [String] filter
16695
+ # The standard list filter.
16696
+ # @param [Fixnum] page_size
16697
+ # The standard list page size.
16698
+ # @param [String] page_token
16699
+ # The standard list page token.
16700
+ # @param [String] fields
16701
+ # Selector specifying which fields to include in a partial response.
16702
+ # @param [String] quota_user
16703
+ # Available to use for quota purposes for server-side applications. Can be any
16704
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
16705
+ # @param [Google::Apis::RequestOptions] options
16706
+ # Request-specific options
16707
+ #
16708
+ # @yield [result, err] Result & error if block supplied
16709
+ # @yieldparam result [Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse] parsed result object
16710
+ # @yieldparam err [StandardError] error object if request failed
16711
+ #
16712
+ # @return [Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse]
16713
+ #
16714
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
16715
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
16716
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
16717
+ 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)
16718
+ command = make_simple_command(:get, 'v1beta1/{+name}/operations', options)
16719
+ command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse::Representation
16720
+ command.response_class = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse
16721
+ command.params['name'] = name unless name.nil?
16722
+ command.query['filter'] = filter unless filter.nil?
16723
+ command.query['pageSize'] = page_size unless page_size.nil?
16724
+ command.query['pageToken'] = page_token unless page_token.nil?
16725
+ command.query['fields'] = fields unless fields.nil?
16726
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
16727
+ execute_or_queue_command(command, &block)
16728
+ end
16729
+
16730
+ # Waits until the specified long-running operation is done or reaches at most a
16731
+ # specified timeout, returning the latest state. If the operation is already
16732
+ # done, the latest state is immediately returned. If the timeout specified is
16733
+ # greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If
16734
+ # the server does not support this method, it returns `google.rpc.Code.
16735
+ # UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return
16736
+ # the latest state before the specified timeout (including immediately), meaning
16737
+ # even an immediate response is no guarantee that the operation is done.
16738
+ # @param [String] name
16739
+ # The name of the operation resource to wait on.
16740
+ # @param [String] timeout
16741
+ # The maximum duration to wait before timing out. If left blank, the wait will
16742
+ # be at most the time permitted by the underlying HTTP/RPC protocol. If RPC
16743
+ # context deadline is also specified, the shorter one will be used.
16744
+ # @param [String] fields
16745
+ # Selector specifying which fields to include in a partial response.
16746
+ # @param [String] quota_user
16747
+ # Available to use for quota purposes for server-side applications. Can be any
16748
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
16749
+ # @param [Google::Apis::RequestOptions] options
16750
+ # Request-specific options
16751
+ #
16752
+ # @yield [result, err] Result & error if block supplied
16753
+ # @yieldparam result [Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation] parsed result object
16754
+ # @yieldparam err [StandardError] error object if request failed
16755
+ #
16756
+ # @return [Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation]
16757
+ #
16758
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
16759
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
16760
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
16761
+ def wait_project_location_notebook_runtime_template_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
16762
+ command = make_simple_command(:post, 'v1beta1/{+name}:wait', options)
16763
+ command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
16764
+ command.response_class = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation
16765
+ command.params['name'] = name unless name.nil?
16766
+ command.query['timeout'] = timeout unless timeout.nil?
16767
+ command.query['fields'] = fields unless fields.nil?
16768
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
16769
+ execute_or_queue_command(command, &block)
16770
+ end
16771
+
16772
+ # Assigns a NotebookRuntime to a user for a particular Notebook file. This
16773
+ # method will either returns an existing assignment or generates a new one.
16774
+ # @param [String] parent
16775
+ # Required. The resource name of the Location to get the NotebookRuntime
16776
+ # assignment. Format: `projects/`project`/locations/`location``
16777
+ # @param [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1AssignNotebookRuntimeRequest] google_cloud_aiplatform_v1beta1_assign_notebook_runtime_request_object
16778
+ # @param [String] fields
16779
+ # Selector specifying which fields to include in a partial response.
16780
+ # @param [String] quota_user
16781
+ # Available to use for quota purposes for server-side applications. Can be any
16782
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
16783
+ # @param [Google::Apis::RequestOptions] options
16784
+ # Request-specific options
16785
+ #
16786
+ # @yield [result, err] Result & error if block supplied
16787
+ # @yieldparam result [Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation] parsed result object
16788
+ # @yieldparam err [StandardError] error object if request failed
16789
+ #
16790
+ # @return [Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation]
16791
+ #
16792
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
16793
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
16794
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
16795
+ def assign_project_location_notebook_runtime(parent, google_cloud_aiplatform_v1beta1_assign_notebook_runtime_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
16796
+ command = make_simple_command(:post, 'v1beta1/{+parent}/notebookRuntimes:assign', options)
16797
+ command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1AssignNotebookRuntimeRequest::Representation
16798
+ command.request_object = google_cloud_aiplatform_v1beta1_assign_notebook_runtime_request_object
16799
+ command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
16800
+ command.response_class = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation
16801
+ command.params['parent'] = parent unless parent.nil?
16802
+ command.query['fields'] = fields unless fields.nil?
16803
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
16804
+ execute_or_queue_command(command, &block)
16805
+ end
16806
+
16807
+ # Deletes a NotebookRuntime.
16808
+ # @param [String] name
16809
+ # Required. The name of the NotebookRuntime resource to be deleted. Instead of
16810
+ # checking whether the name is in valid NotebookRuntime resource name format,
16811
+ # directly throw NotFound exception if there is no such NotebookRuntime in
16812
+ # spanner.
16813
+ # @param [String] fields
16814
+ # Selector specifying which fields to include in a partial response.
16815
+ # @param [String] quota_user
16816
+ # Available to use for quota purposes for server-side applications. Can be any
16817
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
16818
+ # @param [Google::Apis::RequestOptions] options
16819
+ # Request-specific options
16820
+ #
16821
+ # @yield [result, err] Result & error if block supplied
16822
+ # @yieldparam result [Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation] parsed result object
16823
+ # @yieldparam err [StandardError] error object if request failed
16824
+ #
16825
+ # @return [Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation]
16826
+ #
16827
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
16828
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
16829
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
16830
+ def delete_project_location_notebook_runtime(name, fields: nil, quota_user: nil, options: nil, &block)
16831
+ command = make_simple_command(:delete, 'v1beta1/{+name}', options)
16832
+ command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
16833
+ command.response_class = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation
16834
+ command.params['name'] = name unless name.nil?
16835
+ command.query['fields'] = fields unless fields.nil?
16836
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
16837
+ execute_or_queue_command(command, &block)
16838
+ end
16839
+
16840
+ # Internal only: Called from Compute Engine instance to obtain EUC for owner
16841
+ # Anonymous access: authenticates caller using VM identity JWT. Design doc: go/
16842
+ # colab-on-vertex-euc-dd
16843
+ # @param [String] name
16844
+ # Required. The name of the resource requesting the OAuth2 token. Format: `
16845
+ # projects/`project`/locations/`location`/notebookRuntimes/`notebook_runtime`` `
16846
+ # projects/`project`/locations/`location`/notebookExecutionJobs/`
16847
+ # notebook_execution_job``
16848
+ # @param [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerateAccessTokenRequest] google_cloud_aiplatform_v1beta1_generate_access_token_request_object
16849
+ # @param [String] fields
16850
+ # Selector specifying which fields to include in a partial response.
16851
+ # @param [String] quota_user
16852
+ # Available to use for quota purposes for server-side applications. Can be any
16853
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
16854
+ # @param [Google::Apis::RequestOptions] options
16855
+ # Request-specific options
16856
+ #
16857
+ # @yield [result, err] Result & error if block supplied
16858
+ # @yieldparam result [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerateAccessTokenResponse] parsed result object
16859
+ # @yieldparam err [StandardError] error object if request failed
16860
+ #
16861
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerateAccessTokenResponse]
16862
+ #
16863
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
16864
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
16865
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
16866
+ def generate_project_location_notebook_runtime_access_token(name, google_cloud_aiplatform_v1beta1_generate_access_token_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
16867
+ command = make_simple_command(:post, 'v1beta1/{+name}:generateAccessToken', options)
16868
+ command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerateAccessTokenRequest::Representation
16869
+ command.request_object = google_cloud_aiplatform_v1beta1_generate_access_token_request_object
16870
+ command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerateAccessTokenResponse::Representation
16871
+ command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerateAccessTokenResponse
16872
+ command.params['name'] = name unless name.nil?
16873
+ command.query['fields'] = fields unless fields.nil?
16874
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
16875
+ execute_or_queue_command(command, &block)
16876
+ end
16877
+
16878
+ # Gets a NotebookRuntime.
16879
+ # @param [String] name
16880
+ # Required. The name of the NotebookRuntime resource. Instead of checking
16514
16881
  # whether the name is in valid NotebookRuntime resource name format, directly
16515
16882
  # throw NotFound exception if there is no such NotebookRuntime in spanner.
16516
16883
  # @param [String] fields
@@ -16717,6 +17084,189 @@ module Google
16717
17084
  execute_or_queue_command(command, &block)
16718
17085
  end
16719
17086
 
17087
+ # Starts asynchronous cancellation on a long-running operation. The server makes
17088
+ # a best effort to cancel the operation, but success is not guaranteed. If the
17089
+ # server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
17090
+ # Clients can use Operations.GetOperation or other methods to check whether the
17091
+ # cancellation succeeded or whether the operation completed despite cancellation.
17092
+ # On successful cancellation, the operation is not deleted; instead, it becomes
17093
+ # an operation with an Operation.error value with a google.rpc.Status.code of 1,
17094
+ # corresponding to `Code.CANCELLED`.
17095
+ # @param [String] name
17096
+ # The name of the operation resource to be cancelled.
17097
+ # @param [String] fields
17098
+ # Selector specifying which fields to include in a partial response.
17099
+ # @param [String] quota_user
17100
+ # Available to use for quota purposes for server-side applications. Can be any
17101
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
17102
+ # @param [Google::Apis::RequestOptions] options
17103
+ # Request-specific options
17104
+ #
17105
+ # @yield [result, err] Result & error if block supplied
17106
+ # @yieldparam result [Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty] parsed result object
17107
+ # @yieldparam err [StandardError] error object if request failed
17108
+ #
17109
+ # @return [Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty]
17110
+ #
17111
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
17112
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
17113
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
17114
+ def cancel_project_location_notebook_runtime_operation(name, fields: nil, quota_user: nil, options: nil, &block)
17115
+ command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
17116
+ command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
17117
+ command.response_class = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty
17118
+ command.params['name'] = name unless name.nil?
17119
+ command.query['fields'] = fields unless fields.nil?
17120
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
17121
+ execute_or_queue_command(command, &block)
17122
+ end
17123
+
17124
+ # Deletes a long-running operation. This method indicates that the client is no
17125
+ # longer interested in the operation result. It does not cancel the operation.
17126
+ # If the server doesn't support this method, it returns `google.rpc.Code.
17127
+ # UNIMPLEMENTED`.
17128
+ # @param [String] name
17129
+ # The name of the operation resource to be deleted.
17130
+ # @param [String] fields
17131
+ # Selector specifying which fields to include in a partial response.
17132
+ # @param [String] quota_user
17133
+ # Available to use for quota purposes for server-side applications. Can be any
17134
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
17135
+ # @param [Google::Apis::RequestOptions] options
17136
+ # Request-specific options
17137
+ #
17138
+ # @yield [result, err] Result & error if block supplied
17139
+ # @yieldparam result [Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty] parsed result object
17140
+ # @yieldparam err [StandardError] error object if request failed
17141
+ #
17142
+ # @return [Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty]
17143
+ #
17144
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
17145
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
17146
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
17147
+ def delete_project_location_notebook_runtime_operation(name, fields: nil, quota_user: nil, options: nil, &block)
17148
+ command = make_simple_command(:delete, 'v1beta1/{+name}', options)
17149
+ command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
17150
+ command.response_class = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty
17151
+ command.params['name'] = name unless name.nil?
17152
+ command.query['fields'] = fields unless fields.nil?
17153
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
17154
+ execute_or_queue_command(command, &block)
17155
+ end
17156
+
17157
+ # Gets the latest state of a long-running operation. Clients can use this method
17158
+ # to poll the operation result at intervals as recommended by the API service.
17159
+ # @param [String] name
17160
+ # The name of the operation resource.
17161
+ # @param [String] fields
17162
+ # Selector specifying which fields to include in a partial response.
17163
+ # @param [String] quota_user
17164
+ # Available to use for quota purposes for server-side applications. Can be any
17165
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
17166
+ # @param [Google::Apis::RequestOptions] options
17167
+ # Request-specific options
17168
+ #
17169
+ # @yield [result, err] Result & error if block supplied
17170
+ # @yieldparam result [Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation] parsed result object
17171
+ # @yieldparam err [StandardError] error object if request failed
17172
+ #
17173
+ # @return [Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation]
17174
+ #
17175
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
17176
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
17177
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
17178
+ def get_project_location_notebook_runtime_operation(name, fields: nil, quota_user: nil, options: nil, &block)
17179
+ command = make_simple_command(:get, 'v1beta1/{+name}', options)
17180
+ command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
17181
+ command.response_class = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation
17182
+ command.params['name'] = name unless name.nil?
17183
+ command.query['fields'] = fields unless fields.nil?
17184
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
17185
+ execute_or_queue_command(command, &block)
17186
+ end
17187
+
17188
+ # Lists operations that match the specified filter in the request. If the server
17189
+ # doesn't support this method, it returns `UNIMPLEMENTED`.
17190
+ # @param [String] name
17191
+ # The name of the operation's parent resource.
17192
+ # @param [String] filter
17193
+ # The standard list filter.
17194
+ # @param [Fixnum] page_size
17195
+ # The standard list page size.
17196
+ # @param [String] page_token
17197
+ # The standard list page token.
17198
+ # @param [String] fields
17199
+ # Selector specifying which fields to include in a partial response.
17200
+ # @param [String] quota_user
17201
+ # Available to use for quota purposes for server-side applications. Can be any
17202
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
17203
+ # @param [Google::Apis::RequestOptions] options
17204
+ # Request-specific options
17205
+ #
17206
+ # @yield [result, err] Result & error if block supplied
17207
+ # @yieldparam result [Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse] parsed result object
17208
+ # @yieldparam err [StandardError] error object if request failed
17209
+ #
17210
+ # @return [Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse]
17211
+ #
17212
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
17213
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
17214
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
17215
+ def list_project_location_notebook_runtime_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
17216
+ command = make_simple_command(:get, 'v1beta1/{+name}/operations', options)
17217
+ command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse::Representation
17218
+ command.response_class = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse
17219
+ command.params['name'] = name unless name.nil?
17220
+ command.query['filter'] = filter unless filter.nil?
17221
+ command.query['pageSize'] = page_size unless page_size.nil?
17222
+ command.query['pageToken'] = page_token unless page_token.nil?
17223
+ command.query['fields'] = fields unless fields.nil?
17224
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
17225
+ execute_or_queue_command(command, &block)
17226
+ end
17227
+
17228
+ # Waits until the specified long-running operation is done or reaches at most a
17229
+ # specified timeout, returning the latest state. If the operation is already
17230
+ # done, the latest state is immediately returned. If the timeout specified is
17231
+ # greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If
17232
+ # the server does not support this method, it returns `google.rpc.Code.
17233
+ # UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return
17234
+ # the latest state before the specified timeout (including immediately), meaning
17235
+ # even an immediate response is no guarantee that the operation is done.
17236
+ # @param [String] name
17237
+ # The name of the operation resource to wait on.
17238
+ # @param [String] timeout
17239
+ # The maximum duration to wait before timing out. If left blank, the wait will
17240
+ # be at most the time permitted by the underlying HTTP/RPC protocol. If RPC
17241
+ # context deadline is also specified, the shorter one will be used.
17242
+ # @param [String] fields
17243
+ # Selector specifying which fields to include in a partial response.
17244
+ # @param [String] quota_user
17245
+ # Available to use for quota purposes for server-side applications. Can be any
17246
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
17247
+ # @param [Google::Apis::RequestOptions] options
17248
+ # Request-specific options
17249
+ #
17250
+ # @yield [result, err] Result & error if block supplied
17251
+ # @yieldparam result [Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation] parsed result object
17252
+ # @yieldparam err [StandardError] error object if request failed
17253
+ #
17254
+ # @return [Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation]
17255
+ #
17256
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
17257
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
17258
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
17259
+ def wait_project_location_notebook_runtime_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
17260
+ command = make_simple_command(:post, 'v1beta1/{+name}:wait', options)
17261
+ command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
17262
+ command.response_class = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation
17263
+ command.params['name'] = name unless name.nil?
17264
+ command.query['timeout'] = timeout unless timeout.nil?
17265
+ command.query['fields'] = fields unless fields.nil?
17266
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
17267
+ execute_or_queue_command(command, &block)
17268
+ end
17269
+
16720
17270
  # Starts asynchronous cancellation on a long-running operation. The server makes
16721
17271
  # a best effort to cancel the operation, but success is not guaranteed. If the
16722
17272
  # server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.