Cloud AI Platform v1 API - Class NotebookService.NotebookServiceBase (3.11.0)

Version 3.11.0

• 3.12.0 (latest)
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

[BindServiceMethod(typeof(NotebookService), "BindService")]
public abstract class NotebookService.NotebookServiceBase

Reference documentation and code samples for the Cloud AI Platform v1 API class NotebookService.NotebookServiceBase.

Base class for server-side implementations of NotebookService

Inheritance

object > NotebookService.NotebookServiceBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Methods

AssignNotebookRuntime(AssignNotebookRuntimeRequest, ServerCallContext)

public virtual Task<Operation> AssignNotebookRuntime(AssignNotebookRuntimeRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	AssignNotebookRuntimeRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

CreateNotebookExecutionJob(CreateNotebookExecutionJobRequest, ServerCallContext)

public virtual Task<Operation> CreateNotebookExecutionJob(CreateNotebookExecutionJobRequest request, ServerCallContext context)

Creates a NotebookExecutionJob.

Parameters
Name	Description
request	CreateNotebookExecutionJobRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

CreateNotebookRuntimeTemplate(CreateNotebookRuntimeTemplateRequest, ServerCallContext)

public virtual Task<Operation> CreateNotebookRuntimeTemplate(CreateNotebookRuntimeTemplateRequest request, ServerCallContext context)

Creates a NotebookRuntimeTemplate.

Parameters
Name	Description
request	CreateNotebookRuntimeTemplateRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteNotebookExecutionJob(DeleteNotebookExecutionJobRequest, ServerCallContext)

public virtual Task<Operation> DeleteNotebookExecutionJob(DeleteNotebookExecutionJobRequest request, ServerCallContext context)

Deletes a NotebookExecutionJob.

Parameters
Name	Description
request	DeleteNotebookExecutionJobRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteNotebookRuntime(DeleteNotebookRuntimeRequest, ServerCallContext)

public virtual Task<Operation> DeleteNotebookRuntime(DeleteNotebookRuntimeRequest request, ServerCallContext context)

Deletes a NotebookRuntime.

Parameters
Name	Description
request	DeleteNotebookRuntimeRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteNotebookRuntimeTemplate(DeleteNotebookRuntimeTemplateRequest, ServerCallContext)

public virtual Task<Operation> DeleteNotebookRuntimeTemplate(DeleteNotebookRuntimeTemplateRequest request, ServerCallContext context)

Deletes a NotebookRuntimeTemplate.

Parameters
Name	Description
request	DeleteNotebookRuntimeTemplateRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

GetNotebookExecutionJob(GetNotebookExecutionJobRequest, ServerCallContext)

public virtual Task<NotebookExecutionJob> GetNotebookExecutionJob(GetNotebookExecutionJobRequest request, ServerCallContext context)

Gets a NotebookExecutionJob.

Parameters
Name	Description
request	GetNotebookExecutionJobRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskNotebookExecutionJob	The response to send back to the client (wrapped by a task).

GetNotebookRuntime(GetNotebookRuntimeRequest, ServerCallContext)

public virtual Task<NotebookRuntime> GetNotebookRuntime(GetNotebookRuntimeRequest request, ServerCallContext context)

Gets a NotebookRuntime.

Parameters
Name	Description
request	GetNotebookRuntimeRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskNotebookRuntime	The response to send back to the client (wrapped by a task).

GetNotebookRuntimeTemplate(GetNotebookRuntimeTemplateRequest, ServerCallContext)

public virtual Task<NotebookRuntimeTemplate> GetNotebookRuntimeTemplate(GetNotebookRuntimeTemplateRequest request, ServerCallContext context)

Gets a NotebookRuntimeTemplate.

Parameters
Name	Description
request	GetNotebookRuntimeTemplateRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskNotebookRuntimeTemplate	The response to send back to the client (wrapped by a task).

ListNotebookExecutionJobs(ListNotebookExecutionJobsRequest, ServerCallContext)

public virtual Task<ListNotebookExecutionJobsResponse> ListNotebookExecutionJobs(ListNotebookExecutionJobsRequest request, ServerCallContext context)

Lists NotebookExecutionJobs in a Location.

Parameters
Name	Description
request	ListNotebookExecutionJobsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListNotebookExecutionJobsResponse	The response to send back to the client (wrapped by a task).

ListNotebookRuntimeTemplates(ListNotebookRuntimeTemplatesRequest, ServerCallContext)

public virtual Task<ListNotebookRuntimeTemplatesResponse> ListNotebookRuntimeTemplates(ListNotebookRuntimeTemplatesRequest request, ServerCallContext context)

Lists NotebookRuntimeTemplates in a Location.

Parameters
Name	Description
request	ListNotebookRuntimeTemplatesRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListNotebookRuntimeTemplatesResponse	The response to send back to the client (wrapped by a task).

ListNotebookRuntimes(ListNotebookRuntimesRequest, ServerCallContext)

public virtual Task<ListNotebookRuntimesResponse> ListNotebookRuntimes(ListNotebookRuntimesRequest request, ServerCallContext context)

Lists NotebookRuntimes in a Location.

Parameters
Name	Description
request	ListNotebookRuntimesRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListNotebookRuntimesResponse	The response to send back to the client (wrapped by a task).

StartNotebookRuntime(StartNotebookRuntimeRequest, ServerCallContext)

public virtual Task<Operation> StartNotebookRuntime(StartNotebookRuntimeRequest request, ServerCallContext context)

Starts a NotebookRuntime.

Parameters
Name	Description
request	StartNotebookRuntimeRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

StopNotebookRuntime(StopNotebookRuntimeRequest, ServerCallContext)

public virtual Task<Operation> StopNotebookRuntime(StopNotebookRuntimeRequest request, ServerCallContext context)

Stops a NotebookRuntime.

Parameters
Name	Description
request	StopNotebookRuntimeRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

UpdateNotebookRuntimeTemplate(UpdateNotebookRuntimeTemplateRequest, ServerCallContext)

public virtual Task<NotebookRuntimeTemplate> UpdateNotebookRuntimeTemplate(UpdateNotebookRuntimeTemplateRequest request, ServerCallContext context)

Updates a NotebookRuntimeTemplate.

Parameters
Name	Description
request	UpdateNotebookRuntimeTemplateRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskNotebookRuntimeTemplate	The response to send back to the client (wrapped by a task).

UpgradeNotebookRuntime(UpgradeNotebookRuntimeRequest, ServerCallContext)

public virtual Task<Operation> UpgradeNotebookRuntime(UpgradeNotebookRuntimeRequest request, ServerCallContext context)

Upgrades a NotebookRuntime.

Parameters
Name	Description
request	UpgradeNotebookRuntimeRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).