Class: Google::Apis::NotebooksV1::AIPlatformNotebooksService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/notebooks_v1/service.rb

Overview

Notebooks API

Notebooks API is used to manage notebook resources in Google Cloud.

Examples:

require 'google/apis/notebooks_v1'

Notebooks = Google::Apis::NotebooksV1 # Alias the module
service = Notebooks::AIPlatformNotebooksService.new

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ AIPlatformNotebooksService

Returns a new instance of AIPlatformNotebooksService.



45
46
47
48
49
50
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 45

def initialize
  super('https://notebooks.googleapis.com/', '',
        client_name: 'google-apis-notebooks_v1',
        client_version: Google::Apis::NotebooksV1::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String) —

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



38
39
40
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 38

def key
  @key
end

#quota_user ⇒ String

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



43
44
45
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 43

def quota_user
  @quota_user
end

Instance Method Details

#cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Empty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

  • name (String) —

    The name of the operation resource to be cancelled.

  • cancel_operation_request_object (Google::Apis::NotebooksV1::CancelOperationRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 1304

def cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.request_representation = Google::Apis::NotebooksV1::CancelOperationRequest::Representation
  command.request_object = cancel_operation_request_object
  command.response_representation = Google::Apis::NotebooksV1::Empty::Representation
  command.response_class = Google::Apis::NotebooksV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_environment(parent, environment_object = nil, environment_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Operation

Creates a new Environment.

Parameters:

  • parent (String) —

    Required. Format: projects/project_id/locations/location``

  • environment_object (Google::Apis::NotebooksV1::Environment) (defaults to: nil)
  • environment_id (String) (defaults to: nil) —

    Required. User-defined unique ID of this environment. The environment_id must be 1 to 63 characters long and contain only lowercase letters, numeric characters, and dashes. The first character must be a lowercase letter and the last character cannot be a dash.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 151

def create_project_location_environment(parent, environment_object = nil, environment_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/environments', options)
  command.request_representation = Google::Apis::NotebooksV1::Environment::Representation
  command.request_object = environment_object
  command.response_representation = Google::Apis::NotebooksV1::Operation::Representation
  command.response_class = Google::Apis::NotebooksV1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['environmentId'] = environment_id unless environment_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_execution(parent, execution_object = nil, execution_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Operation

Creates a new Execution in a given project and location.

Parameters:

  • parent (String) —

    Required. Format: parent=projects/project_id/locations/location``

  • execution_object (Google::Apis::NotebooksV1::Execution) (defaults to: nil)
  • execution_id (String) (defaults to: nil) —

    Required. User-defined unique ID of this execution.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 286

def create_project_location_execution(parent, execution_object = nil, execution_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/executions', options)
  command.request_representation = Google::Apis::NotebooksV1::Execution::Representation
  command.request_object = execution_object
  command.response_representation = Google::Apis::NotebooksV1::Operation::Representation
  command.response_class = Google::Apis::NotebooksV1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['executionId'] = execution_id unless execution_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_instance(parent, instance_object = nil, instance_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Operation

Creates a new Instance in a given project and location.

Parameters:

  • parent (String) —

    Required. Format: parent=projects/project_id/locations/location``

  • instance_object (Google::Apis::NotebooksV1::Instance) (defaults to: nil)
  • instance_id (String) (defaults to: nil) —

    Required. User-defined unique ID of this instance.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



428
429
430
431
432
433
434
435
436
437
438
439
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 428

def create_project_location_instance(parent, instance_object = nil, instance_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/instances', options)
  command.request_representation = Google::Apis::NotebooksV1::Instance::Representation
  command.request_object = instance_object
  command.response_representation = Google::Apis::NotebooksV1::Operation::Representation
  command.response_class = Google::Apis::NotebooksV1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['instanceId'] = instance_id unless instance_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_runtime(parent, runtime_object = nil, request_id: nil, runtime_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Operation

Creates a new Runtime in a given project and location.

Parameters:

  • parent (String) —

    Required. Format: parent=projects/project_id/locations/location``

  • runtime_object (Google::Apis::NotebooksV1::Runtime) (defaults to: nil)
  • request_id (String) (defaults to: nil) —

    Idempotent request UUID.

  • runtime_id (String) (defaults to: nil) —

    Required. User-defined unique ID of this Runtime.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 1445

def create_project_location_runtime(parent, runtime_object = nil, request_id: nil, runtime_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/runtimes', options)
  command.request_representation = Google::Apis::NotebooksV1::Runtime::Representation
  command.request_object = runtime_object
  command.response_representation = Google::Apis::NotebooksV1::Operation::Representation
  command.response_class = Google::Apis::NotebooksV1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['requestId'] = request_id unless request_id.nil?
  command.query['runtimeId'] = runtime_id unless runtime_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_schedule(parent, schedule_object = nil, schedule_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Operation

Creates a new Scheduled Notebook in a given project and location.

Parameters:

  • parent (String) —

    Required. Format: parent=projects/project_id/locations/location``

  • schedule_object (Google::Apis::NotebooksV1::Schedule) (defaults to: nil)
  • schedule_id (String) (defaults to: nil) —

    Required. User-defined unique ID of this schedule.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 2034

def create_project_location_schedule(parent, schedule_object = nil, schedule_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/schedules', options)
  command.request_representation = Google::Apis::NotebooksV1::Schedule::Representation
  command.request_object = schedule_object
  command.response_representation = Google::Apis::NotebooksV1::Operation::Representation
  command.response_class = Google::Apis::NotebooksV1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['scheduleId'] = schedule_id unless schedule_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_environment(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Operation

Deletes a single Environment.

Parameters:

  • name (String) —

    Required. Format: projects/project_id/locations/location/environments/ environment_id``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



185
186
187
188
189
190
191
192
193
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 185

def delete_project_location_environment(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::NotebooksV1::Operation::Representation
  command.response_class = Google::Apis::NotebooksV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_execution(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Operation

Deletes execution

Parameters:

  • name (String) —

    Required. Format: projects/project_id/locations/location/executions/ execution_id``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



320
321
322
323
324
325
326
327
328
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 320

def delete_project_location_execution(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::NotebooksV1::Operation::Representation
  command.response_class = Google::Apis::NotebooksV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_instance(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Operation

Deletes a single Instance.

Parameters:

  • name (String) —

    Required. Format: projects/project_id/locations/location/instances/ instance_id``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



462
463
464
465
466
467
468
469
470
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 462

def delete_project_location_instance(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::NotebooksV1::Operation::Representation
  command.response_class = Google::Apis::NotebooksV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Empty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code. UNIMPLEMENTED.

Parameters:

  • name (String) —

    The name of the operation resource to be deleted.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1339
1340
1341
1342
1343
1344
1345
1346
1347
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 1339

def delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::NotebooksV1::Empty::Representation
  command.response_class = Google::Apis::NotebooksV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_runtime(name, request_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Operation

Deletes a single Runtime.

Parameters:

  • name (String) —

    Required. Format: projects/project_id/locations/location/runtimes/ runtime_id``

  • request_id (String) (defaults to: nil) —

    Idempotent request UUID.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 1482

def delete_project_location_runtime(name, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::NotebooksV1::Operation::Representation
  command.response_class = Google::Apis::NotebooksV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['requestId'] = request_id unless request_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_schedule(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Operation

Deletes schedule and all underlying jobs

Parameters:

  • name (String) —

    Required. Format: projects/project_id/locations/location/schedules/ schedule_id``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2068
2069
2070
2071
2072
2073
2074
2075
2076
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 2068

def delete_project_location_schedule(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::NotebooksV1::Operation::Representation
  command.response_class = Google::Apis::NotebooksV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#diagnose_instance(name, diagnose_instance_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Operation

Creates a Diagnostic File and runs Diagnostic Tool given an Instance.

Parameters:

  • name (String) —

    Required. Format: projects/project_id/locations/location/instances/ instance_id``

  • diagnose_instance_request_object (Google::Apis::NotebooksV1::DiagnoseInstanceRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



494
495
496
497
498
499
500
501
502
503
504
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 494

def diagnose_instance(name, diagnose_instance_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:diagnose', options)
  command.request_representation = Google::Apis::NotebooksV1::DiagnoseInstanceRequest::Representation
  command.request_object = diagnose_instance_request_object
  command.response_representation = Google::Apis::NotebooksV1::Operation::Representation
  command.response_class = Google::Apis::NotebooksV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#diagnose_runtime(name, diagnose_runtime_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Operation

Creates a Diagnostic File and runs Diagnostic Tool given a Runtime.

Parameters:

  • name (String) —

    Required. Format: projects/project_id/locations/location/runtimes/ runtimes_id``

  • diagnose_runtime_request_object (Google::Apis::NotebooksV1::DiagnoseRuntimeRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 1515

def diagnose_runtime(name, diagnose_runtime_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:diagnose', options)
  command.request_representation = Google::Apis::NotebooksV1::DiagnoseRuntimeRequest::Representation
  command.request_object = diagnose_runtime_request_object
  command.response_representation = Google::Apis::NotebooksV1::Operation::Representation
  command.response_class = Google::Apis::NotebooksV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Location

Gets information about a location.

Parameters:

  • name (String) —

    Resource name for the location.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



72
73
74
75
76
77
78
79
80
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 72

def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::NotebooksV1::Location::Representation
  command.response_class = Google::Apis::NotebooksV1::Location
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_environment(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Environment

Gets details of a single Environment.

Parameters:

  • name (String) —

    Required. Format: projects/project_id/locations/location/environments/ environment_id``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



216
217
218
219
220
221
222
223
224
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 216

def get_project_location_environment(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::NotebooksV1::Environment::Representation
  command.response_class = Google::Apis::NotebooksV1::Environment
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_execution(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Execution

Gets details of executions

Parameters:

  • name (String) —

    Required. Format: projects/project_id/locations/location/executions/ execution_id``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



351
352
353
354
355
356
357
358
359
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 351

def get_project_location_execution(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::NotebooksV1::Execution::Representation
  command.response_class = Google::Apis::NotebooksV1::Execution
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_instance(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Instance

Gets details of a single Instance.

Parameters:

  • name (String) —

    Required. Format: projects/project_id/locations/location/instances/ instance_id``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



527
528
529
530
531
532
533
534
535
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 527

def get_project_location_instance(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::NotebooksV1::Instance::Representation
  command.response_class = Google::Apis::NotebooksV1::Instance
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_instance_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Policy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

  • options_requested_policy_version (Fixnum) (defaults to: nil) —

    Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the IAM documentation.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



571
572
573
574
575
576
577
578
579
580
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 571

def get_project_location_instance_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::NotebooksV1::Policy::Representation
  command.response_class = Google::Apis::NotebooksV1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_instance_instance_health(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::GetInstanceHealthResponse

Checks whether a notebook instance is healthy.

Parameters:

  • name (String) —

    Required. Format: projects/project_id/locations/location/instances/ instance_id``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



603
604
605
606
607
608
609
610
611
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 603

def get_project_location_instance_instance_health(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:getInstanceHealth', options)
  command.response_representation = Google::Apis::NotebooksV1::GetInstanceHealthResponse::Representation
  command.response_class = Google::Apis::NotebooksV1::GetInstanceHealthResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Operation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String) —

    The name of the operation resource.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1370
1371
1372
1373
1374
1375
1376
1377
1378
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 1370

def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::NotebooksV1::Operation::Representation
  command.response_class = Google::Apis::NotebooksV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_runtime(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Runtime

Gets details of a single Runtime. The location must be a regional endpoint rather than zonal.

Parameters:

  • name (String) —

    Required. Format: projects/project_id/locations/location/runtimes/ runtime_id``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1549
1550
1551
1552
1553
1554
1555
1556
1557
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 1549

def get_project_location_runtime(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::NotebooksV1::Runtime::Representation
  command.response_class = Google::Apis::NotebooksV1::Runtime
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_runtime_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Policy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

  • options_requested_policy_version (Fixnum) (defaults to: nil) —

    Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the IAM documentation.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 1593

def get_project_location_runtime_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::NotebooksV1::Policy::Representation
  command.response_class = Google::Apis::NotebooksV1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_schedule(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Schedule

Gets details of schedule

Parameters:

  • name (String) —

    Required. Format: projects/project_id/locations/location/schedules/ schedule_id``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2099
2100
2101
2102
2103
2104
2105
2106
2107
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 2099

def get_project_location_schedule(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::NotebooksV1::Schedule::Representation
  command.response_class = Google::Apis::NotebooksV1::Schedule
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#is_project_location_instance_upgradeable(notebook_instance, type: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::IsInstanceUpgradeableResponse

Checks whether a notebook instance is upgradable.

Parameters:

  • notebook_instance (String) —

    Required. Format: projects/project_id/locations/location/instances/ instance_id``

  • type (String) (defaults to: nil) —

    Optional. The optional UpgradeType. Setting this field will search for additional compute images to upgrade this instance.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



637
638
639
640
641
642
643
644
645
646
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 637

def is_project_location_instance_upgradeable(notebook_instance, type: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+notebookInstance}:isUpgradeable', options)
  command.response_representation = Google::Apis::NotebooksV1::IsInstanceUpgradeableResponse::Representation
  command.response_class = Google::Apis::NotebooksV1::IsInstanceUpgradeableResponse
  command.params['notebookInstance'] = notebook_instance unless notebook_instance.nil?
  command.query['type'] = type unless type.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_environments(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::ListEnvironmentsResponse

Lists environments in a project.

Parameters:

  • parent (String) —

    Required. Format: projects/project_id/locations/location``

  • page_size (Fixnum) (defaults to: nil) —

    Maximum return size of the list call.

  • page_token (String) (defaults to: nil) —

    A previous returned page token that can be used to continue listing from the last result.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 251

def list_project_location_environments(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/environments', options)
  command.response_representation = Google::Apis::NotebooksV1::ListEnvironmentsResponse::Representation
  command.response_class = Google::Apis::NotebooksV1::ListEnvironmentsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_executions(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::ListExecutionsResponse

Lists executions in a given project and location

Parameters:

  • parent (String) —

    Required. Format: parent=projects/project_id/locations/location``

  • filter (String) (defaults to: nil) —

    Filter applied to resulting executions. Currently only supports filtering executions by a specified schedule_id. Format: schedule_id=

  • order_by (String) (defaults to: nil) —

    Sort by field.

  • page_size (Fixnum) (defaults to: nil) —

    Maximum return size of the list call.

  • page_token (String) (defaults to: nil) —

    A previous returned page token that can be used to continue listing from the last result.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



391
392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 391

def list_project_location_executions(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/executions', options)
  command.response_representation = Google::Apis::NotebooksV1::ListExecutionsResponse::Representation
  command.response_class = Google::Apis::NotebooksV1::ListExecutionsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_instances(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::ListInstancesResponse

Lists instances in a given project and location.

Parameters:

  • parent (String) —

    Required. Format: parent=projects/project_id/locations/location``

  • page_size (Fixnum) (defaults to: nil) —

    Maximum return size of the list call.

  • page_token (String) (defaults to: nil) —

    A previous returned page token that can be used to continue listing from the last result.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



673
674
675
676
677
678
679
680
681
682
683
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 673

def list_project_location_instances(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/instances', options)
  command.response_representation = Google::Apis::NotebooksV1::ListInstancesResponse::Representation
  command.response_class = Google::Apis::NotebooksV1::ListInstancesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::ListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String) —

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil) —

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil) —

    The standard list page size.

  • page_token (String) (defaults to: nil) —

    The standard list page token.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 1407

def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::NotebooksV1::ListOperationsResponse::Representation
  command.response_class = Google::Apis::NotebooksV1::ListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_runtimes(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::ListRuntimesResponse

Lists Runtimes in a given project and location.

Parameters:

  • parent (String) —

    Required. Format: parent=projects/project_id/locations/location``

  • page_size (Fixnum) (defaults to: nil) —

    Maximum return size of the list call.

  • page_token (String) (defaults to: nil) —

    A previous returned page token that can be used to continue listing from the last result.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 1629

def list_project_location_runtimes(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/runtimes', options)
  command.response_representation = Google::Apis::NotebooksV1::ListRuntimesResponse::Representation
  command.response_class = Google::Apis::NotebooksV1::ListRuntimesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_schedules(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::ListSchedulesResponse

Lists schedules in a given project and location.

Parameters:

  • parent (String) —

    Required. Format: parent=projects/project_id/locations/location``

  • filter (String) (defaults to: nil) —

    Filter applied to resulting schedules.

  • order_by (String) (defaults to: nil) —

    Field to order results by.

  • page_size (Fixnum) (defaults to: nil) —

    Maximum return size of the list call.

  • page_token (String) (defaults to: nil) —

    A previous returned page token that can be used to continue listing from the last result.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 2138

def list_project_location_schedules(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/schedules', options)
  command.response_representation = Google::Apis::NotebooksV1::ListSchedulesResponse::Representation
  command.response_class = Google::Apis::NotebooksV1::ListSchedulesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::ListLocationsResponse

Lists information about the supported locations for this service.

Parameters:

  • name (String) —

    The resource that owns the locations collection, if applicable.

  • filter (String) (defaults to: nil) —

    A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160.

  • page_size (Fixnum) (defaults to: nil) —

    The maximum number of results to return. If not set, the service selects a default.

  • page_token (String) (defaults to: nil) —

    A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 112

def list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/locations', options)
  command.response_representation = Google::Apis::NotebooksV1::ListLocationsResponse::Representation
  command.response_class = Google::Apis::NotebooksV1::ListLocationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_runtime(name, runtime_object = nil, request_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Operation

Update Notebook Runtime configuration.

Parameters:

  • name (String) —

    Output only. The resource name of the runtime. Format: projects/project/ locations/location/runtimes/runtimeId``

  • runtime_object (Google::Apis::NotebooksV1::Runtime) (defaults to: nil)
  • request_id (String) (defaults to: nil) —

    Idempotent request UUID.

  • update_mask (String) (defaults to: nil) —

    Required. Specifies the path, relative to Runtime, of the field to update. For example, to change the software configuration kernels, the update_mask parameter would be specified as software_config.kernels, and the PATCH request body would specify the new value, as follows: "software_config": " kernels": ['repository': 'gcr.io/deeplearning-platform-release/pytorch-gpu', 'tag': 'latest'], Currently, only the following fields can be updated: - software_config.kernels - software_config.post_startup_script - software_config.custom_gpu_driver_path - software_config.idle_shutdown - software_config.idle_shutdown_timeout - software_config.disable_terminal - labels

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 1676

def patch_project_location_runtime(name, runtime_object = nil, request_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::NotebooksV1::Runtime::Representation
  command.request_object = runtime_object
  command.response_representation = Google::Apis::NotebooksV1::Operation::Representation
  command.response_class = Google::Apis::NotebooksV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['requestId'] = request_id unless request_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#refresh_runtime_token_internal(name, refresh_runtime_token_internal_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::RefreshRuntimeTokenInternalResponse

Gets an access token for the consumer service account that the customer attached to the runtime. Only accessible from the tenant instance.

Parameters:

  • name (String) —

    Required. Format: projects/project_id/locations/location/runtimes/ runtime_id``

  • refresh_runtime_token_internal_request_object (Google::Apis::NotebooksV1::RefreshRuntimeTokenInternalRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 1713

def refresh_runtime_token_internal(name, refresh_runtime_token_internal_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:refreshRuntimeTokenInternal', options)
  command.request_representation = Google::Apis::NotebooksV1::RefreshRuntimeTokenInternalRequest::Representation
  command.request_object = refresh_runtime_token_internal_request_object
  command.response_representation = Google::Apis::NotebooksV1::RefreshRuntimeTokenInternalResponse::Representation
  command.response_class = Google::Apis::NotebooksV1::RefreshRuntimeTokenInternalResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#register_instance(parent, register_instance_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Operation

Registers an existing legacy notebook instance to the Notebooks API server. Legacy instances are instances created with the legacy Compute Engine calls. They are not manageable by the Notebooks API out of the box. This call makes these instances manageable by the Notebooks API.

Parameters:

  • parent (String) —

    Required. Format: parent=projects/project_id/locations/location``

  • register_instance_request_object (Google::Apis::NotebooksV1::RegisterInstanceRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



709
710
711
712
713
714
715
716
717
718
719
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 709

def register_instance(parent, register_instance_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/instances:register', options)
  command.request_representation = Google::Apis::NotebooksV1::RegisterInstanceRequest::Representation
  command.request_object = register_instance_request_object
  command.response_representation = Google::Apis::NotebooksV1::Operation::Representation
  command.response_class = Google::Apis::NotebooksV1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#report_instance_info(name, report_instance_info_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Operation

Allows notebook instances to report their latest instance information to the Notebooks API server. The server will merge the reported information to the instance metadata store. Do not use this method directly.

Parameters:

  • name (String) —

    Required. Format: projects/project_id/locations/location/instances/ instance_id``

  • report_instance_info_request_object (Google::Apis::NotebooksV1::ReportInstanceInfoRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



745
746
747
748
749
750
751
752
753
754
755
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 745

def report_instance_info(name, report_instance_info_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:report', options)
  command.request_representation = Google::Apis::NotebooksV1::ReportInstanceInfoRequest::Representation
  command.request_object = report_instance_info_request_object
  command.response_representation = Google::Apis::NotebooksV1::Operation::Representation
  command.response_class = Google::Apis::NotebooksV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#report_project_location_instance_event(name, report_instance_event_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Operation

Reports and processes an instance event.

Parameters:

  • name (String) —

    Required. Format: projects/project_id/locations/location/instances/ instance_id``

  • report_instance_event_request_object (Google::Apis::NotebooksV1::ReportInstanceEventRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



779
780
781
782
783
784
785
786
787
788
789
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 779

def report_project_location_instance_event(name, report_instance_event_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:reportEvent', options)
  command.request_representation = Google::Apis::NotebooksV1::ReportInstanceEventRequest::Representation
  command.request_object = report_instance_event_request_object
  command.response_representation = Google::Apis::NotebooksV1::Operation::Representation
  command.response_class = Google::Apis::NotebooksV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#report_project_location_runtime_event(name, report_runtime_event_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Operation

Reports and processes a runtime event.

Parameters:

  • name (String) —

    Required. Format: projects/project_id/locations/location/runtimes/ runtime_id``

  • report_runtime_event_request_object (Google::Apis::NotebooksV1::ReportRuntimeEventRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 1747

def report_project_location_runtime_event(name, report_runtime_event_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:reportEvent', options)
  command.request_representation = Google::Apis::NotebooksV1::ReportRuntimeEventRequest::Representation
  command.request_object = report_runtime_event_request_object
  command.response_representation = Google::Apis::NotebooksV1::Operation::Representation
  command.response_class = Google::Apis::NotebooksV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#reset_instance(name, reset_instance_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Operation

Resets a notebook instance.

Parameters:

  • name (String) —

    Required. Format: projects/project_id/locations/location/instances/ instance_id``

  • reset_instance_request_object (Google::Apis::NotebooksV1::ResetInstanceRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



813
814
815
816
817
818
819
820
821
822
823
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 813

def reset_instance(name, reset_instance_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:reset', options)
  command.request_representation = Google::Apis::NotebooksV1::ResetInstanceRequest::Representation
  command.request_object = reset_instance_request_object
  command.response_representation = Google::Apis::NotebooksV1::Operation::Representation
  command.response_class = Google::Apis::NotebooksV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#reset_runtime(name, reset_runtime_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Operation

Resets a Managed Notebook Runtime.

Parameters:

  • name (String) —

    Required. Format: projects/project_id/locations/location/runtimes/ runtime_id``

  • reset_runtime_request_object (Google::Apis::NotebooksV1::ResetRuntimeRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 1781

def reset_runtime(name, reset_runtime_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:reset', options)
  command.request_representation = Google::Apis::NotebooksV1::ResetRuntimeRequest::Representation
  command.request_object = reset_runtime_request_object
  command.response_representation = Google::Apis::NotebooksV1::Operation::Representation
  command.response_class = Google::Apis::NotebooksV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#rollback_instance(name, rollback_instance_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Operation

Rollbacks a notebook instance to the previous version.

Parameters:

  • name (String) —

    Required. Format: projects/project_id/locations/location/instances/ instance_id``

  • rollback_instance_request_object (Google::Apis::NotebooksV1::RollbackInstanceRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



847
848
849
850
851
852
853
854
855
856
857
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 847

def rollback_instance(name, rollback_instance_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:rollback', options)
  command.request_representation = Google::Apis::NotebooksV1::RollbackInstanceRequest::Representation
  command.request_object = rollback_instance_request_object
  command.response_representation = Google::Apis::NotebooksV1::Operation::Representation
  command.response_class = Google::Apis::NotebooksV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_instance_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Policy

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

  • set_iam_policy_request_object (Google::Apis::NotebooksV1::SetIamPolicyRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



918
919
920
921
922
923
924
925
926
927
928
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 918

def set_instance_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::NotebooksV1::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::NotebooksV1::Policy::Representation
  command.response_class = Google::Apis::NotebooksV1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_project_location_instance_accelerator(name, set_instance_accelerator_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Operation

Updates the guest accelerators of a single Instance.

Parameters:

  • name (String) —

    Required. Format: projects/project_id/locations/location/instances/ instance_id``

  • set_instance_accelerator_request_object (Google::Apis::NotebooksV1::SetInstanceAcceleratorRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



881
882
883
884
885
886
887
888
889
890
891
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 881

def set_project_location_instance_accelerator(name, set_instance_accelerator_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}:setAccelerator', options)
  command.request_representation = Google::Apis::NotebooksV1::SetInstanceAcceleratorRequest::Representation
  command.request_object = set_instance_accelerator_request_object
  command.response_representation = Google::Apis::NotebooksV1::Operation::Representation
  command.response_class = Google::Apis::NotebooksV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_project_location_instance_labels(name, set_instance_labels_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Operation

Replaces all the labels of an Instance.

Parameters:

  • name (String) —

    Required. Format: projects/project_id/locations/location/instances/ instance_id``

  • set_instance_labels_request_object (Google::Apis::NotebooksV1::SetInstanceLabelsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



952
953
954
955
956
957
958
959
960
961
962
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 952

def set_project_location_instance_labels(name, set_instance_labels_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}:setLabels', options)
  command.request_representation = Google::Apis::NotebooksV1::SetInstanceLabelsRequest::Representation
  command.request_object = set_instance_labels_request_object
  command.response_representation = Google::Apis::NotebooksV1::Operation::Representation
  command.response_class = Google::Apis::NotebooksV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_project_location_instance_machine_type(name, set_instance_machine_type_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Operation

Updates the machine type of a single Instance.

Parameters:

  • name (String) —

    Required. Format: projects/project_id/locations/location/instances/ instance_id``

  • set_instance_machine_type_request_object (Google::Apis::NotebooksV1::SetInstanceMachineTypeRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



986
987
988
989
990
991
992
993
994
995
996
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 986

def set_project_location_instance_machine_type(name, set_instance_machine_type_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}:setMachineType', options)
  command.request_representation = Google::Apis::NotebooksV1::SetInstanceMachineTypeRequest::Representation
  command.request_object = set_instance_machine_type_request_object
  command.response_representation = Google::Apis::NotebooksV1::Operation::Representation
  command.response_class = Google::Apis::NotebooksV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_runtime_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Policy

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

  • set_iam_policy_request_object (Google::Apis::NotebooksV1::SetIamPolicyRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 1818

def set_runtime_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::NotebooksV1::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::NotebooksV1::Policy::Representation
  command.response_class = Google::Apis::NotebooksV1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#start_instance(name, start_instance_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Operation

Starts a notebook instance.

Parameters:

  • name (String) —

    Required. Format: projects/project_id/locations/location/instances/ instance_id``

  • start_instance_request_object (Google::Apis::NotebooksV1::StartInstanceRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 1020

def start_instance(name, start_instance_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:start', options)
  command.request_representation = Google::Apis::NotebooksV1::StartInstanceRequest::Representation
  command.request_object = start_instance_request_object
  command.response_representation = Google::Apis::NotebooksV1::Operation::Representation
  command.response_class = Google::Apis::NotebooksV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#start_runtime(name, start_runtime_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Operation

Starts a Managed Notebook Runtime. Perform "Start" on GPU instances; "Resume" on CPU instances See: https://cloud.google.com/compute/docs/instances/stop- start-instance https://cloud.google.com/compute/docs/instances/suspend-resume- instance

Parameters:

  • name (String) —

    Required. Format: projects/project_id/locations/location/runtimes/ runtime_id``

  • start_runtime_request_object (Google::Apis::NotebooksV1::StartRuntimeRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 1855

def start_runtime(name, start_runtime_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:start', options)
  command.request_representation = Google::Apis::NotebooksV1::StartRuntimeRequest::Representation
  command.request_object = start_runtime_request_object
  command.response_representation = Google::Apis::NotebooksV1::Operation::Representation
  command.response_class = Google::Apis::NotebooksV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#stop_instance(name, stop_instance_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Operation

Stops a notebook instance.

Parameters:

  • name (String) —

    Required. Format: projects/project_id/locations/location/instances/ instance_id``

  • stop_instance_request_object (Google::Apis::NotebooksV1::StopInstanceRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 1054

def stop_instance(name, stop_instance_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:stop', options)
  command.request_representation = Google::Apis::NotebooksV1::StopInstanceRequest::Representation
  command.request_object = stop_instance_request_object
  command.response_representation = Google::Apis::NotebooksV1::Operation::Representation
  command.response_class = Google::Apis::NotebooksV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#stop_runtime(name, stop_runtime_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Operation

Stops a Managed Notebook Runtime. Perform "Stop" on GPU instances; "Suspend" on CPU instances See: https://cloud.google.com/compute/docs/instances/stop- start-instance https://cloud.google.com/compute/docs/instances/suspend-resume- instance

Parameters:

  • name (String) —

    Required. Format: projects/project_id/locations/location/runtimes/ runtime_id``

  • stop_runtime_request_object (Google::Apis::NotebooksV1::StopRuntimeRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 1892

def stop_runtime(name, stop_runtime_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:stop', options)
  command.request_representation = Google::Apis::NotebooksV1::StopRuntimeRequest::Representation
  command.request_object = stop_runtime_request_object
  command.response_representation = Google::Apis::NotebooksV1::Operation::Representation
  command.response_class = Google::Apis::NotebooksV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#switch_runtime(name, switch_runtime_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Operation

Switch a Managed Notebook Runtime.

Parameters:

  • name (String) —

    Required. Format: projects/project_id/locations/location/runtimes/ runtime_id``

  • switch_runtime_request_object (Google::Apis::NotebooksV1::SwitchRuntimeRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 1926

def switch_runtime(name, switch_runtime_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:switch', options)
  command.request_representation = Google::Apis::NotebooksV1::SwitchRuntimeRequest::Representation
  command.request_object = switch_runtime_request_object
  command.response_representation = Google::Apis::NotebooksV1::Operation::Representation
  command.response_class = Google::Apis::NotebooksV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_instance_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::TestIamPermissionsResponse

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

  • test_iam_permissions_request_object (Google::Apis::NotebooksV1::TestIamPermissionsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 1093

def test_instance_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::NotebooksV1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::NotebooksV1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::NotebooksV1::TestIamPermissionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_runtime_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::TestIamPermissionsResponse

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

  • test_iam_permissions_request_object (Google::Apis::NotebooksV1::TestIamPermissionsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 1965

def test_runtime_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::NotebooksV1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::NotebooksV1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::NotebooksV1::TestIamPermissionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#trigger_schedule(name, trigger_schedule_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Operation

Triggers execution of an existing schedule.

Parameters:

  • name (String) —

    Required. Format: parent=projects/project_id/locations/location/schedules/ schedule_id``

  • trigger_schedule_request_object (Google::Apis::NotebooksV1::TriggerScheduleRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 2174

def trigger_schedule(name, trigger_schedule_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:trigger', options)
  command.request_representation = Google::Apis::NotebooksV1::TriggerScheduleRequest::Representation
  command.request_object = trigger_schedule_request_object
  command.response_representation = Google::Apis::NotebooksV1::Operation::Representation
  command.response_class = Google::Apis::NotebooksV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_project_location_instance_config(name, update_instance_config_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Operation

Update Notebook Instance configurations.

Parameters:

  • name (String) —

    Required. Format: projects/project_id/locations/location/instances/ instance_id``

  • update_instance_config_request_object (Google::Apis::NotebooksV1::UpdateInstanceConfigRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 1127

def update_project_location_instance_config(name, update_instance_config_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}:updateConfig', options)
  command.request_representation = Google::Apis::NotebooksV1::UpdateInstanceConfigRequest::Representation
  command.request_object = update_instance_config_request_object
  command.response_representation = Google::Apis::NotebooksV1::Operation::Representation
  command.response_class = Google::Apis::NotebooksV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_project_location_instance_metadata_items(name, update_instance_metadata_items_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::UpdateInstanceMetadataItemsResponse

Add/update metadata items for an instance.

Parameters:

  • name (String) —

    Required. Format: projects/project_id/locations/location/instances/ instance_id``

  • update_instance_metadata_items_request_object (Google::Apis::NotebooksV1::UpdateInstanceMetadataItemsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 1161

def update_project_location_instance_metadata_items(name, update_instance_metadata_items_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}:updateMetadataItems', options)
  command.request_representation = Google::Apis::NotebooksV1::UpdateInstanceMetadataItemsRequest::Representation
  command.request_object = update_instance_metadata_items_request_object
  command.response_representation = Google::Apis::NotebooksV1::UpdateInstanceMetadataItemsResponse::Representation
  command.response_class = Google::Apis::NotebooksV1::UpdateInstanceMetadataItemsResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_shielded_instance_config(name, update_shielded_instance_config_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Operation

Updates the Shielded instance configuration of a single Instance.

Parameters:

  • name (String) —

    Required. Format: projects/project_id/locations/location/instances/ instance_id``

  • update_shielded_instance_config_request_object (Google::Apis::NotebooksV1::UpdateShieldedInstanceConfigRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 1195

def update_shielded_instance_config(name, update_shielded_instance_config_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}:updateShieldedInstanceConfig', options)
  command.request_representation = Google::Apis::NotebooksV1::UpdateShieldedInstanceConfigRequest::Representation
  command.request_object = update_shielded_instance_config_request_object
  command.response_representation = Google::Apis::NotebooksV1::Operation::Representation
  command.response_class = Google::Apis::NotebooksV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#upgrade_instance(name, upgrade_instance_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Operation

Upgrades a notebook instance to the latest version.

Parameters:

  • name (String) —

    Required. Format: projects/project_id/locations/location/instances/ instance_id``

  • upgrade_instance_request_object (Google::Apis::NotebooksV1::UpgradeInstanceRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 1229

def upgrade_instance(name, upgrade_instance_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:upgrade', options)
  command.request_representation = Google::Apis::NotebooksV1::UpgradeInstanceRequest::Representation
  command.request_object = upgrade_instance_request_object
  command.response_representation = Google::Apis::NotebooksV1::Operation::Representation
  command.response_class = Google::Apis::NotebooksV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#upgrade_project_location_instance_internal(name, upgrade_instance_internal_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Operation

Allows notebook instances to call this endpoint to upgrade themselves. Do not use this method directly.

Parameters:

  • name (String) —

    Required. Format: projects/project_id/locations/location/instances/ instance_id``

  • upgrade_instance_internal_request_object (Google::Apis::NotebooksV1::UpgradeInstanceInternalRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 1264

def upgrade_project_location_instance_internal(name, upgrade_instance_internal_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:upgradeInternal', options)
  command.request_representation = Google::Apis::NotebooksV1::UpgradeInstanceInternalRequest::Representation
  command.request_object = upgrade_instance_internal_request_object
  command.response_representation = Google::Apis::NotebooksV1::Operation::Representation
  command.response_class = Google::Apis::NotebooksV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#upgrade_runtime(name, upgrade_runtime_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Operation

Upgrades a Managed Notebook Runtime to the latest version.

Parameters:

  • name (String) —

    Required. Format: projects/project_id/locations/location/runtimes/ runtime_id``

  • upgrade_runtime_request_object (Google::Apis::NotebooksV1::UpgradeRuntimeRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
 
# File 'lib/google/apis/notebooks_v1/service.rb', line 1999

def upgrade_runtime(name, upgrade_runtime_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:upgrade', options)
  command.request_representation = Google::Apis::NotebooksV1::UpgradeRuntimeRequest::Representation
  command.request_object = upgrade_runtime_request_object
  command.response_representation = Google::Apis::NotebooksV1::Operation::Representation
  command.response_class = Google::Apis::NotebooksV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end