Cloud AI Platform v1 API - Class NotebookServiceClientImpl (3.11.0) 

public sealed class NotebookServiceClientImpl : NotebookServiceClient

Reference documentation and code samples for the Cloud AI Platform v1 API class NotebookServiceClientImpl.

NotebookService client wrapper implementation, for convenient use.

Inheritance

object > NotebookServiceClient > NotebookServiceClientImpl

Namespace

Google.Cloud.AIPlatform.V1

Assembly

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 NotebookServiceNotebookServiceClient

The underlying gRPC client.
settings NotebookServiceSettings

The base NotebookServiceSettings used within this client.
logger ILogger

Optional 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
Overrides

CreateNotebookExecutionJobOperationsClient

public override OperationsClient CreateNotebookExecutionJobOperationsClient { get; }

The long-running operations client for CreateNotebookExecutionJob.

Property Value
Type Description
OperationsClient
Overrides

CreateNotebookRuntimeTemplateOperationsClient

public override OperationsClient CreateNotebookRuntimeTemplateOperationsClient { get; }

The long-running operations client for CreateNotebookRuntimeTemplate.

Property Value
Type Description
OperationsClient
Overrides

DeleteNotebookExecutionJobOperationsClient

public override OperationsClient DeleteNotebookExecutionJobOperationsClient { get; }

The long-running operations client for DeleteNotebookExecutionJob.

Property Value
Type Description
OperationsClient
Overrides

DeleteNotebookRuntimeOperationsClient

public override OperationsClient DeleteNotebookRuntimeOperationsClient { get; }

The long-running operations client for DeleteNotebookRuntime.

Property Value
Type Description
OperationsClient
Overrides

DeleteNotebookRuntimeTemplateOperationsClient

public override OperationsClient DeleteNotebookRuntimeTemplateOperationsClient { get; }

The long-running operations client for DeleteNotebookRuntimeTemplate.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override NotebookService.NotebookServiceClient GrpcClient { get; }

The underlying gRPC NotebookService client

Property Value
Type Description
NotebookServiceNotebookServiceClient
Overrides

IAMPolicyClient

public override IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type Description
IAMPolicyClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient
Overrides

StartNotebookRuntimeOperationsClient

public override OperationsClient StartNotebookRuntimeOperationsClient { get; }

The long-running operations client for StartNotebookRuntime.

Property Value
Type Description
OperationsClient
Overrides

StopNotebookRuntimeOperationsClient

public override OperationsClient StopNotebookRuntimeOperationsClient { get; }

The long-running operations client for StopNotebookRuntime.

Property Value
Type Description
OperationsClient
Overrides

UpgradeNotebookRuntimeOperationsClient

public override OperationsClient UpgradeNotebookRuntimeOperationsClient { get; }

The long-running operations client for UpgradeNotebookRuntime.

Property Value
Type Description
OperationsClient
Overrides

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 AssignNotebookRuntimeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationNotebookRuntimeAssignNotebookRuntimeOperationMetadata

The RPC response.
Overrides

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 AssignNotebookRuntimeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationNotebookRuntimeAssignNotebookRuntimeOperationMetadata

A Task containing the RPC response.
Overrides

CreateNotebookExecutionJob(CreateNotebookExecutionJobRequest, CallSettings)

public override Operation<NotebookExecutionJob, CreateNotebookExecutionJobOperationMetadata> CreateNotebookExecutionJob(CreateNotebookExecutionJobRequest request, CallSettings callSettings = null)

Creates a NotebookExecutionJob.

Parameters
Name Description
request CreateNotebookExecutionJobRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationNotebookExecutionJobCreateNotebookExecutionJobOperationMetadata

The RPC response.
Overrides

CreateNotebookExecutionJobAsync(CreateNotebookExecutionJobRequest, CallSettings)

public override Task<Operation<NotebookExecutionJob, CreateNotebookExecutionJobOperationMetadata>> CreateNotebookExecutionJobAsync(CreateNotebookExecutionJobRequest request, CallSettings callSettings = null)

Creates a NotebookExecutionJob.

Parameters
Name Description
request CreateNotebookExecutionJobRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationNotebookExecutionJobCreateNotebookExecutionJobOperationMetadata

A Task containing the RPC response.
Overrides

CreateNotebookRuntimeTemplate(CreateNotebookRuntimeTemplateRequest, CallSettings)

public override Operation<NotebookRuntimeTemplate, CreateNotebookRuntimeTemplateOperationMetadata> CreateNotebookRuntimeTemplate(CreateNotebookRuntimeTemplateRequest request, CallSettings callSettings = null)

Creates a NotebookRuntimeTemplate.

Parameters
Name Description
request CreateNotebookRuntimeTemplateRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationNotebookRuntimeTemplateCreateNotebookRuntimeTemplateOperationMetadata

The RPC response.
Overrides

CreateNotebookRuntimeTemplateAsync(CreateNotebookRuntimeTemplateRequest, CallSettings)

public override Task<Operation<NotebookRuntimeTemplate, CreateNotebookRuntimeTemplateOperationMetadata>> CreateNotebookRuntimeTemplateAsync(CreateNotebookRuntimeTemplateRequest request, CallSettings callSettings = null)

Creates a NotebookRuntimeTemplate.

Parameters
Name Description
request CreateNotebookRuntimeTemplateRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationNotebookRuntimeTemplateCreateNotebookRuntimeTemplateOperationMetadata

A Task containing the RPC response.
Overrides

DeleteNotebookExecutionJob(DeleteNotebookExecutionJobRequest, CallSettings)

public override Operation<Empty, DeleteOperationMetadata> DeleteNotebookExecutionJob(DeleteNotebookExecutionJobRequest request, CallSettings callSettings = null)

Deletes a NotebookExecutionJob.

Parameters
Name Description
request DeleteNotebookExecutionJobRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyDeleteOperationMetadata

The RPC response.
Overrides

DeleteNotebookExecutionJobAsync(DeleteNotebookExecutionJobRequest, CallSettings)

public override Task<Operation<Empty, DeleteOperationMetadata>> DeleteNotebookExecutionJobAsync(DeleteNotebookExecutionJobRequest request, CallSettings callSettings = null)

Deletes a NotebookExecutionJob.

Parameters
Name Description
request DeleteNotebookExecutionJobRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.
Overrides

DeleteNotebookRuntime(DeleteNotebookRuntimeRequest, CallSettings)

public override Operation<Empty, DeleteOperationMetadata> DeleteNotebookRuntime(DeleteNotebookRuntimeRequest request, CallSettings callSettings = null)

Deletes a NotebookRuntime.

Parameters
Name Description
request DeleteNotebookRuntimeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyDeleteOperationMetadata

The RPC response.
Overrides

DeleteNotebookRuntimeAsync(DeleteNotebookRuntimeRequest, CallSettings)

public override Task<Operation<Empty, DeleteOperationMetadata>> DeleteNotebookRuntimeAsync(DeleteNotebookRuntimeRequest request, CallSettings callSettings = null)

Deletes a NotebookRuntime.

Parameters
Name Description
request DeleteNotebookRuntimeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.
Overrides

DeleteNotebookRuntimeTemplate(DeleteNotebookRuntimeTemplateRequest, CallSettings)

public override Operation<Empty, DeleteOperationMetadata> DeleteNotebookRuntimeTemplate(DeleteNotebookRuntimeTemplateRequest request, CallSettings callSettings = null)

Deletes a NotebookRuntimeTemplate.

Parameters
Name Description
request DeleteNotebookRuntimeTemplateRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyDeleteOperationMetadata

The RPC response.
Overrides

DeleteNotebookRuntimeTemplateAsync(DeleteNotebookRuntimeTemplateRequest, CallSettings)

public override Task<Operation<Empty, DeleteOperationMetadata>> DeleteNotebookRuntimeTemplateAsync(DeleteNotebookRuntimeTemplateRequest request, CallSettings callSettings = null)

Deletes a NotebookRuntimeTemplate.

Parameters
Name Description
request DeleteNotebookRuntimeTemplateRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.
Overrides

GetNotebookExecutionJob(GetNotebookExecutionJobRequest, CallSettings)

public override NotebookExecutionJob GetNotebookExecutionJob(GetNotebookExecutionJobRequest request, CallSettings callSettings = null)

Gets a NotebookExecutionJob.

Parameters
Name Description
request GetNotebookExecutionJobRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
NotebookExecutionJob

The RPC response.
Overrides

GetNotebookExecutionJobAsync(GetNotebookExecutionJobRequest, CallSettings)

public override Task<NotebookExecutionJob> GetNotebookExecutionJobAsync(GetNotebookExecutionJobRequest request, CallSettings callSettings = null)

Gets a NotebookExecutionJob.

Parameters
Name Description
request GetNotebookExecutionJobRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskNotebookExecutionJob

A Task containing the RPC response.
Overrides

GetNotebookRuntime(GetNotebookRuntimeRequest, CallSettings)

public override NotebookRuntime GetNotebookRuntime(GetNotebookRuntimeRequest request, CallSettings callSettings = null)

Gets a NotebookRuntime.

Parameters
Name Description
request GetNotebookRuntimeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
NotebookRuntime

The RPC response.
Overrides

GetNotebookRuntimeAsync(GetNotebookRuntimeRequest, CallSettings)

public override Task<NotebookRuntime> GetNotebookRuntimeAsync(GetNotebookRuntimeRequest request, CallSettings callSettings = null)

Gets a NotebookRuntime.

Parameters
Name Description
request GetNotebookRuntimeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskNotebookRuntime

A Task containing the RPC response.
Overrides

GetNotebookRuntimeTemplate(GetNotebookRuntimeTemplateRequest, CallSettings)

public override NotebookRuntimeTemplate GetNotebookRuntimeTemplate(GetNotebookRuntimeTemplateRequest request, CallSettings callSettings = null)

Gets a NotebookRuntimeTemplate.

Parameters
Name Description
request GetNotebookRuntimeTemplateRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
NotebookRuntimeTemplate

The RPC response.
Overrides

GetNotebookRuntimeTemplateAsync(GetNotebookRuntimeTemplateRequest, CallSettings)

public override Task<NotebookRuntimeTemplate> GetNotebookRuntimeTemplateAsync(GetNotebookRuntimeTemplateRequest request, CallSettings callSettings = null)

Gets a NotebookRuntimeTemplate.

Parameters
Name Description
request GetNotebookRuntimeTemplateRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskNotebookRuntimeTemplate

A Task containing the RPC response.
Overrides

ListNotebookExecutionJobs(ListNotebookExecutionJobsRequest, CallSettings)

public override PagedEnumerable<ListNotebookExecutionJobsResponse, NotebookExecutionJob> ListNotebookExecutionJobs(ListNotebookExecutionJobsRequest request, CallSettings callSettings = null)

Lists NotebookExecutionJobs in a Location.

Parameters
Name Description
request ListNotebookExecutionJobsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListNotebookExecutionJobsResponseNotebookExecutionJob

A pageable sequence of NotebookExecutionJob resources.
Overrides

ListNotebookExecutionJobsAsync(ListNotebookExecutionJobsRequest, CallSettings)

public override PagedAsyncEnumerable<ListNotebookExecutionJobsResponse, NotebookExecutionJob> ListNotebookExecutionJobsAsync(ListNotebookExecutionJobsRequest request, CallSettings callSettings = null)

Lists NotebookExecutionJobs in a Location.

Parameters
Name Description
request ListNotebookExecutionJobsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListNotebookExecutionJobsResponseNotebookExecutionJob

A pageable asynchronous sequence of NotebookExecutionJob resources.
Overrides

ListNotebookRuntimeTemplates(ListNotebookRuntimeTemplatesRequest, CallSettings)

public override PagedEnumerable<ListNotebookRuntimeTemplatesResponse, NotebookRuntimeTemplate> ListNotebookRuntimeTemplates(ListNotebookRuntimeTemplatesRequest request, CallSettings callSettings = null)

Lists NotebookRuntimeTemplates in a Location.

Parameters
Name Description
request ListNotebookRuntimeTemplatesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListNotebookRuntimeTemplatesResponseNotebookRuntimeTemplate

A pageable sequence of NotebookRuntimeTemplate resources.
Overrides

ListNotebookRuntimeTemplatesAsync(ListNotebookRuntimeTemplatesRequest, CallSettings)

public override PagedAsyncEnumerable<ListNotebookRuntimeTemplatesResponse, NotebookRuntimeTemplate> ListNotebookRuntimeTemplatesAsync(ListNotebookRuntimeTemplatesRequest request, CallSettings callSettings = null)

Lists NotebookRuntimeTemplates in a Location.

Parameters
Name Description
request ListNotebookRuntimeTemplatesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListNotebookRuntimeTemplatesResponseNotebookRuntimeTemplate

A pageable asynchronous sequence of NotebookRuntimeTemplate resources.
Overrides

ListNotebookRuntimes(ListNotebookRuntimesRequest, CallSettings)

public override PagedEnumerable<ListNotebookRuntimesResponse, NotebookRuntime> ListNotebookRuntimes(ListNotebookRuntimesRequest request, CallSettings callSettings = null)

Lists NotebookRuntimes in a Location.

Parameters
Name Description
request ListNotebookRuntimesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListNotebookRuntimesResponseNotebookRuntime

A pageable sequence of NotebookRuntime resources.
Overrides

ListNotebookRuntimesAsync(ListNotebookRuntimesRequest, CallSettings)

public override PagedAsyncEnumerable<ListNotebookRuntimesResponse, NotebookRuntime> ListNotebookRuntimesAsync(ListNotebookRuntimesRequest request, CallSettings callSettings = null)

Lists NotebookRuntimes in a Location.

Parameters
Name Description
request ListNotebookRuntimesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListNotebookRuntimesResponseNotebookRuntime

A pageable asynchronous sequence of NotebookRuntime resources.
Overrides

StartNotebookRuntime(StartNotebookRuntimeRequest, CallSettings)

public override Operation<StartNotebookRuntimeResponse, StartNotebookRuntimeOperationMetadata> StartNotebookRuntime(StartNotebookRuntimeRequest request, CallSettings callSettings = null)

Starts a NotebookRuntime.

Parameters
Name Description
request StartNotebookRuntimeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationStartNotebookRuntimeResponseStartNotebookRuntimeOperationMetadata

The RPC response.
Overrides

StartNotebookRuntimeAsync(StartNotebookRuntimeRequest, CallSettings)

public override Task<Operation<StartNotebookRuntimeResponse, StartNotebookRuntimeOperationMetadata>> StartNotebookRuntimeAsync(StartNotebookRuntimeRequest request, CallSettings callSettings = null)

Starts a NotebookRuntime.

Parameters
Name Description
request StartNotebookRuntimeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationStartNotebookRuntimeResponseStartNotebookRuntimeOperationMetadata

A Task containing the RPC response.
Overrides

StopNotebookRuntime(StopNotebookRuntimeRequest, CallSettings)

public override Operation<StopNotebookRuntimeResponse, StopNotebookRuntimeOperationMetadata> StopNotebookRuntime(StopNotebookRuntimeRequest request, CallSettings callSettings = null)

Stops a NotebookRuntime.

Parameters
Name Description
request StopNotebookRuntimeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationStopNotebookRuntimeResponseStopNotebookRuntimeOperationMetadata

The RPC response.
Overrides

StopNotebookRuntimeAsync(StopNotebookRuntimeRequest, CallSettings)

public override Task<Operation<StopNotebookRuntimeResponse, StopNotebookRuntimeOperationMetadata>> StopNotebookRuntimeAsync(StopNotebookRuntimeRequest request, CallSettings callSettings = null)

Stops a NotebookRuntime.

Parameters
Name Description
request StopNotebookRuntimeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationStopNotebookRuntimeResponseStopNotebookRuntimeOperationMetadata

A Task containing the RPC response.
Overrides

UpdateNotebookRuntimeTemplate(UpdateNotebookRuntimeTemplateRequest, CallSettings)

public override NotebookRuntimeTemplate UpdateNotebookRuntimeTemplate(UpdateNotebookRuntimeTemplateRequest request, CallSettings callSettings = null)

Updates a NotebookRuntimeTemplate.

Parameters
Name Description
request UpdateNotebookRuntimeTemplateRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
NotebookRuntimeTemplate

The RPC response.
Overrides

UpdateNotebookRuntimeTemplateAsync(UpdateNotebookRuntimeTemplateRequest, CallSettings)

public override Task<NotebookRuntimeTemplate> UpdateNotebookRuntimeTemplateAsync(UpdateNotebookRuntimeTemplateRequest request, CallSettings callSettings = null)

Updates a NotebookRuntimeTemplate.

Parameters
Name Description
request UpdateNotebookRuntimeTemplateRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskNotebookRuntimeTemplate

A Task containing the RPC response.
Overrides

UpgradeNotebookRuntime(UpgradeNotebookRuntimeRequest, CallSettings)

public override Operation<UpgradeNotebookRuntimeResponse, UpgradeNotebookRuntimeOperationMetadata> UpgradeNotebookRuntime(UpgradeNotebookRuntimeRequest request, CallSettings callSettings = null)

Upgrades a NotebookRuntime.

Parameters
Name Description
request UpgradeNotebookRuntimeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationUpgradeNotebookRuntimeResponseUpgradeNotebookRuntimeOperationMetadata

The RPC response.
Overrides

UpgradeNotebookRuntimeAsync(UpgradeNotebookRuntimeRequest, CallSettings)

public override Task<Operation<UpgradeNotebookRuntimeResponse, UpgradeNotebookRuntimeOperationMetadata>> UpgradeNotebookRuntimeAsync(UpgradeNotebookRuntimeRequest request, CallSettings callSettings = null)

Upgrades a NotebookRuntime.

Parameters
Name Description
request UpgradeNotebookRuntimeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationUpgradeNotebookRuntimeResponseUpgradeNotebookRuntimeOperationMetadata

A Task containing the RPC response.
Overrides