- 3.11.0 (latest)
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.0
- 3.3.0
- 3.2.0
- 3.1.0
- 3.0.0
- 2.28.0
- 2.27.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.0
- 2.2.0
- 2.1.0
- 2.0.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.0
- 1.0.0
public sealed class NotebookServiceClientImpl : NotebookServiceClientReference documentation and code samples for the Cloud AI Platform v1 API class NotebookServiceClientImpl.
NotebookService client wrapper implementation, for convenient use.
Namespace
Google.Cloud.AIPlatform.V1Assembly
Google.Cloud.AIPlatform.V1.dll
Remarks
The interface for Vertex Notebook service (a.k.a. Colab on Workbench).
Constructors
NotebookServiceClientImpl(NotebookServiceClient, NotebookServiceSettings, ILogger)
public NotebookServiceClientImpl(NotebookService.NotebookServiceClient grpcClient, NotebookServiceSettings settings, ILogger logger)Constructs a client wrapper for the NotebookService service, with the specified gRPC client and settings.
| Parameters | |
|---|---|
| Name | Description |
grpcClient |
NotebookServiceNotebookServiceClientThe underlying gRPC client. |
settings |
NotebookServiceSettingsThe base NotebookServiceSettings used within this client. |
logger |
ILoggerOptional ILogger to use within this client. |
Properties
AssignNotebookRuntimeOperationsClient
public override OperationsClient AssignNotebookRuntimeOperationsClient { get; }The long-running operations client for AssignNotebookRuntime.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient |
|
CreateNotebookRuntimeTemplateOperationsClient
public override OperationsClient CreateNotebookRuntimeTemplateOperationsClient { get; }The long-running operations client for CreateNotebookRuntimeTemplate.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient |
|
DeleteNotebookRuntimeOperationsClient
public override OperationsClient DeleteNotebookRuntimeOperationsClient { get; }The long-running operations client for DeleteNotebookRuntime.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient |
|
DeleteNotebookRuntimeTemplateOperationsClient
public override OperationsClient DeleteNotebookRuntimeTemplateOperationsClient { get; }The long-running operations client for DeleteNotebookRuntimeTemplate.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient |
|
GrpcClient
public override NotebookService.NotebookServiceClient GrpcClient { get; }The underlying gRPC NotebookService client
| Property Value | |
|---|---|
| Type | Description |
NotebookServiceNotebookServiceClient |
|
IAMPolicyClient
public override IAMPolicyClient IAMPolicyClient { get; }The IAMPolicyClient associated with this client.
| Property Value | |
|---|---|
| Type | Description |
IAMPolicyClient |
|
LocationsClient
public override LocationsClient LocationsClient { get; }The LocationsClient associated with this client.
| Property Value | |
|---|---|
| Type | Description |
LocationsClient |
|
StartNotebookRuntimeOperationsClient
public override OperationsClient StartNotebookRuntimeOperationsClient { get; }The long-running operations client for StartNotebookRuntime.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient |
|
UpgradeNotebookRuntimeOperationsClient
public override OperationsClient UpgradeNotebookRuntimeOperationsClient { get; }The long-running operations client for UpgradeNotebookRuntime.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient |
|
Methods
AssignNotebookRuntime(AssignNotebookRuntimeRequest, CallSettings)
public override Operation<NotebookRuntime, AssignNotebookRuntimeOperationMetadata> AssignNotebookRuntime(AssignNotebookRuntimeRequest request, CallSettings callSettings = null)Assigns a NotebookRuntime to a user for a particular Notebook file. This method will either returns an existing assignment or generates a new one.
| Parameters | |
|---|---|
| Name | Description |
request |
AssignNotebookRuntimeRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationNotebookRuntimeAssignNotebookRuntimeOperationMetadata |
The RPC response. |
AssignNotebookRuntimeAsync(AssignNotebookRuntimeRequest, CallSettings)
public override Task<Operation<NotebookRuntime, AssignNotebookRuntimeOperationMetadata>> AssignNotebookRuntimeAsync(AssignNotebookRuntimeRequest request, CallSettings callSettings = null)Assigns a NotebookRuntime to a user for a particular Notebook file. This method will either returns an existing assignment or generates a new one.
| Parameters | |
|---|---|
| Name | Description |
request |
AssignNotebookRuntimeRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationNotebookRuntimeAssignNotebookRuntimeOperationMetadata |
A Task containing the RPC response. |
CreateNotebookRuntimeTemplate(CreateNotebookRuntimeTemplateRequest, CallSettings)
public override Operation<NotebookRuntimeTemplate, CreateNotebookRuntimeTemplateOperationMetadata> CreateNotebookRuntimeTemplate(CreateNotebookRuntimeTemplateRequest request, CallSettings callSettings = null)Creates a NotebookRuntimeTemplate.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateNotebookRuntimeTemplateRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationNotebookRuntimeTemplateCreateNotebookRuntimeTemplateOperationMetadata |
The RPC response. |
CreateNotebookRuntimeTemplateAsync(CreateNotebookRuntimeTemplateRequest, CallSettings)
public override Task<Operation<NotebookRuntimeTemplate, CreateNotebookRuntimeTemplateOperationMetadata>> CreateNotebookRuntimeTemplateAsync(CreateNotebookRuntimeTemplateRequest request, CallSettings callSettings = null)Creates a NotebookRuntimeTemplate.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateNotebookRuntimeTemplateRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationNotebookRuntimeTemplateCreateNotebookRuntimeTemplateOperationMetadata |
A Task containing the RPC response. |
DeleteNotebookRuntime(DeleteNotebookRuntimeRequest, CallSettings)
public override Operation<Empty, DeleteOperationMetadata> DeleteNotebookRuntime(DeleteNotebookRuntimeRequest request, CallSettings callSettings = null)Deletes a NotebookRuntime.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteNotebookRuntimeRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationEmptyDeleteOperationMetadata |
The RPC response. |
DeleteNotebookRuntimeAsync(DeleteNotebookRuntimeRequest, CallSettings)
public override Task<Operation<Empty, DeleteOperationMetadata>> DeleteNotebookRuntimeAsync(DeleteNotebookRuntimeRequest request, CallSettings callSettings = null)Deletes a NotebookRuntime.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteNotebookRuntimeRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationEmptyDeleteOperationMetadata |
A Task containing the RPC response. |
DeleteNotebookRuntimeTemplate(DeleteNotebookRuntimeTemplateRequest, CallSettings)
public override Operation<Empty, DeleteOperationMetadata> DeleteNotebookRuntimeTemplate(DeleteNotebookRuntimeTemplateRequest request, CallSettings callSettings = null)Deletes a NotebookRuntimeTemplate.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteNotebookRuntimeTemplateRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationEmptyDeleteOperationMetadata |
The RPC response. |
DeleteNotebookRuntimeTemplateAsync(DeleteNotebookRuntimeTemplateRequest, CallSettings)
public override Task<Operation<Empty, DeleteOperationMetadata>> DeleteNotebookRuntimeTemplateAsync(DeleteNotebookRuntimeTemplateRequest request, CallSettings callSettings = null)Deletes a NotebookRuntimeTemplate.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteNotebookRuntimeTemplateRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationEmptyDeleteOperationMetadata |
A Task containing the RPC response. |
GetNotebookRuntime(GetNotebookRuntimeRequest, CallSettings)
public override NotebookRuntime GetNotebookRuntime(GetNotebookRuntimeRequest request, CallSettings callSettings = null)Gets a NotebookRuntime.
| Parameters | |
|---|---|
| Name | Description |
request |
GetNotebookRuntimeRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
NotebookRuntime |
The RPC response. |
GetNotebookRuntimeAsync(GetNotebookRuntimeRequest, CallSettings)
public override Task<NotebookRuntime> GetNotebookRuntimeAsync(GetNotebookRuntimeRequest request, CallSettings callSettings = null)Gets a NotebookRuntime.
| Parameters | |
|---|---|
| Name | Description |
request |
GetNotebookRuntimeRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskNotebookRuntime |
A Task containing the RPC response. |
GetNotebookRuntimeTemplate(GetNotebookRuntimeTemplateRequest, CallSettings)
public override NotebookRuntimeTemplate GetNotebookRuntimeTemplate(GetNotebookRuntimeTemplateRequest request, CallSettings callSettings = null)Gets a NotebookRuntimeTemplate.
| Parameters | |
|---|---|
| Name | Description |
request |
GetNotebookRuntimeTemplateRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
NotebookRuntimeTemplate |
The RPC response. |
GetNotebookRuntimeTemplateAsync(GetNotebookRuntimeTemplateRequest, CallSettings)
public override Task<NotebookRuntimeTemplate> GetNotebookRuntimeTemplateAsync(GetNotebookRuntimeTemplateRequest request, CallSettings callSettings = null)Gets a NotebookRuntimeTemplate.
| Parameters | |
|---|---|
| Name | Description |
request |
GetNotebookRuntimeTemplateRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskNotebookRuntimeTemplate |
A Task containing the RPC response. |
ListNotebookRuntimeTemplates(ListNotebookRuntimeTemplatesRequest, CallSettings)
public override PagedEnumerable<ListNotebookRuntimeTemplatesResponse, NotebookRuntimeTemplate> ListNotebookRuntimeTemplates(ListNotebookRuntimeTemplatesRequest request, CallSettings callSettings = null)Lists NotebookRuntimeTemplates in a Location.
| Parameters | |
|---|---|
| Name | Description |
request |
ListNotebookRuntimeTemplatesRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListNotebookRuntimeTemplatesResponseNotebookRuntimeTemplate |
A pageable sequence of NotebookRuntimeTemplate resources. |
ListNotebookRuntimeTemplatesAsync(ListNotebookRuntimeTemplatesRequest, CallSettings)
public override PagedAsyncEnumerable<ListNotebookRuntimeTemplatesResponse, NotebookRuntimeTemplate> ListNotebookRuntimeTemplatesAsync(ListNotebookRuntimeTemplatesRequest request, CallSettings callSettings = null)Lists NotebookRuntimeTemplates in a Location.
| Parameters | |
|---|---|
| Name | Description |
request |
ListNotebookRuntimeTemplatesRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListNotebookRuntimeTemplatesResponseNotebookRuntimeTemplate |
A pageable asynchronous sequence of NotebookRuntimeTemplate resources. |
ListNotebookRuntimes(ListNotebookRuntimesRequest, CallSettings)
public override PagedEnumerable<ListNotebookRuntimesResponse, NotebookRuntime> ListNotebookRuntimes(ListNotebookRuntimesRequest request, CallSettings callSettings = null)Lists NotebookRuntimes in a Location.
| Parameters | |
|---|---|
| Name | Description |
request |
ListNotebookRuntimesRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListNotebookRuntimesResponseNotebookRuntime |
A pageable sequence of NotebookRuntime resources. |
ListNotebookRuntimesAsync(ListNotebookRuntimesRequest, CallSettings)
public override PagedAsyncEnumerable<ListNotebookRuntimesResponse, NotebookRuntime> ListNotebookRuntimesAsync(ListNotebookRuntimesRequest request, CallSettings callSettings = null)Lists NotebookRuntimes in a Location.
| Parameters | |
|---|---|
| Name | Description |
request |
ListNotebookRuntimesRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListNotebookRuntimesResponseNotebookRuntime |
A pageable asynchronous sequence of NotebookRuntime resources. |
StartNotebookRuntime(StartNotebookRuntimeRequest, CallSettings)
public override Operation<StartNotebookRuntimeResponse, StartNotebookRuntimeOperationMetadata> StartNotebookRuntime(StartNotebookRuntimeRequest request, CallSettings callSettings = null)Starts a NotebookRuntime.
| Parameters | |
|---|---|
| Name | Description |
request |
StartNotebookRuntimeRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationStartNotebookRuntimeResponseStartNotebookRuntimeOperationMetadata |
The RPC response. |
StartNotebookRuntimeAsync(StartNotebookRuntimeRequest, CallSettings)
public override Task<Operation<StartNotebookRuntimeResponse, StartNotebookRuntimeOperationMetadata>> StartNotebookRuntimeAsync(StartNotebookRuntimeRequest request, CallSettings callSettings = null)Starts a NotebookRuntime.
| Parameters | |
|---|---|
| Name | Description |
request |
StartNotebookRuntimeRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationStartNotebookRuntimeResponseStartNotebookRuntimeOperationMetadata |
A Task containing the RPC response. |
UpgradeNotebookRuntime(UpgradeNotebookRuntimeRequest, CallSettings)
public override Operation<UpgradeNotebookRuntimeResponse, UpgradeNotebookRuntimeOperationMetadata> UpgradeNotebookRuntime(UpgradeNotebookRuntimeRequest request, CallSettings callSettings = null)Upgrades a NotebookRuntime.
| Parameters | |
|---|---|
| Name | Description |
request |
UpgradeNotebookRuntimeRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationUpgradeNotebookRuntimeResponseUpgradeNotebookRuntimeOperationMetadata |
The RPC response. |
UpgradeNotebookRuntimeAsync(UpgradeNotebookRuntimeRequest, CallSettings)
public override Task<Operation<UpgradeNotebookRuntimeResponse, UpgradeNotebookRuntimeOperationMetadata>> UpgradeNotebookRuntimeAsync(UpgradeNotebookRuntimeRequest request, CallSettings callSettings = null)Upgrades a NotebookRuntime.
| Parameters | |
|---|---|
| Name | Description |
request |
UpgradeNotebookRuntimeRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationUpgradeNotebookRuntimeResponseUpgradeNotebookRuntimeOperationMetadata |
A Task containing the RPC response. |