Class NotebookServiceGrpc.NotebookServiceFutureStub (1.51.0)

public static final class NotebookServiceGrpc.NotebookServiceFutureStub extends AbstractFutureStub<NotebookServiceGrpc.NotebookServiceFutureStub>

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

API v1beta1 service for Cloud AI Platform Notebooks.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > NotebookServiceGrpc.NotebookServiceFutureStub

Methods

build(Channel channel, CallOptions callOptions)

protected NotebookServiceGrpc.NotebookServiceFutureStub build(Channel channel, CallOptions callOptions)
Parameters
Name Description
channel io.grpc.Channel
callOptions io.grpc.CallOptions
Returns
Type Description
NotebookServiceGrpc.NotebookServiceFutureStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createEnvironment(CreateEnvironmentRequest request)

public ListenableFuture<Operation> createEnvironment(CreateEnvironmentRequest request)

Creates a new Environment.

Parameter
Name Description
request CreateEnvironmentRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

createInstance(CreateInstanceRequest request)

public ListenableFuture<Operation> createInstance(CreateInstanceRequest request)

Creates a new Instance in a given project and location.

Parameter
Name Description
request CreateInstanceRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

deleteEnvironment(DeleteEnvironmentRequest request)

public ListenableFuture<Operation> deleteEnvironment(DeleteEnvironmentRequest request)

Deletes a single Environment.

Parameter
Name Description
request DeleteEnvironmentRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

deleteInstance(DeleteInstanceRequest request)

public ListenableFuture<Operation> deleteInstance(DeleteInstanceRequest request)

Deletes a single Instance.

Parameter
Name Description
request DeleteInstanceRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

getEnvironment(GetEnvironmentRequest request)

public ListenableFuture<Environment> getEnvironment(GetEnvironmentRequest request)

Gets details of a single Environment.

Parameter
Name Description
request GetEnvironmentRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Environment>

getInstance(GetInstanceRequest request)

public ListenableFuture<Instance> getInstance(GetInstanceRequest request)

Gets details of a single Instance.

Parameter
Name Description
request GetInstanceRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Instance>

isInstanceUpgradeable(IsInstanceUpgradeableRequest request) (deprecated)

public ListenableFuture<IsInstanceUpgradeableResponse> isInstanceUpgradeable(IsInstanceUpgradeableRequest request)

Check if a notebook instance is upgradable. Deprecated. Please consider using v1.

Parameter
Name Description
request IsInstanceUpgradeableRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<IsInstanceUpgradeableResponse>

listEnvironments(ListEnvironmentsRequest request)

public ListenableFuture<ListEnvironmentsResponse> listEnvironments(ListEnvironmentsRequest request)

Lists environments in a project.

Parameter
Name Description
request ListEnvironmentsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListEnvironmentsResponse>

listInstances(ListInstancesRequest request)

public ListenableFuture<ListInstancesResponse> listInstances(ListInstancesRequest request)

Lists instances in a given project and location.

Parameter
Name Description
request ListInstancesRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListInstancesResponse>

registerInstance(RegisterInstanceRequest request)

public ListenableFuture<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.

Parameter
Name Description
request RegisterInstanceRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

reportInstanceInfo(ReportInstanceInfoRequest request)

public ListenableFuture<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.

Parameter
Name Description
request ReportInstanceInfoRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

resetInstance(ResetInstanceRequest request)

public ListenableFuture<Operation> resetInstance(ResetInstanceRequest request)

Resets a notebook instance.

Parameter
Name Description
request ResetInstanceRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

setInstanceAccelerator(SetInstanceAcceleratorRequest request)

public ListenableFuture<Operation> setInstanceAccelerator(SetInstanceAcceleratorRequest request)

Updates the guest accelerators of a single Instance.

Parameter
Name Description
request SetInstanceAcceleratorRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

setInstanceLabels(SetInstanceLabelsRequest request)

public ListenableFuture<Operation> setInstanceLabels(SetInstanceLabelsRequest request)

Updates the labels of an Instance.

Parameter
Name Description
request SetInstanceLabelsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

setInstanceMachineType(SetInstanceMachineTypeRequest request)

public ListenableFuture<Operation> setInstanceMachineType(SetInstanceMachineTypeRequest request)

Updates the machine type of a single Instance.

Parameter
Name Description
request SetInstanceMachineTypeRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

startInstance(StartInstanceRequest request)

public ListenableFuture<Operation> startInstance(StartInstanceRequest request)

Starts a notebook instance.

Parameter
Name Description
request StartInstanceRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

stopInstance(StopInstanceRequest request)

public ListenableFuture<Operation> stopInstance(StopInstanceRequest request)

Stops a notebook instance.

Parameter
Name Description
request StopInstanceRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

upgradeInstance(UpgradeInstanceRequest request) (deprecated)

public ListenableFuture<Operation> upgradeInstance(UpgradeInstanceRequest request)

Upgrades a notebook instance to the latest version. Deprecated. Please consider using v1.

Parameter
Name Description
request UpgradeInstanceRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

upgradeInstanceInternal(UpgradeInstanceInternalRequest request) (deprecated)

public ListenableFuture<Operation> upgradeInstanceInternal(UpgradeInstanceInternalRequest request)

Allows notebook instances to call this endpoint to upgrade themselves. Do not use this method directly. Deprecated. Please consider using v1.

Parameter
Name Description
request UpgradeInstanceInternalRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>