com.google.cloud.notebooks.v1

Interface NotebookServiceGrpc.AsyncService

All Known Implementing Classes:

NotebookServiceGrpc.NotebookServiceImplBase

Enclosing class:

NotebookServiceGrpc

public static interface NotebookServiceGrpc.AsyncService

 API v1 service for Cloud AI Platform Notebooks.
 

Method Summary

Modifier and Type	Method and Description
default void	createEnvironment(CreateEnvironmentRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver) Creates a new Environment.
default void	createExecution(CreateExecutionRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver) Creates a new Execution in a given project and location.
default void	createInstance(CreateInstanceRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver) Creates a new Instance in a given project and location.
default void	createSchedule(CreateScheduleRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver) Creates a new Scheduled Notebook in a given project and location.
default void	deleteEnvironment(DeleteEnvironmentRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver) Deletes a single Environment.
default void	deleteExecution(DeleteExecutionRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver) Deletes execution
default void	deleteInstance(DeleteInstanceRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver) Deletes a single Instance.
default void	deleteSchedule(DeleteScheduleRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver) Deletes schedule and all underlying jobs
default void	diagnoseInstance(DiagnoseInstanceRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver) Creates a Diagnostic File and runs Diagnostic Tool given an Instance.
default void	getEnvironment(GetEnvironmentRequest request, io.grpc.stub.StreamObserver<Environment> responseObserver) Gets details of a single Environment.
default void	getExecution(GetExecutionRequest request, io.grpc.stub.StreamObserver<Execution> responseObserver) Gets details of executions
default void	getInstance(GetInstanceRequest request, io.grpc.stub.StreamObserver<Instance> responseObserver) Gets details of a single Instance.
default void	getInstanceHealth(GetInstanceHealthRequest request, io.grpc.stub.StreamObserver<GetInstanceHealthResponse> responseObserver) Check if a notebook instance is healthy.
default void	getSchedule(GetScheduleRequest request, io.grpc.stub.StreamObserver<Schedule> responseObserver) Gets details of schedule
default void	isInstanceUpgradeable(IsInstanceUpgradeableRequest request, io.grpc.stub.StreamObserver<IsInstanceUpgradeableResponse> responseObserver) Check if a notebook instance is upgradable.
default void	listEnvironments(ListEnvironmentsRequest request, io.grpc.stub.StreamObserver<ListEnvironmentsResponse> responseObserver) Lists environments in a project.
default void	listExecutions(ListExecutionsRequest request, io.grpc.stub.StreamObserver<ListExecutionsResponse> responseObserver) Lists executions in a given project and location
default void	listInstances(ListInstancesRequest request, io.grpc.stub.StreamObserver<ListInstancesResponse> responseObserver) Lists instances in a given project and location.
default void	listSchedules(ListSchedulesRequest request, io.grpc.stub.StreamObserver<ListSchedulesResponse> responseObserver) Lists schedules in a given project and location.
default void	registerInstance(RegisterInstanceRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver) Registers an existing legacy notebook instance to the Notebooks API server.
default void	reportInstanceInfo(ReportInstanceInfoRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver) Allows notebook instances to report their latest instance information to the Notebooks API server.
default void	resetInstance(ResetInstanceRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver) Resets a notebook instance.
default void	rollbackInstance(RollbackInstanceRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver) Rollbacks a notebook instance to the previous version.
default void	setInstanceAccelerator(SetInstanceAcceleratorRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver) Updates the guest accelerators of a single Instance.
default void	setInstanceLabels(SetInstanceLabelsRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver) Replaces all the labels of an Instance.
default void	setInstanceMachineType(SetInstanceMachineTypeRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver) Updates the machine type of a single Instance.
default void	startInstance(StartInstanceRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver) Starts a notebook instance.
default void	stopInstance(StopInstanceRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver) Stops a notebook instance.
default void	triggerSchedule(TriggerScheduleRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver) Triggers execution of an existing schedule.
default void	updateInstanceConfig(UpdateInstanceConfigRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver) Update Notebook Instance configurations.
default void	updateInstanceMetadataItems(UpdateInstanceMetadataItemsRequest request, io.grpc.stub.StreamObserver<UpdateInstanceMetadataItemsResponse> responseObserver) Add/update metadata items for an instance.
default void	updateShieldedInstanceConfig(UpdateShieldedInstanceConfigRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver) Updates the Shielded instance configuration of a single Instance.
default void	upgradeInstance(UpgradeInstanceRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver) Upgrades a notebook instance to the latest version.
default void	upgradeInstanceInternal(UpgradeInstanceInternalRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver) Allows notebook instances to call this endpoint to upgrade themselves.

Method Detail

listInstances

default void listInstances(ListInstancesRequest request,
                           io.grpc.stub.StreamObserver<ListInstancesResponse> responseObserver)

 Lists instances in a given project and location.
 

getInstance

default void getInstance(GetInstanceRequest request,
                         io.grpc.stub.StreamObserver<Instance> responseObserver)

 Gets details of a single Instance.
 

createInstance

default void createInstance(CreateInstanceRequest request,
                            io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)

 Creates a new Instance in a given project and location.
 

registerInstance

default void registerInstance(RegisterInstanceRequest request,
                              io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)

 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.
 

setInstanceAccelerator

default void setInstanceAccelerator(SetInstanceAcceleratorRequest request,
                                    io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)

 Updates the guest accelerators of a single Instance.
 

setInstanceMachineType

default void setInstanceMachineType(SetInstanceMachineTypeRequest request,
                                    io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)

 Updates the machine type of a single Instance.
 

updateInstanceConfig

default void updateInstanceConfig(UpdateInstanceConfigRequest request,
                                  io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)

 Update Notebook Instance configurations.
 

updateShieldedInstanceConfig

default void updateShieldedInstanceConfig(UpdateShieldedInstanceConfigRequest request,
                                          io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)

 Updates the Shielded instance configuration of a single Instance.
 

setInstanceLabels

default void setInstanceLabels(SetInstanceLabelsRequest request,
                               io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)

 Replaces all the labels of an Instance.
 

updateInstanceMetadataItems

default void updateInstanceMetadataItems(UpdateInstanceMetadataItemsRequest request,
                                         io.grpc.stub.StreamObserver<UpdateInstanceMetadataItemsResponse> responseObserver)

 Add/update metadata items for an instance.
 

deleteInstance

default void deleteInstance(DeleteInstanceRequest request,
                            io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)

 Deletes a single Instance.
 

startInstance

default void startInstance(StartInstanceRequest request,
                           io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)

 Starts a notebook instance.
 

stopInstance

default void stopInstance(StopInstanceRequest request,
                          io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)

 Stops a notebook instance.
 

resetInstance

default void resetInstance(ResetInstanceRequest request,
                           io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)

 Resets a notebook instance.
 

reportInstanceInfo

default void reportInstanceInfo(ReportInstanceInfoRequest request,
                                io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)

 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.
 

isInstanceUpgradeable

default void isInstanceUpgradeable(IsInstanceUpgradeableRequest request,
                                   io.grpc.stub.StreamObserver<IsInstanceUpgradeableResponse> responseObserver)

 Check if a notebook instance is upgradable.
 

getInstanceHealth

default void getInstanceHealth(GetInstanceHealthRequest request,
                               io.grpc.stub.StreamObserver<GetInstanceHealthResponse> responseObserver)

 Check if a notebook instance is healthy.
 

upgradeInstance

default void upgradeInstance(UpgradeInstanceRequest request,
                             io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)

 Upgrades a notebook instance to the latest version.
 

rollbackInstance

default void rollbackInstance(RollbackInstanceRequest request,
                              io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)

 Rollbacks a notebook instance to the previous version.
 

diagnoseInstance

default void diagnoseInstance(DiagnoseInstanceRequest request,
                              io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)

 Creates a Diagnostic File and runs Diagnostic Tool given an Instance.
 

upgradeInstanceInternal

default void upgradeInstanceInternal(UpgradeInstanceInternalRequest request,
                                     io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)

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

listEnvironments

default void listEnvironments(ListEnvironmentsRequest request,
                              io.grpc.stub.StreamObserver<ListEnvironmentsResponse> responseObserver)

 Lists environments in a project.
 

getEnvironment

default void getEnvironment(GetEnvironmentRequest request,
                            io.grpc.stub.StreamObserver<Environment> responseObserver)

 Gets details of a single Environment.
 

createEnvironment

default void createEnvironment(CreateEnvironmentRequest request,
                               io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)

 Creates a new Environment.
 

deleteEnvironment

default void deleteEnvironment(DeleteEnvironmentRequest request,
                               io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)

 Deletes a single Environment.
 

listSchedules

default void listSchedules(ListSchedulesRequest request,
                           io.grpc.stub.StreamObserver<ListSchedulesResponse> responseObserver)

 Lists schedules in a given project and location.
 

getSchedule

default void getSchedule(GetScheduleRequest request,
                         io.grpc.stub.StreamObserver<Schedule> responseObserver)

 Gets details of schedule
 

deleteSchedule

default void deleteSchedule(DeleteScheduleRequest request,
                            io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)

 Deletes schedule and all underlying jobs
 

createSchedule

default void createSchedule(CreateScheduleRequest request,
                            io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)

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

triggerSchedule

default void triggerSchedule(TriggerScheduleRequest request,
                             io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)

 Triggers execution of an existing schedule.
 

listExecutions

default void listExecutions(ListExecutionsRequest request,
                            io.grpc.stub.StreamObserver<ListExecutionsResponse> responseObserver)

 Lists executions in a given project and location
 

getExecution

default void getExecution(GetExecutionRequest request,
                          io.grpc.stub.StreamObserver<Execution> responseObserver)

 Gets details of executions
 

deleteExecution

default void deleteExecution(DeleteExecutionRequest request,
                             io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)

 Deletes execution
 

createExecution

default void createExecution(CreateExecutionRequest request,
                             io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)

 Creates a new Execution in a given project and location.