com.google.api.services.notebooks.v1

Class AIPlatformNotebooks.Projects.Locations.Runtimes

java.lang.Object

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

Enclosing class:

AIPlatformNotebooks.Projects.Locations

public class AIPlatformNotebooks.Projects.Locations.Runtimes
extends Object

The "runtimes" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AIPlatformNotebooks.Projects.Locations.Runtimes.AIPlatformNotebooksSwitch
class	AIPlatformNotebooks.Projects.Locations.Runtimes.Create
class	AIPlatformNotebooks.Projects.Locations.Runtimes.Delete
class	AIPlatformNotebooks.Projects.Locations.Runtimes.Diagnose
class	AIPlatformNotebooks.Projects.Locations.Runtimes.Get
class	AIPlatformNotebooks.Projects.Locations.Runtimes.GetIamPolicy
class	AIPlatformNotebooks.Projects.Locations.Runtimes.List
class	AIPlatformNotebooks.Projects.Locations.Runtimes.Migrate
class	AIPlatformNotebooks.Projects.Locations.Runtimes.Patch
class	AIPlatformNotebooks.Projects.Locations.Runtimes.RefreshRuntimeTokenInternal
class	AIPlatformNotebooks.Projects.Locations.Runtimes.ReportEvent
class	AIPlatformNotebooks.Projects.Locations.Runtimes.Reset
class	AIPlatformNotebooks.Projects.Locations.Runtimes.SetIamPolicy
class	AIPlatformNotebooks.Projects.Locations.Runtimes.Start
class	AIPlatformNotebooks.Projects.Locations.Runtimes.Stop
class	AIPlatformNotebooks.Projects.Locations.Runtimes.TestIamPermissions
class	AIPlatformNotebooks.Projects.Locations.Runtimes.Upgrade

Constructor Summary

Constructors

Constructor and Description
Runtimes()

Method Summary

Modifier and Type	Method and Description
AIPlatformNotebooks.Projects.Locations.Runtimes.Create	create(String parent, Runtime content) Creates a new Runtime in a given project and location.
AIPlatformNotebooks.Projects.Locations.Runtimes.Delete	delete(String name) Deletes a single Runtime.
AIPlatformNotebooks.Projects.Locations.Runtimes.Diagnose	diagnose(String name, DiagnoseRuntimeRequest content) Creates a Diagnostic File and runs Diagnostic Tool given a Runtime.
AIPlatformNotebooks.Projects.Locations.Runtimes.Get	get(String name) Gets details of a single Runtime.
AIPlatformNotebooks.Projects.Locations.Runtimes.GetIamPolicy	getIamPolicy(String resource) Gets the access control policy for a resource.
AIPlatformNotebooks.Projects.Locations.Runtimes.List	list(String parent) Lists Runtimes in a given project and location.
AIPlatformNotebooks.Projects.Locations.Runtimes.Migrate	migrate(String name, MigrateRuntimeRequest content) Migrate an existing Runtime to a new Workbench Instance.
AIPlatformNotebooks.Projects.Locations.Runtimes.AIPlatformNotebooksSwitch	notebooksSwitch(String name, SwitchRuntimeRequest content) Switch a Managed Notebook Runtime.
AIPlatformNotebooks.Projects.Locations.Runtimes.Patch	patch(String name, Runtime content) Update Notebook Runtime configuration.
AIPlatformNotebooks.Projects.Locations.Runtimes.RefreshRuntimeTokenInternal	refreshRuntimeTokenInternal(String name, RefreshRuntimeTokenInternalRequest content) Gets an access token for the consumer service account that the customer attached to the runtime.
AIPlatformNotebooks.Projects.Locations.Runtimes.ReportEvent	reportEvent(String name, ReportRuntimeEventRequest content) Reports and processes a runtime event.
AIPlatformNotebooks.Projects.Locations.Runtimes.Reset	reset(String name, ResetRuntimeRequest content) Resets a Managed Notebook Runtime.
AIPlatformNotebooks.Projects.Locations.Runtimes.SetIamPolicy	setIamPolicy(String resource, SetIamPolicyRequest content) Sets the access control policy on the specified resource.
AIPlatformNotebooks.Projects.Locations.Runtimes.Start	start(String name, StartRuntimeRequest content) Starts a Managed Notebook Runtime.
AIPlatformNotebooks.Projects.Locations.Runtimes.Stop	stop(String name, StopRuntimeRequest content) Stops a Managed Notebook Runtime.
AIPlatformNotebooks.Projects.Locations.Runtimes.TestIamPermissions	testIamPermissions(String resource, TestIamPermissionsRequest content) Returns permissions that a caller has on the specified resource.
AIPlatformNotebooks.Projects.Locations.Runtimes.Upgrade	upgrade(String name, UpgradeRuntimeRequest content) Upgrades a Managed Notebook Runtime to the latest version.

Methods inherited from class java.lang.Object

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

Constructor Detail

Runtimes

public Runtimes()

Method Detail

create

public AIPlatformNotebooks.Projects.Locations.Runtimes.Create create(String parent,
                                                                     Runtime content)
                                                              throws IOException

Creates a new Runtime in a given project and location. Create a request for the method "runtimes.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 Runtime

Returns:

the request

Throws:

IOException

delete

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

Deletes a single Runtime. Create a request for the method "runtimes.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}/runtimes/{runtime_id}`

Returns:

the request

Throws:

IOException

diagnose

public AIPlatformNotebooks.Projects.Locations.Runtimes.Diagnose diagnose(String name,
                                                                         DiagnoseRuntimeRequest content)
                                                                  throws IOException

Creates a Diagnostic File and runs Diagnostic Tool given a Runtime. Create a request for the method "runtimes.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}/runtimes/{runtimes_id}`

content - the DiagnoseRuntimeRequest

Returns:

the request

Throws:

IOException

get

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

Gets details of a single Runtime. The location must be a regional endpoint rather than zonal. Create a request for the method "runtimes.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}/runtimes/{runtime_id}`

Returns:

the request

Throws:

IOException

getIamPolicy

public AIPlatformNotebooks.Projects.Locations.Runtimes.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 "runtimes.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

list

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

Lists Runtimes in a given project and location. Create a request for the method "runtimes.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.Runtimes.Migrate migrate(String name,
                                                                       MigrateRuntimeRequest content)
                                                                throws IOException

Migrate an existing Runtime to a new Workbench Instance. Create a request for the method "runtimes.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}/runtimes/{runtime_id}`

content - the MigrateRuntimeRequest

Returns:

the request

Throws:

IOException

patch

public AIPlatformNotebooks.Projects.Locations.Runtimes.Patch patch(String name,
                                                                   Runtime content)
                                                            throws IOException

Update Notebook Runtime configuration. Create a request for the method "runtimes.patch". 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 - Output only. The resource name of the runtime. Format: `projects/{project}/locations/{location}/runtimes/{runtimeId}`

content - the Runtime

Returns:

the request

Throws:

IOException

refreshRuntimeTokenInternal

public AIPlatformNotebooks.Projects.Locations.Runtimes.RefreshRuntimeTokenInternal refreshRuntimeTokenInternal(String name,
                                                                                                               RefreshRuntimeTokenInternalRequest content)
                                                                                                        throws IOException

Gets an access token for the consumer service account that the customer attached to the runtime. Only accessible from the tenant instance. Create a request for the method "runtimes.refreshRuntimeTokenInternal". 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}/runtimes/{runtime_id}`

content - the RefreshRuntimeTokenInternalRequest

Returns:

the request

Throws:

IOException

reportEvent

public AIPlatformNotebooks.Projects.Locations.Runtimes.ReportEvent reportEvent(String name,
                                                                               ReportRuntimeEventRequest content)
                                                                        throws IOException

Reports and processes a runtime event. Create a request for the method "runtimes.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}/runtimes/{runtime_id}`

content - the ReportRuntimeEventRequest

Returns:

the request

Throws:

IOException

reset

public AIPlatformNotebooks.Projects.Locations.Runtimes.Reset reset(String name,
                                                                   ResetRuntimeRequest content)
                                                            throws IOException

Resets a Managed Notebook Runtime. Create a request for the method "runtimes.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}/runtimes/{runtime_id}`

content - the ResetRuntimeRequest

Returns:

the request

Throws:

IOException

setIamPolicy

public AIPlatformNotebooks.Projects.Locations.Runtimes.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 "runtimes.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

start

public AIPlatformNotebooks.Projects.Locations.Runtimes.Start start(String name,
                                                                   StartRuntimeRequest content)
                                                            throws IOException

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 Create a request for the method "runtimes.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}/runtimes/{runtime_id}`

content - the StartRuntimeRequest

Returns:

the request

Throws:

IOException

stop

public AIPlatformNotebooks.Projects.Locations.Runtimes.Stop stop(String name,
                                                                 StopRuntimeRequest content)
                                                          throws IOException

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 Create a request for the method "runtimes.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}/runtimes/{runtime_id}`

content - the StopRuntimeRequest

Returns:

the request

Throws:

IOException

notebooksSwitch

public AIPlatformNotebooks.Projects.Locations.Runtimes.AIPlatformNotebooksSwitch notebooksSwitch(String name,
                                                                                                 SwitchRuntimeRequest content)
                                                                                          throws IOException

Switch a Managed Notebook Runtime. Create a request for the method "runtimes.switch". 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}/runtimes/{runtime_id}`

content - the SwitchRuntimeRequest

Returns:

the request

Throws:

IOException

testIamPermissions

public AIPlatformNotebooks.Projects.Locations.Runtimes.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 "runtimes.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

upgrade

public AIPlatformNotebooks.Projects.Locations.Runtimes.Upgrade upgrade(String name,
                                                                       UpgradeRuntimeRequest content)
                                                                throws IOException

Upgrades a Managed Notebook Runtime to the latest version. Create a request for the method "runtimes.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}/runtimes/{runtime_id}`

content - the UpgradeRuntimeRequest

Returns:

the request

Throws:

IOException