Class: Google::Apis::NotebooksV1::AIPlatformNotebooksService
- Inherits:
-
Core::BaseService
- Object
- Core::BaseService
- Google::Apis::NotebooksV1::AIPlatformNotebooksService
- Defined in:
- lib/google/apis/notebooks_v1/service.rb
Overview
Notebooks API
AI Platform Notebooks API is used to manage notebook resources in Google Cloud.
Instance Attribute Summary collapse
-
#key ⇒ String
API key.
-
#quota_user ⇒ String
Available to use for quota purposes for server-side applications.
Instance Method Summary collapse
-
#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.
-
#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.
-
#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 Scheduled Notebook in a given project and location.
-
#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.
-
#create_project_location_runtime(parent, runtime_object = 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.
-
#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.
-
#delete_project_location_environment(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Operation
Deletes a single Environment.
-
#delete_project_location_execution(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Operation
Deletes execution.
-
#delete_project_location_instance(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Operation
Deletes a single Instance.
-
#delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Empty
Deletes a long-running operation.
-
#delete_project_location_runtime(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Operation
Deletes a single Runtime.
-
#delete_project_location_schedule(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Operation
Deletes schedule and all underlying jobs.
-
#get_project_location(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Location
Gets information about a location.
-
#get_project_location_environment(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Environment
Gets details of a single Environment.
-
#get_project_location_execution(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Execution
Gets details of executions.
-
#get_project_location_instance(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Instance
Gets details of a single Instance.
-
#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.
-
#get_project_location_instance_instance_health(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::GetInstanceHealthResponse
Check if a notebook instance is healthy.
-
#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.
-
#get_project_location_runtime(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Runtime
Gets details of a single Runtime.
-
#get_project_location_schedule(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Schedule
Gets details of schedule.
-
#initialize ⇒ AIPlatformNotebooksService
constructor
A new instance of AIPlatformNotebooksService.
-
#is_project_location_instance_upgradeable(notebook_instance, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::IsInstanceUpgradeableResponse
Check if a notebook instance is upgradable.
-
#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.
-
#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.
-
#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.
-
#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.
-
#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.
-
#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.
-
#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.
-
#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.
-
#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.
-
#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.
-
#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.
-
#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.
-
#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.
-
#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.
-
#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.
-
#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.
-
#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.
-
#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.
-
#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.
-
#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.
-
#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.
-
#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.
-
#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.
-
#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.
-
#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.
-
#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.
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.
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.
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.
1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 |
# File 'lib/google/apis/notebooks_v1/service.rb', line 1158 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', ) 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.
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', ) 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 Scheduled Notebook in a given project and location.
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', ) 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.
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', ) 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, 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.
1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 |
# File 'lib/google/apis/notebooks_v1/service.rb', line 1303 def create_project_location_runtime(parent, runtime_object = nil, runtime_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+parent}/runtimes', ) 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['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.
1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 |
# File 'lib/google/apis/notebooks_v1/service.rb', line 1581 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', ) 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.
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}', ) 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
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}', ) 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.
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}', ) 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.
1193 1194 1195 1196 1197 1198 1199 1200 1201 |
# File 'lib/google/apis/notebooks_v1/service.rb', line 1193 def delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', ) 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, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Operation
Deletes a single Runtime.
1337 1338 1339 1340 1341 1342 1343 1344 1345 |
# File 'lib/google/apis/notebooks_v1/service.rb', line 1337 def delete_project_location_runtime(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', ) 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_schedule(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Operation
Deletes schedule and all underlying jobs
1615 1616 1617 1618 1619 1620 1621 1622 1623 |
# File 'lib/google/apis/notebooks_v1/service.rb', line 1615 def delete_project_location_schedule(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', ) 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.
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}', ) 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.
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}', ) 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
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}', ) 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.
493 494 495 496 497 498 499 500 501 |
# File 'lib/google/apis/notebooks_v1/service.rb', line 493 def get_project_location_instance(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) 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.
533 534 535 536 537 538 539 540 541 542 |
# File 'lib/google/apis/notebooks_v1/service.rb', line 533 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', ) 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'] = unless .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
Check if a notebook instance is healthy.
565 566 567 568 569 570 571 572 573 |
# File 'lib/google/apis/notebooks_v1/service.rb', line 565 def get_project_location_instance_instance_health(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}:getInstanceHealth', ) 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.
1224 1225 1226 1227 1228 1229 1230 1231 1232 |
# File 'lib/google/apis/notebooks_v1/service.rb', line 1224 def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) 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.
1369 1370 1371 1372 1373 1374 1375 1376 1377 |
# File 'lib/google/apis/notebooks_v1/service.rb', line 1369 def get_project_location_runtime(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) 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_schedule(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::Schedule
Gets details of schedule
1646 1647 1648 1649 1650 1651 1652 1653 1654 |
# File 'lib/google/apis/notebooks_v1/service.rb', line 1646 def get_project_location_schedule(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) 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, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::NotebooksV1::IsInstanceUpgradeableResponse
Check if a notebook instance is upgradable.
596 597 598 599 600 601 602 603 604 |
# File 'lib/google/apis/notebooks_v1/service.rb', line 596 def is_project_location_instance_upgradeable(notebook_instance, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+notebookInstance}:isUpgradeable', ) 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['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.
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', ) 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
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', ) 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.
631 632 633 634 635 636 637 638 639 640 641 |
# File 'lib/google/apis/notebooks_v1/service.rb', line 631 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', ) 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. NOTE: the name
binding allows API services to override the binding to use different resource
name schemes, such as users/*/operations. To override the binding, API
services can add a binding such as "/v1/name=users/*/operations" to their
service configuration. For backwards compatibility, the default name includes
the operations collection id, however overriding users must ensure the name
binding is the parent resource, without the operations collection id.
1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 |
# File 'lib/google/apis/notebooks_v1/service.rb', line 1267 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', ) 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.
1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 |
# File 'lib/google/apis/notebooks_v1/service.rb', line 1404 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', ) 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.
1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 |
# File 'lib/google/apis/notebooks_v1/service.rb', line 1685 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', ) 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.
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', ) 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 |
#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.
667 668 669 670 671 672 673 674 675 676 677 |
# File 'lib/google/apis/notebooks_v1/service.rb', line 667 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', ) 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.
703 704 705 706 707 708 709 710 711 712 713 |
# File 'lib/google/apis/notebooks_v1/service.rb', line 703 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', ) 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 |
#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.
737 738 739 740 741 742 743 744 745 746 747 |
# File 'lib/google/apis/notebooks_v1/service.rb', line 737 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', ) 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.
1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 |
# File 'lib/google/apis/notebooks_v1/service.rb', line 1438 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', ) 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.
771 772 773 774 775 776 777 778 779 780 781 |
# File 'lib/google/apis/notebooks_v1/service.rb', line 771 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', ) 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.
841 842 843 844 845 846 847 848 849 850 851 |
# File 'lib/google/apis/notebooks_v1/service.rb', line 841 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', ) 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.
805 806 807 808 809 810 811 812 813 814 815 |
# File 'lib/google/apis/notebooks_v1/service.rb', line 805 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', ) 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.
875 876 877 878 879 880 881 882 883 884 885 |
# File 'lib/google/apis/notebooks_v1/service.rb', line 875 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', ) 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.
909 910 911 912 913 914 915 916 917 918 919 |
# File 'lib/google/apis/notebooks_v1/service.rb', line 909 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', ) 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 |
#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.
943 944 945 946 947 948 949 950 951 952 953 |
# File 'lib/google/apis/notebooks_v1/service.rb', line 943 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', ) 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
1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 |
# File 'lib/google/apis/notebooks_v1/service.rb', line 1475 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', ) 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.
977 978 979 980 981 982 983 984 985 986 987 |
# File 'lib/google/apis/notebooks_v1/service.rb', line 977 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', ) 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
1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 |
# File 'lib/google/apis/notebooks_v1/service.rb', line 1512 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', ) 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.
1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 |
# File 'lib/google/apis/notebooks_v1/service.rb', line 1546 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', ) 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.
1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 |
# File 'lib/google/apis/notebooks_v1/service.rb', line 1015 def (resource, = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', ) command.request_representation = Google::Apis::NotebooksV1::TestIamPermissionsRequest::Representation command.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.
1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 |
# File 'lib/google/apis/notebooks_v1/service.rb', line 1721 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', ) 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_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.
1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 |
# File 'lib/google/apis/notebooks_v1/service.rb', line 1049 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', ) 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.
1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 |
# File 'lib/google/apis/notebooks_v1/service.rb', line 1083 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', ) 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.
1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 |
# File 'lib/google/apis/notebooks_v1/service.rb', line 1118 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', ) 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 |