Interface NotebookServiceGrpc.AsyncService (3.52.0)

public static interface NotebookServiceGrpc.AsyncService

The interface for Vertex Notebook service (a.k.a. Colab on Workbench).

Methods

assignNotebookRuntime(AssignNotebookRuntimeRequest request, StreamObserver<Operation> responseObserver)

public default void assignNotebookRuntime(AssignNotebookRuntimeRequest request, StreamObserver<Operation> responseObserver)

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
responseObserver io.grpc.stub.StreamObserver<Operation>

createNotebookExecutionJob(CreateNotebookExecutionJobRequest request, StreamObserver<Operation> responseObserver)

public default void createNotebookExecutionJob(CreateNotebookExecutionJobRequest request, StreamObserver<Operation> responseObserver)

Creates a NotebookExecutionJob.

Parameters
Name Description
request CreateNotebookExecutionJobRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

createNotebookRuntimeTemplate(CreateNotebookRuntimeTemplateRequest request, StreamObserver<Operation> responseObserver)

public default void createNotebookRuntimeTemplate(CreateNotebookRuntimeTemplateRequest request, StreamObserver<Operation> responseObserver)

Creates a NotebookRuntimeTemplate.

Parameters
Name Description
request CreateNotebookRuntimeTemplateRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

deleteNotebookExecutionJob(DeleteNotebookExecutionJobRequest request, StreamObserver<Operation> responseObserver)

public default void deleteNotebookExecutionJob(DeleteNotebookExecutionJobRequest request, StreamObserver<Operation> responseObserver)

Deletes a NotebookExecutionJob.

Parameters
Name Description
request DeleteNotebookExecutionJobRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

deleteNotebookRuntime(DeleteNotebookRuntimeRequest request, StreamObserver<Operation> responseObserver)

public default void deleteNotebookRuntime(DeleteNotebookRuntimeRequest request, StreamObserver<Operation> responseObserver)

Deletes a NotebookRuntime.

Parameters
Name Description
request DeleteNotebookRuntimeRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

deleteNotebookRuntimeTemplate(DeleteNotebookRuntimeTemplateRequest request, StreamObserver<Operation> responseObserver)

public default void deleteNotebookRuntimeTemplate(DeleteNotebookRuntimeTemplateRequest request, StreamObserver<Operation> responseObserver)

Deletes a NotebookRuntimeTemplate.

Parameters
Name Description
request DeleteNotebookRuntimeTemplateRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

getNotebookExecutionJob(GetNotebookExecutionJobRequest request, StreamObserver<NotebookExecutionJob> responseObserver)

public default void getNotebookExecutionJob(GetNotebookExecutionJobRequest request, StreamObserver<NotebookExecutionJob> responseObserver)

Gets a NotebookExecutionJob.

Parameters
Name Description
request GetNotebookExecutionJobRequest
responseObserver io.grpc.stub.StreamObserver<NotebookExecutionJob>

getNotebookRuntime(GetNotebookRuntimeRequest request, StreamObserver<NotebookRuntime> responseObserver)

public default void getNotebookRuntime(GetNotebookRuntimeRequest request, StreamObserver<NotebookRuntime> responseObserver)

Gets a NotebookRuntime.

Parameters
Name Description
request GetNotebookRuntimeRequest
responseObserver io.grpc.stub.StreamObserver<NotebookRuntime>

getNotebookRuntimeTemplate(GetNotebookRuntimeTemplateRequest request, StreamObserver<NotebookRuntimeTemplate> responseObserver)

public default void getNotebookRuntimeTemplate(GetNotebookRuntimeTemplateRequest request, StreamObserver<NotebookRuntimeTemplate> responseObserver)

Gets a NotebookRuntimeTemplate.

Parameters
Name Description
request GetNotebookRuntimeTemplateRequest
responseObserver io.grpc.stub.StreamObserver<NotebookRuntimeTemplate>

listNotebookExecutionJobs(ListNotebookExecutionJobsRequest request, StreamObserver<ListNotebookExecutionJobsResponse> responseObserver)

public default void listNotebookExecutionJobs(ListNotebookExecutionJobsRequest request, StreamObserver<ListNotebookExecutionJobsResponse> responseObserver)

Lists NotebookExecutionJobs in a Location.

Parameters
Name Description
request ListNotebookExecutionJobsRequest
responseObserver io.grpc.stub.StreamObserver<ListNotebookExecutionJobsResponse>

listNotebookRuntimeTemplates(ListNotebookRuntimeTemplatesRequest request, StreamObserver<ListNotebookRuntimeTemplatesResponse> responseObserver)

public default void listNotebookRuntimeTemplates(ListNotebookRuntimeTemplatesRequest request, StreamObserver<ListNotebookRuntimeTemplatesResponse> responseObserver)

Lists NotebookRuntimeTemplates in a Location.

Parameters
Name Description
request ListNotebookRuntimeTemplatesRequest
responseObserver io.grpc.stub.StreamObserver<ListNotebookRuntimeTemplatesResponse>

listNotebookRuntimes(ListNotebookRuntimesRequest request, StreamObserver<ListNotebookRuntimesResponse> responseObserver)

public default void listNotebookRuntimes(ListNotebookRuntimesRequest request, StreamObserver<ListNotebookRuntimesResponse> responseObserver)

Lists NotebookRuntimes in a Location.

Parameters
Name Description
request ListNotebookRuntimesRequest
responseObserver io.grpc.stub.StreamObserver<ListNotebookRuntimesResponse>

startNotebookRuntime(StartNotebookRuntimeRequest request, StreamObserver<Operation> responseObserver)

public default void startNotebookRuntime(StartNotebookRuntimeRequest request, StreamObserver<Operation> responseObserver)

Starts a NotebookRuntime.

Parameters
Name Description
request StartNotebookRuntimeRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

updateNotebookRuntimeTemplate(UpdateNotebookRuntimeTemplateRequest request, StreamObserver<NotebookRuntimeTemplate> responseObserver)

public default void updateNotebookRuntimeTemplate(UpdateNotebookRuntimeTemplateRequest request, StreamObserver<NotebookRuntimeTemplate> responseObserver)

Updates a NotebookRuntimeTemplate.

Parameters
Name Description
request UpdateNotebookRuntimeTemplateRequest
responseObserver io.grpc.stub.StreamObserver<NotebookRuntimeTemplate>

upgradeNotebookRuntime(UpgradeNotebookRuntimeRequest request, StreamObserver<Operation> responseObserver)

public default void upgradeNotebookRuntime(UpgradeNotebookRuntimeRequest request, StreamObserver<Operation> responseObserver)

Upgrades a NotebookRuntime.

Parameters
Name Description
request UpgradeNotebookRuntimeRequest
responseObserver io.grpc.stub.StreamObserver<Operation>