com.google.cloud.notebooks.v1

Class NotebookServiceGrpc.NotebookServiceFutureStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractFutureStub<NotebookServiceGrpc.NotebookServiceFutureStub>

com.google.cloud.notebooks.v1.NotebookServiceGrpc.NotebookServiceFutureStub

Enclosing class:

NotebookServiceGrpc

public static final class NotebookServiceGrpc.NotebookServiceFutureStub
extends io.grpc.stub.AbstractFutureStub<NotebookServiceGrpc.NotebookServiceFutureStub>

A stub to allow clients to do ListenableFuture-style rpc calls to service NotebookService.

 API v1 service for Cloud AI Platform Notebooks.
 

Nested Class Summary

Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub

io.grpc.stub.AbstractStub.StubFactory<T extends io.grpc.stub.AbstractStub<T>>

Method Summary

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

Methods inherited from class io.grpc.stub.AbstractFutureStub

newStub, newStub

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOption, withWaitForReady

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

build

protected NotebookServiceGrpc.NotebookServiceFutureStub build(io.grpc.Channel channel,
                                                              io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<NotebookServiceGrpc.NotebookServiceFutureStub>

listInstances

public com.google.common.util.concurrent.ListenableFuture<ListInstancesResponse> listInstances(ListInstancesRequest request)

 Lists instances in a given project and location.
 

getInstance

public com.google.common.util.concurrent.ListenableFuture<Instance> getInstance(GetInstanceRequest request)

 Gets details of a single Instance.
 

createInstance

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> createInstance(CreateInstanceRequest request)

 Creates a new Instance in a given project and location.
 

registerInstance

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> registerInstance(RegisterInstanceRequest request)

 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

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> setInstanceAccelerator(SetInstanceAcceleratorRequest request)

 Updates the guest accelerators of a single Instance.
 

setInstanceMachineType

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> setInstanceMachineType(SetInstanceMachineTypeRequest request)

 Updates the machine type of a single Instance.
 

updateInstanceConfig

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> updateInstanceConfig(UpdateInstanceConfigRequest request)

 Update Notebook Instance configurations.
 

updateShieldedInstanceConfig

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> updateShieldedInstanceConfig(UpdateShieldedInstanceConfigRequest request)

 Updates the Shielded instance configuration of a single Instance.
 

setInstanceLabels

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> setInstanceLabels(SetInstanceLabelsRequest request)

 Replaces all the labels of an Instance.
 

updateInstanceMetadataItems

public com.google.common.util.concurrent.ListenableFuture<UpdateInstanceMetadataItemsResponse> updateInstanceMetadataItems(UpdateInstanceMetadataItemsRequest request)

 Add/update metadata items for an instance.
 

deleteInstance

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> deleteInstance(DeleteInstanceRequest request)

 Deletes a single Instance.
 

startInstance

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> startInstance(StartInstanceRequest request)

 Starts a notebook instance.
 

stopInstance

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> stopInstance(StopInstanceRequest request)

 Stops a notebook instance.
 

resetInstance

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> resetInstance(ResetInstanceRequest request)

 Resets a notebook instance.
 

reportInstanceInfo

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> reportInstanceInfo(ReportInstanceInfoRequest request)

 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

public com.google.common.util.concurrent.ListenableFuture<IsInstanceUpgradeableResponse> isInstanceUpgradeable(IsInstanceUpgradeableRequest request)

 Check if a notebook instance is upgradable.
 

getInstanceHealth

public com.google.common.util.concurrent.ListenableFuture<GetInstanceHealthResponse> getInstanceHealth(GetInstanceHealthRequest request)

 Check if a notebook instance is healthy.
 

upgradeInstance

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> upgradeInstance(UpgradeInstanceRequest request)

 Upgrades a notebook instance to the latest version.
 

rollbackInstance

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> rollbackInstance(RollbackInstanceRequest request)

 Rollbacks a notebook instance to the previous version.
 

diagnoseInstance

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> diagnoseInstance(DiagnoseInstanceRequest request)

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

upgradeInstanceInternal

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> upgradeInstanceInternal(UpgradeInstanceInternalRequest request)

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

listEnvironments

public com.google.common.util.concurrent.ListenableFuture<ListEnvironmentsResponse> listEnvironments(ListEnvironmentsRequest request)

 Lists environments in a project.
 

getEnvironment

public com.google.common.util.concurrent.ListenableFuture<Environment> getEnvironment(GetEnvironmentRequest request)

 Gets details of a single Environment.
 

createEnvironment

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> createEnvironment(CreateEnvironmentRequest request)

 Creates a new Environment.
 

deleteEnvironment

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> deleteEnvironment(DeleteEnvironmentRequest request)

 Deletes a single Environment.
 

listSchedules

public com.google.common.util.concurrent.ListenableFuture<ListSchedulesResponse> listSchedules(ListSchedulesRequest request)

 Lists schedules in a given project and location.
 

getSchedule

public com.google.common.util.concurrent.ListenableFuture<Schedule> getSchedule(GetScheduleRequest request)

 Gets details of schedule
 

deleteSchedule

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> deleteSchedule(DeleteScheduleRequest request)

 Deletes schedule and all underlying jobs
 

createSchedule

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> createSchedule(CreateScheduleRequest request)

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

triggerSchedule

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> triggerSchedule(TriggerScheduleRequest request)

 Triggers execution of an existing schedule.
 

listExecutions

public com.google.common.util.concurrent.ListenableFuture<ListExecutionsResponse> listExecutions(ListExecutionsRequest request)

 Lists executions in a given project and location
 

getExecution

public com.google.common.util.concurrent.ListenableFuture<Execution> getExecution(GetExecutionRequest request)

 Gets details of executions
 

deleteExecution

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> deleteExecution(DeleteExecutionRequest request)

 Deletes execution
 

createExecution

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> createExecution(CreateExecutionRequest request)

 Creates a new Execution in a given project and location.