Notebooks v2 API - Class NotebookService.NotebookServiceBase (1.1.0)

Version 1.1.0

• 1.2.0 (latest)
• 1.1.0
• 1.0.0

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

Reference documentation and code samples for the Notebooks v2 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.Notebooks.V2

Assembly

Google.Cloud.Notebooks.V2.dll

Methods

CheckInstanceUpgradability(CheckInstanceUpgradabilityRequest, ServerCallContext)

public virtual Task<CheckInstanceUpgradabilityResponse> CheckInstanceUpgradability(CheckInstanceUpgradabilityRequest request, ServerCallContext context)

Checks whether a notebook instance is upgradable.

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

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

CreateInstance(CreateInstanceRequest, ServerCallContext)

public virtual Task<Operation> CreateInstance(CreateInstanceRequest request, ServerCallContext context)

Creates a new Instance in a given project and location.

Parameters
Name	Description
request	CreateInstanceRequest 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).

DeleteInstance(DeleteInstanceRequest, ServerCallContext)

public virtual Task<Operation> DeleteInstance(DeleteInstanceRequest request, ServerCallContext context)

Deletes a single Instance.

Parameters
Name	Description
request	DeleteInstanceRequest 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).

DiagnoseInstance(DiagnoseInstanceRequest, ServerCallContext)

public virtual Task<Operation> DiagnoseInstance(DiagnoseInstanceRequest request, ServerCallContext context)

Creates a Diagnostic File and runs Diagnostic Tool given an Instance.

Parameters
Name	Description
request	DiagnoseInstanceRequest 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).

GetInstance(GetInstanceRequest, ServerCallContext)

public virtual Task<Instance> GetInstance(GetInstanceRequest request, ServerCallContext context)

Gets details of a single Instance.

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

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

ListInstances(ListInstancesRequest, ServerCallContext)

public virtual Task<ListInstancesResponse> ListInstances(ListInstancesRequest request, ServerCallContext context)

Lists instances in a given project and location.

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

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

ResetInstance(ResetInstanceRequest, ServerCallContext)

public virtual Task<Operation> ResetInstance(ResetInstanceRequest request, ServerCallContext context)

Resets a notebook instance.

Parameters
Name	Description
request	ResetInstanceRequest 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).

RollbackInstance(RollbackInstanceRequest, ServerCallContext)

public virtual Task<Operation> RollbackInstance(RollbackInstanceRequest request, ServerCallContext context)

Rollbacks a notebook instance to the previous version.

Parameters
Name	Description
request	RollbackInstanceRequest 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).

StartInstance(StartInstanceRequest, ServerCallContext)

public virtual Task<Operation> StartInstance(StartInstanceRequest request, ServerCallContext context)

Starts a notebook instance.

Parameters
Name	Description
request	StartInstanceRequest 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).

StopInstance(StopInstanceRequest, ServerCallContext)

public virtual Task<Operation> StopInstance(StopInstanceRequest request, ServerCallContext context)

Stops a notebook instance.

Parameters
Name	Description
request	StopInstanceRequest 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).

UpdateInstance(UpdateInstanceRequest, ServerCallContext)

public virtual Task<Operation> UpdateInstance(UpdateInstanceRequest request, ServerCallContext context)

UpdateInstance updates an Instance.

Parameters
Name	Description
request	UpdateInstanceRequest 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).

UpgradeInstance(UpgradeInstanceRequest, ServerCallContext)

public virtual Task<Operation> UpgradeInstance(UpgradeInstanceRequest request, ServerCallContext context)

Upgrades a notebook instance to the latest version.

Parameters
Name	Description
request	UpgradeInstanceRequest 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).