com.google.api.services.notebooks.v1

Class AIPlatformNotebooks.Projects.Locations.Instances

java.lang.Object

com.google.api.services.notebooks.v1.AIPlatformNotebooks.Projects.Locations.Instances

Enclosing class:

AIPlatformNotebooks.Projects.Locations

public class AIPlatformNotebooks.Projects.Locations.Instances
extends Object

The "instances" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AIPlatformNotebooks.Projects.Locations.Instances.Create
class	AIPlatformNotebooks.Projects.Locations.Instances.Delete
class	AIPlatformNotebooks.Projects.Locations.Instances.Diagnose
class	AIPlatformNotebooks.Projects.Locations.Instances.Get
class	AIPlatformNotebooks.Projects.Locations.Instances.GetIamPolicy
class	AIPlatformNotebooks.Projects.Locations.Instances.GetInstanceHealth
class	AIPlatformNotebooks.Projects.Locations.Instances.IsUpgradeable
class	AIPlatformNotebooks.Projects.Locations.Instances.List
class	AIPlatformNotebooks.Projects.Locations.Instances.Migrate
class	AIPlatformNotebooks.Projects.Locations.Instances.Register
class	AIPlatformNotebooks.Projects.Locations.Instances.Report
class	AIPlatformNotebooks.Projects.Locations.Instances.ReportEvent
class	AIPlatformNotebooks.Projects.Locations.Instances.Reset
class	AIPlatformNotebooks.Projects.Locations.Instances.Rollback
class	AIPlatformNotebooks.Projects.Locations.Instances.SetAccelerator
class	AIPlatformNotebooks.Projects.Locations.Instances.SetIamPolicy
class	AIPlatformNotebooks.Projects.Locations.Instances.SetLabels
class	AIPlatformNotebooks.Projects.Locations.Instances.SetMachineType
class	AIPlatformNotebooks.Projects.Locations.Instances.Start
class	AIPlatformNotebooks.Projects.Locations.Instances.Stop
class	AIPlatformNotebooks.Projects.Locations.Instances.TestIamPermissions
class	AIPlatformNotebooks.Projects.Locations.Instances.UpdateConfig
class	AIPlatformNotebooks.Projects.Locations.Instances.UpdateMetadataItems
class	AIPlatformNotebooks.Projects.Locations.Instances.UpdateShieldedInstanceConfig
class	AIPlatformNotebooks.Projects.Locations.Instances.Upgrade
class	AIPlatformNotebooks.Projects.Locations.Instances.UpgradeInternal

Constructor Summary

Constructors

Constructor and Description
Instances()

Method Summary

Modifier and Type	Method and Description
AIPlatformNotebooks.Projects.Locations.Instances.Create	create(String parent, Instance content) Creates a new Instance in a given project and location.
AIPlatformNotebooks.Projects.Locations.Instances.Delete	delete(String name) Deletes a single Instance.
AIPlatformNotebooks.Projects.Locations.Instances.Diagnose	diagnose(String name, DiagnoseInstanceRequest content) Creates a Diagnostic File and runs Diagnostic Tool given an Instance.
AIPlatformNotebooks.Projects.Locations.Instances.Get	get(String name) Gets details of a single Instance.
AIPlatformNotebooks.Projects.Locations.Instances.GetIamPolicy	getIamPolicy(String resource) Gets the access control policy for a resource.
AIPlatformNotebooks.Projects.Locations.Instances.GetInstanceHealth	getInstanceHealth(String name) Checks whether a notebook instance is healthy.
AIPlatformNotebooks.Projects.Locations.Instances.IsUpgradeable	isUpgradeable(String notebookInstance) Checks whether a notebook instance is upgradable.
AIPlatformNotebooks.Projects.Locations.Instances.List	list(String parent) Lists instances in a given project and location.
AIPlatformNotebooks.Projects.Locations.Instances.Migrate	migrate(String name, MigrateInstanceRequest content) Migrates an existing User-Managed Notebook to Workbench Instances.
AIPlatformNotebooks.Projects.Locations.Instances.Register	register(String parent, RegisterInstanceRequest content) Registers an existing legacy notebook instance to the Notebooks API server.
AIPlatformNotebooks.Projects.Locations.Instances.Report	report(String name, ReportInstanceInfoRequest content) Allows notebook instances to report their latest instance information to the Notebooks API server.
AIPlatformNotebooks.Projects.Locations.Instances.ReportEvent	reportEvent(String name, ReportInstanceEventRequest content) Reports and processes an instance event.
AIPlatformNotebooks.Projects.Locations.Instances.Reset	reset(String name, ResetInstanceRequest content) Resets a notebook instance.
AIPlatformNotebooks.Projects.Locations.Instances.Rollback	rollback(String name, RollbackInstanceRequest content) Rollbacks a notebook instance to the previous version.
AIPlatformNotebooks.Projects.Locations.Instances.SetAccelerator	setAccelerator(String name, SetInstanceAcceleratorRequest content) Updates the guest accelerators of a single Instance.
AIPlatformNotebooks.Projects.Locations.Instances.SetIamPolicy	setIamPolicy(String resource, SetIamPolicyRequest content) Sets the access control policy on the specified resource.
AIPlatformNotebooks.Projects.Locations.Instances.SetLabels	setLabels(String name, SetInstanceLabelsRequest content) Replaces all the labels of an Instance.
AIPlatformNotebooks.Projects.Locations.Instances.SetMachineType	setMachineType(String name, SetInstanceMachineTypeRequest content) Updates the machine type of a single Instance.
AIPlatformNotebooks.Projects.Locations.Instances.Start	start(String name, StartInstanceRequest content) Starts a notebook instance.
AIPlatformNotebooks.Projects.Locations.Instances.Stop	stop(String name, StopInstanceRequest content) Stops a notebook instance.
AIPlatformNotebooks.Projects.Locations.Instances.TestIamPermissions	testIamPermissions(String resource, TestIamPermissionsRequest content) Returns permissions that a caller has on the specified resource.
AIPlatformNotebooks.Projects.Locations.Instances.UpdateConfig	updateConfig(String name, UpdateInstanceConfigRequest content) Update Notebook Instance configurations.
AIPlatformNotebooks.Projects.Locations.Instances.UpdateMetadataItems	updateMetadataItems(String name, UpdateInstanceMetadataItemsRequest content) Add/update metadata items for an instance.
AIPlatformNotebooks.Projects.Locations.Instances.UpdateShieldedInstanceConfig	updateShieldedInstanceConfig(String name, UpdateShieldedInstanceConfigRequest content) Updates the Shielded instance configuration of a single Instance.
AIPlatformNotebooks.Projects.Locations.Instances.Upgrade	upgrade(String name, UpgradeInstanceRequest content) Upgrades a notebook instance to the latest version.
AIPlatformNotebooks.Projects.Locations.Instances.UpgradeInternal	upgradeInternal(String name, UpgradeInstanceInternalRequest content) Allows notebook instances to call this endpoint to upgrade themselves.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Instances

public Instances()

Method Detail

create

public AIPlatformNotebooks.Projects.Locations.Instances.Create create(String parent,
                                                                      Instance content)
                                                               throws IOException

Creates a new Instance in a given project and location. Create a request for the method "instances.create". This request holds the parameters needed by the notebooks server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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

content - the Instance

Returns:

the request

Throws:

IOException

delete

public AIPlatformNotebooks.Projects.Locations.Instances.Delete delete(String name)
                                                               throws IOException

Deletes a single Instance. Create a request for the method "instances.delete". This request holds the parameters needed by the notebooks server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`

Returns:

the request

Throws:

IOException

diagnose

public AIPlatformNotebooks.Projects.Locations.Instances.Diagnose diagnose(String name,
                                                                          DiagnoseInstanceRequest content)
                                                                   throws IOException

Creates a Diagnostic File and runs Diagnostic Tool given an Instance. Create a request for the method "instances.diagnose". This request holds the parameters needed by the notebooks server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`

content - the DiagnoseInstanceRequest

Returns:

the request

Throws:

IOException

get

public AIPlatformNotebooks.Projects.Locations.Instances.Get get(String name)
                                                         throws IOException

Gets details of a single Instance. Create a request for the method "instances.get". This request holds the parameters needed by the notebooks server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`

Returns:

the request

Throws:

IOException

getIamPolicy

public AIPlatformNotebooks.Projects.Locations.Instances.GetIamPolicy getIamPolicy(String resource)
                                                                           throws IOException

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. Create a request for the method "instances.getIamPolicy". This request holds the parameters needed by the notebooks server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

resource - REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

Returns:

the request

Throws:

IOException

getInstanceHealth

public AIPlatformNotebooks.Projects.Locations.Instances.GetInstanceHealth getInstanceHealth(String name)
                                                                                     throws IOException

Checks whether a notebook instance is healthy. Create a request for the method "instances.getInstanceHealth". This request holds the parameters needed by the notebooks server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`

Returns:

the request

Throws:

IOException

isUpgradeable

public AIPlatformNotebooks.Projects.Locations.Instances.IsUpgradeable isUpgradeable(String notebookInstance)
                                                                             throws IOException

Checks whether a notebook instance is upgradable. Create a request for the method "instances.isUpgradeable". This request holds the parameters needed by the notebooks server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

notebookInstance - Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`

Returns:

the request

Throws:

IOException

list

public AIPlatformNotebooks.Projects.Locations.Instances.List list(String parent)
                                                           throws IOException

Lists instances in a given project and location. Create a request for the method "instances.list". This request holds the parameters needed by the notebooks server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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

Returns:

the request

Throws:

IOException

migrate

public AIPlatformNotebooks.Projects.Locations.Instances.Migrate migrate(String name,
                                                                        MigrateInstanceRequest content)
                                                                 throws IOException

Migrates an existing User-Managed Notebook to Workbench Instances. Create a request for the method "instances.migrate". This request holds the parameters needed by the notebooks server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`

content - the MigrateInstanceRequest

Returns:

the request

Throws:

IOException

register

public AIPlatformNotebooks.Projects.Locations.Instances.Register register(String parent,
                                                                          RegisterInstanceRequest content)
                                                                   throws IOException

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. Create a request for the method "instances.register". This request holds the parameters needed by the notebooks server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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

content - the RegisterInstanceRequest

Returns:

the request

Throws:

IOException

report

public AIPlatformNotebooks.Projects.Locations.Instances.Report report(String name,
                                                                      ReportInstanceInfoRequest content)
                                                               throws IOException

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. Create a request for the method "instances.report". This request holds the parameters needed by the notebooks server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`

content - the ReportInstanceInfoRequest

Returns:

the request

Throws:

IOException

reportEvent

public AIPlatformNotebooks.Projects.Locations.Instances.ReportEvent reportEvent(String name,
                                                                                ReportInstanceEventRequest content)
                                                                         throws IOException

Reports and processes an instance event. Create a request for the method "instances.reportEvent". This request holds the parameters needed by the notebooks server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`

content - the ReportInstanceEventRequest

Returns:

the request

Throws:

IOException

reset

public AIPlatformNotebooks.Projects.Locations.Instances.Reset reset(String name,
                                                                    ResetInstanceRequest content)
                                                             throws IOException

Resets a notebook instance. Create a request for the method "instances.reset". This request holds the parameters needed by the notebooks server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`

content - the ResetInstanceRequest

Returns:

the request

Throws:

IOException

rollback

public AIPlatformNotebooks.Projects.Locations.Instances.Rollback rollback(String name,
                                                                          RollbackInstanceRequest content)
                                                                   throws IOException

Rollbacks a notebook instance to the previous version. Create a request for the method "instances.rollback". This request holds the parameters needed by the notebooks server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`

content - the RollbackInstanceRequest

Returns:

the request

Throws:

IOException

setAccelerator

public AIPlatformNotebooks.Projects.Locations.Instances.SetAccelerator setAccelerator(String name,
                                                                                      SetInstanceAcceleratorRequest content)
                                                                               throws IOException

Updates the guest accelerators of a single Instance. Create a request for the method "instances.setAccelerator". This request holds the parameters needed by the notebooks server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`

content - the SetInstanceAcceleratorRequest

Returns:

the request

Throws:

IOException

setIamPolicy

public AIPlatformNotebooks.Projects.Locations.Instances.SetIamPolicy setIamPolicy(String resource,
                                                                                  SetIamPolicyRequest content)
                                                                           throws IOException

Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. Create a request for the method "instances.setIamPolicy". This request holds the parameters needed by the notebooks server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

resource - REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

content - the SetIamPolicyRequest

Returns:

the request

Throws:

IOException

setLabels

public AIPlatformNotebooks.Projects.Locations.Instances.SetLabels setLabels(String name,
                                                                            SetInstanceLabelsRequest content)
                                                                     throws IOException

Replaces all the labels of an Instance. Create a request for the method "instances.setLabels". This request holds the parameters needed by the notebooks server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`

content - the SetInstanceLabelsRequest

Returns:

the request

Throws:

IOException

setMachineType

public AIPlatformNotebooks.Projects.Locations.Instances.SetMachineType setMachineType(String name,
                                                                                      SetInstanceMachineTypeRequest content)
                                                                               throws IOException

Updates the machine type of a single Instance. Create a request for the method "instances.setMachineType". This request holds the parameters needed by the notebooks server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`

content - the SetInstanceMachineTypeRequest

Returns:

the request

Throws:

IOException

start

public AIPlatformNotebooks.Projects.Locations.Instances.Start start(String name,
                                                                    StartInstanceRequest content)
                                                             throws IOException

Starts a notebook instance. Create a request for the method "instances.start". This request holds the parameters needed by the notebooks server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`

content - the StartInstanceRequest

Returns:

the request

Throws:

IOException

stop

public AIPlatformNotebooks.Projects.Locations.Instances.Stop stop(String name,
                                                                  StopInstanceRequest content)
                                                           throws IOException

Stops a notebook instance. Create a request for the method "instances.stop". This request holds the parameters needed by the notebooks server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`

content - the StopInstanceRequest

Returns:

the request

Throws:

IOException

testIamPermissions

public AIPlatformNotebooks.Projects.Locations.Instances.TestIamPermissions testIamPermissions(String resource,
                                                                                              TestIamPermissionsRequest content)
                                                                                       throws IOException

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. Create a request for the method "instances.testIamPermissions". This request holds the parameters needed by the notebooks server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

resource - REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

content - the TestIamPermissionsRequest

Returns:

the request

Throws:

IOException

updateConfig

public AIPlatformNotebooks.Projects.Locations.Instances.UpdateConfig updateConfig(String name,
                                                                                  UpdateInstanceConfigRequest content)
                                                                           throws IOException

Update Notebook Instance configurations. Create a request for the method "instances.updateConfig". This request holds the parameters needed by the notebooks server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`

content - the UpdateInstanceConfigRequest

Returns:

the request

Throws:

IOException

updateMetadataItems

public AIPlatformNotebooks.Projects.Locations.Instances.UpdateMetadataItems updateMetadataItems(String name,
                                                                                                UpdateInstanceMetadataItemsRequest content)
                                                                                         throws IOException

Add/update metadata items for an instance. Create a request for the method "instances.updateMetadataItems". This request holds the parameters needed by the notebooks server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`

content - the UpdateInstanceMetadataItemsRequest

Returns:

the request

Throws:

IOException

updateShieldedInstanceConfig

public AIPlatformNotebooks.Projects.Locations.Instances.UpdateShieldedInstanceConfig updateShieldedInstanceConfig(String name,
                                                                                                                  UpdateShieldedInstanceConfigRequest content)
                                                                                                           throws IOException

Updates the Shielded instance configuration of a single Instance. Create a request for the method "instances.updateShieldedInstanceConfig". This request holds the parameters needed by the notebooks server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`

content - the UpdateShieldedInstanceConfigRequest

Returns:

the request

Throws:

IOException

upgrade

public AIPlatformNotebooks.Projects.Locations.Instances.Upgrade upgrade(String name,
                                                                        UpgradeInstanceRequest content)
                                                                 throws IOException

Upgrades a notebook instance to the latest version. Create a request for the method "instances.upgrade". This request holds the parameters needed by the notebooks server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`

content - the UpgradeInstanceRequest

Returns:

the request

Throws:

IOException

upgradeInternal

public AIPlatformNotebooks.Projects.Locations.Instances.UpgradeInternal upgradeInternal(String name,
                                                                                        UpgradeInstanceInternalRequest content)
                                                                                 throws IOException

Allows notebook instances to call this endpoint to upgrade themselves. Do not use this method directly. Create a request for the method "instances.upgradeInternal". This request holds the parameters needed by the notebooks server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`

content - the UpgradeInstanceInternalRequest

Returns:

the request

Throws:

IOException