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

[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

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
NameDescription
requestCreateRuntimeRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
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
NameDescription
requestDeleteRuntimeRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
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
NameDescription
requestGetRuntimeRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
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
NameDescription
requestListRuntimesRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
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
NameDescription
requestRefreshRuntimeTokenInternalRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
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
NameDescription
requestReportRuntimeEventRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
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
NameDescription
requestResetRuntimeRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
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
NameDescription
requestStartRuntimeRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
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
NameDescription
requestStopRuntimeRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
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
NameDescription
requestSwitchRuntimeRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<Operation>

The response to send back to the client (wrapped by a task).