Class NotebookServiceGrpc.NotebookServiceImplBase (0.6.2)

public abstract static class NotebookServiceGrpc.NotebookServiceImplBase implements BindableService

API v1 service for Cloud AI Platform Notebooks.

Inheritance

java.lang.Object > NotebookServiceGrpc.NotebookServiceImplBase

Implements

io.grpc.BindableService

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Constructors

NotebookServiceImplBase()

public NotebookServiceImplBase()

Methods

bindService()

public final ServerServiceDefinition bindService()

Returns

Type	Description
io.grpc.ServerServiceDefinition

createEnvironment(CreateEnvironmentRequest request, StreamObserver<Operation> responseObserver)

public void createEnvironment(CreateEnvironmentRequest request, StreamObserver<Operation> responseObserver)

Creates a new Environment.

Parameters

Name	Description
request	`CreateEnvironmentRequest`
responseObserver	`io.grpc.stub.StreamObserver<Operation>`

createExecution(CreateExecutionRequest request, StreamObserver<Operation> responseObserver)

public void createExecution(CreateExecutionRequest request, StreamObserver<Operation> responseObserver)

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

Parameters

Name	Description
request	`CreateExecutionRequest`
responseObserver	`io.grpc.stub.StreamObserver<Operation>`

createInstance(CreateInstanceRequest request, StreamObserver<Operation> responseObserver)

public void createInstance(CreateInstanceRequest request, StreamObserver<Operation> responseObserver)

Creates a new Instance in a given project and location.

Parameters

Name	Description
request	`CreateInstanceRequest`
responseObserver	`io.grpc.stub.StreamObserver<Operation>`

createSchedule(CreateScheduleRequest request, StreamObserver<Operation> responseObserver)

public void createSchedule(CreateScheduleRequest request, StreamObserver<Operation> responseObserver)

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

Parameters

Name	Description
request	`CreateScheduleRequest`
responseObserver	`io.grpc.stub.StreamObserver<Operation>`

deleteEnvironment(DeleteEnvironmentRequest request, StreamObserver<Operation> responseObserver)

public void deleteEnvironment(DeleteEnvironmentRequest request, StreamObserver<Operation> responseObserver)

Deletes a single Environment.

Parameters

Name	Description
request	`DeleteEnvironmentRequest`
responseObserver	`io.grpc.stub.StreamObserver<Operation>`

deleteExecution(DeleteExecutionRequest request, StreamObserver<Operation> responseObserver)

public void deleteExecution(DeleteExecutionRequest request, StreamObserver<Operation> responseObserver)

Deletes execution

Parameters

Name	Description
request	`DeleteExecutionRequest`
responseObserver	`io.grpc.stub.StreamObserver<Operation>`

deleteInstance(DeleteInstanceRequest request, StreamObserver<Operation> responseObserver)

public void deleteInstance(DeleteInstanceRequest request, StreamObserver<Operation> responseObserver)

Deletes a single Instance.

Parameters

Name	Description
request	`DeleteInstanceRequest`
responseObserver	`io.grpc.stub.StreamObserver<Operation>`

deleteSchedule(DeleteScheduleRequest request, StreamObserver<Operation> responseObserver)

public void deleteSchedule(DeleteScheduleRequest request, StreamObserver<Operation> responseObserver)

Deletes schedule and all underlying jobs

Parameters

Name	Description
request	`DeleteScheduleRequest`
responseObserver	`io.grpc.stub.StreamObserver<Operation>`

getEnvironment(GetEnvironmentRequest request, StreamObserver<Environment> responseObserver)

public void getEnvironment(GetEnvironmentRequest request, StreamObserver<Environment> responseObserver)

Gets details of a single Environment.

Parameters

Name	Description
request	`GetEnvironmentRequest`
responseObserver	`io.grpc.stub.StreamObserver<Environment>`

getExecution(GetExecutionRequest request, StreamObserver<Execution> responseObserver)

public void getExecution(GetExecutionRequest request, StreamObserver<Execution> responseObserver)

Gets details of executions

Parameters

Name	Description
request	`GetExecutionRequest`
responseObserver	`io.grpc.stub.StreamObserver<Execution>`

getInstance(GetInstanceRequest request, StreamObserver<Instance> responseObserver)

public void getInstance(GetInstanceRequest request, StreamObserver<Instance> responseObserver)

Gets details of a single Instance.

Parameters

Name	Description
request	`GetInstanceRequest`
responseObserver	`io.grpc.stub.StreamObserver<Instance>`

getInstanceHealth(GetInstanceHealthRequest request, StreamObserver<GetInstanceHealthResponse> responseObserver)

public void getInstanceHealth(GetInstanceHealthRequest request, StreamObserver<GetInstanceHealthResponse> responseObserver)

Check if a notebook instance is healthy.

Parameters

Name	Description
request	`GetInstanceHealthRequest`
responseObserver	`io.grpc.stub.StreamObserver<GetInstanceHealthResponse>`

getSchedule(GetScheduleRequest request, StreamObserver<Schedule> responseObserver)

public void getSchedule(GetScheduleRequest request, StreamObserver<Schedule> responseObserver)

Gets details of schedule

Parameters

Name	Description
request	`GetScheduleRequest`
responseObserver	`io.grpc.stub.StreamObserver<Schedule>`

isInstanceUpgradeable(IsInstanceUpgradeableRequest request, StreamObserver<IsInstanceUpgradeableResponse> responseObserver)

public void isInstanceUpgradeable(IsInstanceUpgradeableRequest request, StreamObserver<IsInstanceUpgradeableResponse> responseObserver)

Check if a notebook instance is upgradable.

Parameters

Name	Description
request	`IsInstanceUpgradeableRequest`
responseObserver	`io.grpc.stub.StreamObserver<IsInstanceUpgradeableResponse>`

listEnvironments(ListEnvironmentsRequest request, StreamObserver<ListEnvironmentsResponse> responseObserver)

public void listEnvironments(ListEnvironmentsRequest request, StreamObserver<ListEnvironmentsResponse> responseObserver)

Lists environments in a project.

Parameters

Name	Description
request	`ListEnvironmentsRequest`
responseObserver	`io.grpc.stub.StreamObserver<ListEnvironmentsResponse>`

listExecutions(ListExecutionsRequest request, StreamObserver<ListExecutionsResponse> responseObserver)

public void listExecutions(ListExecutionsRequest request, StreamObserver<ListExecutionsResponse> responseObserver)

Lists executions in a given project and location

Parameters

Name	Description
request	`ListExecutionsRequest`
responseObserver	`io.grpc.stub.StreamObserver<ListExecutionsResponse>`

listInstances(ListInstancesRequest request, StreamObserver<ListInstancesResponse> responseObserver)

public void listInstances(ListInstancesRequest request, StreamObserver<ListInstancesResponse> responseObserver)

Lists instances in a given project and location.

Parameters

Name	Description
request	`ListInstancesRequest`
responseObserver	`io.grpc.stub.StreamObserver<ListInstancesResponse>`

listSchedules(ListSchedulesRequest request, StreamObserver<ListSchedulesResponse> responseObserver)

public void listSchedules(ListSchedulesRequest request, StreamObserver<ListSchedulesResponse> responseObserver)

Lists schedules in a given project and location.

Parameters

Name	Description
request	`ListSchedulesRequest`
responseObserver	`io.grpc.stub.StreamObserver<ListSchedulesResponse>`

registerInstance(RegisterInstanceRequest request, StreamObserver<Operation> responseObserver)

public void registerInstance(RegisterInstanceRequest request, StreamObserver<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.

Parameters

Name	Description
request	`RegisterInstanceRequest`
responseObserver	`io.grpc.stub.StreamObserver<Operation>`

reportInstanceInfo(ReportInstanceInfoRequest request, StreamObserver<Operation> responseObserver)

public void reportInstanceInfo(ReportInstanceInfoRequest request, StreamObserver<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.

Parameters

Name	Description
request	`ReportInstanceInfoRequest`
responseObserver	`io.grpc.stub.StreamObserver<Operation>`

resetInstance(ResetInstanceRequest request, StreamObserver<Operation> responseObserver)

public void resetInstance(ResetInstanceRequest request, StreamObserver<Operation> responseObserver)

Resets a notebook instance.

Parameters

Name	Description
request	`ResetInstanceRequest`
responseObserver	`io.grpc.stub.StreamObserver<Operation>`

rollbackInstance(RollbackInstanceRequest request, StreamObserver<Operation> responseObserver)

public void rollbackInstance(RollbackInstanceRequest request, StreamObserver<Operation> responseObserver)

Rollbacks a notebook instance to the previous version.

Parameters

Name	Description
request	`RollbackInstanceRequest`
responseObserver	`io.grpc.stub.StreamObserver<Operation>`

setInstanceAccelerator(SetInstanceAcceleratorRequest request, StreamObserver<Operation> responseObserver)

public void setInstanceAccelerator(SetInstanceAcceleratorRequest request, StreamObserver<Operation> responseObserver)

Updates the guest accelerators of a single Instance.

Parameters

Name	Description
request	`SetInstanceAcceleratorRequest`
responseObserver	`io.grpc.stub.StreamObserver<Operation>`

setInstanceLabels(SetInstanceLabelsRequest request, StreamObserver<Operation> responseObserver)

public void setInstanceLabels(SetInstanceLabelsRequest request, StreamObserver<Operation> responseObserver)

Replaces all the labels of an Instance.

Parameters

Name	Description
request	`SetInstanceLabelsRequest`
responseObserver	`io.grpc.stub.StreamObserver<Operation>`

setInstanceMachineType(SetInstanceMachineTypeRequest request, StreamObserver<Operation> responseObserver)

public void setInstanceMachineType(SetInstanceMachineTypeRequest request, StreamObserver<Operation> responseObserver)

Updates the machine type of a single Instance.

Parameters

Name	Description
request	`SetInstanceMachineTypeRequest`
responseObserver	`io.grpc.stub.StreamObserver<Operation>`

startInstance(StartInstanceRequest request, StreamObserver<Operation> responseObserver)

public void startInstance(StartInstanceRequest request, StreamObserver<Operation> responseObserver)

Starts a notebook instance.

Parameters

Name	Description
request	`StartInstanceRequest`
responseObserver	`io.grpc.stub.StreamObserver<Operation>`

stopInstance(StopInstanceRequest request, StreamObserver<Operation> responseObserver)

public void stopInstance(StopInstanceRequest request, StreamObserver<Operation> responseObserver)

Stops a notebook instance.

Parameters

Name	Description
request	`StopInstanceRequest`
responseObserver	`io.grpc.stub.StreamObserver<Operation>`

triggerSchedule(TriggerScheduleRequest request, StreamObserver<Operation> responseObserver)

public void triggerSchedule(TriggerScheduleRequest request, StreamObserver<Operation> responseObserver)

Triggers execution of an existing schedule.

Parameters

Name	Description
request	`TriggerScheduleRequest`
responseObserver	`io.grpc.stub.StreamObserver<Operation>`

updateInstanceConfig(UpdateInstanceConfigRequest request, StreamObserver<Operation> responseObserver)

public void updateInstanceConfig(UpdateInstanceConfigRequest request, StreamObserver<Operation> responseObserver)

Update Notebook Instance configurations.

Parameters

Name	Description
request	`UpdateInstanceConfigRequest`
responseObserver	`io.grpc.stub.StreamObserver<Operation>`

updateShieldedInstanceConfig(UpdateShieldedInstanceConfigRequest request, StreamObserver<Operation> responseObserver)

public void updateShieldedInstanceConfig(UpdateShieldedInstanceConfigRequest request, StreamObserver<Operation> responseObserver)

Updates the Shielded instance configuration of a single Instance.

Parameters

Name	Description
request	`UpdateShieldedInstanceConfigRequest`
responseObserver	`io.grpc.stub.StreamObserver<Operation>`

upgradeInstance(UpgradeInstanceRequest request, StreamObserver<Operation> responseObserver)

public void upgradeInstance(UpgradeInstanceRequest request, StreamObserver<Operation> responseObserver)

Upgrades a notebook instance to the latest version.

Parameters

Name	Description
request	`UpgradeInstanceRequest`
responseObserver	`io.grpc.stub.StreamObserver<Operation>`

upgradeInstanceInternal(UpgradeInstanceInternalRequest request, StreamObserver<Operation> responseObserver)

public void upgradeInstanceInternal(UpgradeInstanceInternalRequest request, StreamObserver<Operation> responseObserver)

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

Parameters

Name	Description
request	`UpgradeInstanceInternalRequest`
responseObserver	`io.grpc.stub.StreamObserver<Operation>`