Cloud AI Platform v1beta1 API - Class NotebookService.NotebookServiceBase (1.0.0-beta12)

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

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

Base class for server-side implementations of NotebookService

Inheritance

object > NotebookService.NotebookServiceBase

Namespace

Google.Cloud.AIPlatform.V1Beta1

Assembly

Google.Cloud.AIPlatform.V1Beta1.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).