AI Platform Notebooks v1 API - Class NotebookService.NotebookServiceBase (2.1.0)

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

Reference documentation and code samples for the AI Platform Notebooks 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.Notebooks.V1

Assembly

Google.Cloud.Notebooks.V1.dll

Methods

CreateEnvironment(CreateEnvironmentRequest, ServerCallContext)

public virtual Task<Operation> CreateEnvironment(CreateEnvironmentRequest request, ServerCallContext context)

Creates a new Environment.

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

CreateExecution(CreateExecutionRequest, ServerCallContext)

public virtual Task<Operation> CreateExecution(CreateExecutionRequest request, ServerCallContext context)

Creates a new Execution in a given project and location.

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

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
`Task<Operation>`	The response to send back to the client (wrapped by a task).

CreateSchedule(CreateScheduleRequest, ServerCallContext)

public virtual Task<Operation> CreateSchedule(CreateScheduleRequest request, ServerCallContext context)

Creates a new Scheduled Notebook in a given project and location.

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

DeleteEnvironment(DeleteEnvironmentRequest, ServerCallContext)

public virtual Task<Operation> DeleteEnvironment(DeleteEnvironmentRequest request, ServerCallContext context)

Deletes a single Environment.

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

DeleteExecution(DeleteExecutionRequest, ServerCallContext)

public virtual Task<Operation> DeleteExecution(DeleteExecutionRequest request, ServerCallContext context)

Deletes execution

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

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
`Task<Operation>`	The response to send back to the client (wrapped by a task).

DeleteSchedule(DeleteScheduleRequest, ServerCallContext)

public virtual Task<Operation> DeleteSchedule(DeleteScheduleRequest request, ServerCallContext context)

Deletes schedule and all underlying jobs

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

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
`Task<Operation>`	The response to send back to the client (wrapped by a task).

GetEnvironment(GetEnvironmentRequest, ServerCallContext)

public virtual Task<Environment> GetEnvironment(GetEnvironmentRequest request, ServerCallContext context)

Gets details of a single Environment.

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

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

GetExecution(GetExecutionRequest, ServerCallContext)

public virtual Task<Execution> GetExecution(GetExecutionRequest request, ServerCallContext context)

Gets details of executions

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

Returns
Type	Description
`Task<Execution>`	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
`Task<Instance>`	The response to send back to the client (wrapped by a task).

GetInstanceHealth(GetInstanceHealthRequest, ServerCallContext)

public virtual Task<GetInstanceHealthResponse> GetInstanceHealth(GetInstanceHealthRequest request, ServerCallContext context)

Check if a notebook instance is healthy.

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

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

GetSchedule(GetScheduleRequest, ServerCallContext)

public virtual Task<Schedule> GetSchedule(GetScheduleRequest request, ServerCallContext context)

Gets details of schedule

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

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

IsInstanceUpgradeable(IsInstanceUpgradeableRequest, ServerCallContext)

public virtual Task<IsInstanceUpgradeableResponse> IsInstanceUpgradeable(IsInstanceUpgradeableRequest request, ServerCallContext context)

Check if a notebook instance is upgradable.

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

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

ListEnvironments(ListEnvironmentsRequest, ServerCallContext)

public virtual Task<ListEnvironmentsResponse> ListEnvironments(ListEnvironmentsRequest request, ServerCallContext context)

Lists environments in a project.

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

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

ListExecutions(ListExecutionsRequest, ServerCallContext)

public virtual Task<ListExecutionsResponse> ListExecutions(ListExecutionsRequest request, ServerCallContext context)

Lists executions in a given project and location

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

Returns
Type	Description
`Task<ListExecutionsResponse>`	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
`Task<ListInstancesResponse>`	The response to send back to the client (wrapped by a task).

ListSchedules(ListSchedulesRequest, ServerCallContext)

public virtual Task<ListSchedulesResponse> ListSchedules(ListSchedulesRequest request, ServerCallContext context)

Lists schedules in a given project and location.

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

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

RegisterInstance(RegisterInstanceRequest, ServerCallContext)

public virtual Task<Operation> RegisterInstance(RegisterInstanceRequest request, ServerCallContext context)

Registers an existing legacy notebook instance to the Notebooks API server. Legacy instances are instances created with the legacy Compute Engine calls. They are not manageable by the Notebooks API out of the box. This call makes these instances manageable by the Notebooks API.

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

ReportInstanceInfo(ReportInstanceInfoRequest, ServerCallContext)

public virtual Task<Operation> ReportInstanceInfo(ReportInstanceInfoRequest request, ServerCallContext context)

Allows notebook instances to report their latest instance information to the Notebooks API server. The server will merge the reported information to the instance metadata store. Do not use this method directly.

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

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
`Task<Operation>`	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
`Task<Operation>`	The response to send back to the client (wrapped by a task).

SetInstanceAccelerator(SetInstanceAcceleratorRequest, ServerCallContext)

public virtual Task<Operation> SetInstanceAccelerator(SetInstanceAcceleratorRequest request, ServerCallContext context)

Updates the guest accelerators of a single Instance.

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

SetInstanceLabels(SetInstanceLabelsRequest, ServerCallContext)

public virtual Task<Operation> SetInstanceLabels(SetInstanceLabelsRequest request, ServerCallContext context)

Replaces all the labels of an Instance.

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

SetInstanceMachineType(SetInstanceMachineTypeRequest, ServerCallContext)

public virtual Task<Operation> SetInstanceMachineType(SetInstanceMachineTypeRequest request, ServerCallContext context)

Updates the machine type of a single Instance.

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

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
`Task<Operation>`	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
`Task<Operation>`	The response to send back to the client (wrapped by a task).

TriggerSchedule(TriggerScheduleRequest, ServerCallContext)

public virtual Task<Operation> TriggerSchedule(TriggerScheduleRequest request, ServerCallContext context)

Triggers execution of an existing schedule.

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

UpdateInstanceConfig(UpdateInstanceConfigRequest, ServerCallContext)

public virtual Task<Operation> UpdateInstanceConfig(UpdateInstanceConfigRequest request, ServerCallContext context)

Update Notebook Instance configurations.

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

UpdateInstanceMetadataItems(UpdateInstanceMetadataItemsRequest, ServerCallContext)

public virtual Task<UpdateInstanceMetadataItemsResponse> UpdateInstanceMetadataItems(UpdateInstanceMetadataItemsRequest request, ServerCallContext context)

Add/update metadata items for an instance.

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

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

UpdateShieldedInstanceConfig(UpdateShieldedInstanceConfigRequest, ServerCallContext)

public virtual Task<Operation> UpdateShieldedInstanceConfig(UpdateShieldedInstanceConfigRequest request, ServerCallContext context)

Updates the Shielded instance configuration of a single Instance.

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

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
`Task<Operation>`	The response to send back to the client (wrapped by a task).

UpgradeInstanceInternal(UpgradeInstanceInternalRequest, ServerCallContext)

public virtual Task<Operation> UpgradeInstanceInternal(UpgradeInstanceInternalRequest request, ServerCallContext context)

Allows notebook instances to call this endpoint to upgrade themselves. Do not use this method directly.

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