[BindServiceMethod(typeof(NotebookService), "BindService")]
public abstract class NotebookService.NotebookServiceBase
Reference documentation and code samples for the AI Platform Notebooks v1beta1 API class NotebookService.NotebookServiceBase.
Base class for server-side implementations of NotebookService
Namespace
Google.Cloud.Notebooks.V1Beta1Assembly
Google.Cloud.Notebooks.V1Beta1.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 |
TaskOperation | 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). |
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 |
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). |
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 |
TaskEnvironment | 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). |
IsInstanceUpgradeable(IsInstanceUpgradeableRequest, ServerCallContext)
[Obsolete]
public virtual Task<IsInstanceUpgradeableResponse> IsInstanceUpgradeable(IsInstanceUpgradeableRequest request, ServerCallContext context)
Check if a notebook instance is upgradable. Deprecated. Please consider using v1.
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 |
TaskIsInstanceUpgradeableResponse | 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 |
TaskListEnvironmentsResponse | 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). |
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 |
TaskOperation | 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 |
TaskOperation | 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). |
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 |
TaskOperation | The response to send back to the client (wrapped by a task). |
SetInstanceLabels(SetInstanceLabelsRequest, ServerCallContext)
public virtual Task<Operation> SetInstanceLabels(SetInstanceLabelsRequest request, ServerCallContext context)
Updates 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 |
TaskOperation | 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 |
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). |
UpgradeInstance(UpgradeInstanceRequest, ServerCallContext)
[Obsolete]
public virtual Task<Operation> UpgradeInstance(UpgradeInstanceRequest request, ServerCallContext context)
Upgrades a notebook instance to the latest version. Deprecated. Please consider using v1.
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). |
UpgradeInstanceInternal(UpgradeInstanceInternalRequest, ServerCallContext)
[Obsolete]
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. Deprecated. Please consider using v1.
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 |
TaskOperation | The response to send back to the client (wrapped by a task). |