AI Platform Notebooks v1 API - Class ManagedNotebookService.ManagedNotebookServiceBase (2.2.0-beta01)

[BindServiceMethod(typeof(ManagedNotebookService), "BindService")]
public abstract class ManagedNotebookServiceBase

Reference documentation and code samples for the AI Platform Notebooks v1 API class ManagedNotebookService.ManagedNotebookServiceBase.

Base class for server-side implementations of ManagedNotebookService

Inheritance

Object > ManagedNotebookService.ManagedNotebookServiceBase

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Notebooks.V1

Assembly

Google.Cloud.Notebooks.V1.dll

Methods

CreateRuntime(CreateRuntimeRequest, ServerCallContext)

public virtual Task<Operation> CreateRuntime(CreateRuntimeRequest request, ServerCallContext context)

Creates a new Runtime in a given project and location.

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

Returns
Type	Description
`Task<Operation>`	The response to send back to the client (wrapped by a task).

DeleteRuntime(DeleteRuntimeRequest, ServerCallContext)

public virtual Task<Operation> DeleteRuntime(DeleteRuntimeRequest request, ServerCallContext context)

Deletes a single Runtime.

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

Returns
Type	Description
`Task<Operation>`	The response to send back to the client (wrapped by a task).

DiagnoseRuntime(DiagnoseRuntimeRequest, ServerCallContext)

public virtual Task<Operation> DiagnoseRuntime(DiagnoseRuntimeRequest request, ServerCallContext context)

Creates a Diagnostic File and runs Diagnostic Tool given a Runtime.

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

Returns
Type	Description
`Task<Operation>`	The response to send back to the client (wrapped by a task).

GetRuntime(GetRuntimeRequest, ServerCallContext)

public virtual Task<Runtime> GetRuntime(GetRuntimeRequest request, ServerCallContext context)

Gets details of a single Runtime. The location must be a regional endpoint rather than zonal.

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

Returns
Type	Description
`Task<Runtime>`	The response to send back to the client (wrapped by a task).

ListRuntimes(ListRuntimesRequest, ServerCallContext)

public virtual Task<ListRuntimesResponse> ListRuntimes(ListRuntimesRequest request, ServerCallContext context)

Lists Runtimes in a given project and location.

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

Returns
Type	Description
`Task<ListRuntimesResponse>`	The response to send back to the client (wrapped by a task).

RefreshRuntimeTokenInternal(RefreshRuntimeTokenInternalRequest, ServerCallContext)

public virtual Task<RefreshRuntimeTokenInternalResponse> RefreshRuntimeTokenInternal(RefreshRuntimeTokenInternalRequest request, ServerCallContext context)

Gets an access token for the consumer service account that the customer attached to the runtime. Only accessible from the tenant instance.

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

Returns
Type	Description
`Task<RefreshRuntimeTokenInternalResponse>`	The response to send back to the client (wrapped by a task).

ReportRuntimeEvent(ReportRuntimeEventRequest, ServerCallContext)

public virtual Task<Operation> ReportRuntimeEvent(ReportRuntimeEventRequest request, ServerCallContext context)

Report and process a runtime event.

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

Returns
Type	Description
`Task<Operation>`	The response to send back to the client (wrapped by a task).

ResetRuntime(ResetRuntimeRequest, ServerCallContext)

public virtual Task<Operation> ResetRuntime(ResetRuntimeRequest request, ServerCallContext context)

Resets a Managed Notebook Runtime.

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

Returns
Type	Description
`Task<Operation>`	The response to send back to the client (wrapped by a task).

StartRuntime(StartRuntimeRequest, ServerCallContext)

public virtual Task<Operation> StartRuntime(StartRuntimeRequest request, ServerCallContext context)

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

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

Returns
Type	Description
`Task<Operation>`	The response to send back to the client (wrapped by a task).

StopRuntime(StopRuntimeRequest, ServerCallContext)

public virtual Task<Operation> StopRuntime(StopRuntimeRequest request, ServerCallContext context)

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

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

Returns
Type	Description
`Task<Operation>`	The response to send back to the client (wrapped by a task).

SwitchRuntime(SwitchRuntimeRequest, ServerCallContext)

public virtual Task<Operation> SwitchRuntime(SwitchRuntimeRequest request, ServerCallContext context)

Switch a Managed Notebook Runtime.

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

Returns
Type	Description
`Task<Operation>`	The response to send back to the client (wrapped by a task).

UpdateRuntime(UpdateRuntimeRequest, ServerCallContext)

public virtual Task<Operation> UpdateRuntime(UpdateRuntimeRequest request, ServerCallContext context)

Update Notebook Runtime configuration.

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

Returns
Type	Description
`Task<Operation>`	The response to send back to the client (wrapped by a task).

UpgradeRuntime(UpgradeRuntimeRequest, ServerCallContext)

public virtual Task<Operation> UpgradeRuntime(UpgradeRuntimeRequest request, ServerCallContext context)

Upgrades a Managed Notebook Runtime to the latest version.

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

Returns
Type	Description
`Task<Operation>`	The response to send back to the client (wrapped by a task).