Show / Hide Table of Contents

Class ProjectsResource.LocationsResource.NotebookRuntimesResource

The "notebookRuntimes" collection of methods.

Inheritance
object
ProjectsResource.LocationsResource.NotebookRuntimesResource
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Aiplatform.v1beta1
Assembly: Google.Apis.Aiplatform.v1beta1.dll
Syntax
public class ProjectsResource.LocationsResource.NotebookRuntimesResource

Constructors

NotebookRuntimesResource(IClientService)

Constructs a new resource.

Declaration
public NotebookRuntimesResource(IClientService service)
Parameters
Type Name Description
IClientService service

Properties

Operations

Gets the Operations resource.

Declaration
public virtual ProjectsResource.LocationsResource.NotebookRuntimesResource.OperationsResource Operations { get; }
Property Value
Type Description
ProjectsResource.LocationsResource.NotebookRuntimesResource.OperationsResource

Methods

Assign(GoogleCloudAiplatformV1beta1AssignNotebookRuntimeRequest, string)

Assigns a NotebookRuntime to a user for a particular Notebook file. This method will either returns an existing assignment or generates a new one.

Declaration
public virtual ProjectsResource.LocationsResource.NotebookRuntimesResource.AssignRequest Assign(GoogleCloudAiplatformV1beta1AssignNotebookRuntimeRequest body, string parent)
Parameters
Type Name Description
GoogleCloudAiplatformV1beta1AssignNotebookRuntimeRequest body

The body of the request.

string parent

Required. The resource name of the Location to get the NotebookRuntime assignment. Format: projects/{project}/locations/{location}

Returns
Type Description
ProjectsResource.LocationsResource.NotebookRuntimesResource.AssignRequest

Delete(string)

Deletes a NotebookRuntime.

Declaration
public virtual ProjectsResource.LocationsResource.NotebookRuntimesResource.DeleteRequest Delete(string name)
Parameters
Type Name Description
string name

Required. The name of the NotebookRuntime resource to be deleted. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.

Returns
Type Description
ProjectsResource.LocationsResource.NotebookRuntimesResource.DeleteRequest

GenerateAccessToken(GoogleCloudAiplatformV1beta1GenerateAccessTokenRequest, string)

Internal only: Called from Compute Engine instance to obtain EUC for owner Anonymous access: authenticates caller using VM identity JWT. Design doc: go/colab-on-vertex-euc-dd

Declaration
public virtual ProjectsResource.LocationsResource.NotebookRuntimesResource.GenerateAccessTokenRequest GenerateAccessToken(GoogleCloudAiplatformV1beta1GenerateAccessTokenRequest body, string name)
Parameters
Type Name Description
GoogleCloudAiplatformV1beta1GenerateAccessTokenRequest body

The body of the request.

string name

Required. The name of the resource requesting the OAuth2 token. Format: projects/{project}/locations/{location}/notebookRuntimes/{notebook_runtime} projects/{project}/locations/{location}/notebookExecutionJobs/{notebook_execution_job}

Returns
Type Description
ProjectsResource.LocationsResource.NotebookRuntimesResource.GenerateAccessTokenRequest

Get(string)

Gets a NotebookRuntime.

Declaration
public virtual ProjectsResource.LocationsResource.NotebookRuntimesResource.GetRequest Get(string name)
Parameters
Type Name Description
string name

Required. The name of the NotebookRuntime resource. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.

Returns
Type Description
ProjectsResource.LocationsResource.NotebookRuntimesResource.GetRequest

List(string)

Lists NotebookRuntimes in a Location.

Declaration
public virtual ProjectsResource.LocationsResource.NotebookRuntimesResource.ListRequest List(string parent)
Parameters
Type Name Description
string parent

Required. The resource name of the Location from which to list the NotebookRuntimes. Format: projects/{project}/locations/{location}

Returns
Type Description
ProjectsResource.LocationsResource.NotebookRuntimesResource.ListRequest

ReportEvent(GoogleCloudAiplatformV1beta1ReportRuntimeEventRequest, string)

Declaration
public virtual ProjectsResource.LocationsResource.NotebookRuntimesResource.ReportEventRequest ReportEvent(GoogleCloudAiplatformV1beta1ReportRuntimeEventRequest body, string name)
Parameters
Type Name Description
GoogleCloudAiplatformV1beta1ReportRuntimeEventRequest body

The body of the request.

string name

Required. The name of the NotebookRuntime resource. Format: projects/{project}/locations/{location}/notebookRuntimes/{notebook_runtime}

Returns
Type Description
ProjectsResource.LocationsResource.NotebookRuntimesResource.ReportEventRequest

Start(GoogleCloudAiplatformV1beta1StartNotebookRuntimeRequest, string)

Starts a NotebookRuntime.

Declaration
public virtual ProjectsResource.LocationsResource.NotebookRuntimesResource.StartRequest Start(GoogleCloudAiplatformV1beta1StartNotebookRuntimeRequest body, string name)
Parameters
Type Name Description
GoogleCloudAiplatformV1beta1StartNotebookRuntimeRequest body

The body of the request.

string name

Required. The name of the NotebookRuntime resource to be started. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.

Returns
Type Description
ProjectsResource.LocationsResource.NotebookRuntimesResource.StartRequest

Stop(GoogleCloudAiplatformV1beta1StopNotebookRuntimeRequest, string)

Stops a NotebookRuntime.

Declaration
public virtual ProjectsResource.LocationsResource.NotebookRuntimesResource.StopRequest Stop(GoogleCloudAiplatformV1beta1StopNotebookRuntimeRequest body, string name)
Parameters
Type Name Description
GoogleCloudAiplatformV1beta1StopNotebookRuntimeRequest body

The body of the request.

string name

Required. The name of the NotebookRuntime resource to be stopped. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.

Returns
Type Description
ProjectsResource.LocationsResource.NotebookRuntimesResource.StopRequest

Upgrade(GoogleCloudAiplatformV1beta1UpgradeNotebookRuntimeRequest, string)

Upgrades a NotebookRuntime.

Declaration
public virtual ProjectsResource.LocationsResource.NotebookRuntimesResource.UpgradeRequest Upgrade(GoogleCloudAiplatformV1beta1UpgradeNotebookRuntimeRequest body, string name)
Parameters
Type Name Description
GoogleCloudAiplatformV1beta1UpgradeNotebookRuntimeRequest body

The body of the request.

string name

Required. The name of the NotebookRuntime resource to be upgrade. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.

Returns
Type Description
ProjectsResource.LocationsResource.NotebookRuntimesResource.UpgradeRequest
In this article
Back to top Generated by DocFX