Interface NotebookServiceGrpc.AsyncService (1.47.0)

public static interface NotebookServiceGrpc.AsyncService

API v1beta1 service for Cloud AI Platform Notebooks.

Methods

createEnvironment(CreateEnvironmentRequest request, StreamObserver<Operation> responseObserver)

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

Creates a new Environment.

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

createInstance(CreateInstanceRequest request, StreamObserver<Operation> responseObserver)

public default 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>

deleteEnvironment(DeleteEnvironmentRequest request, StreamObserver<Operation> responseObserver)

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

Deletes a single Environment.

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

deleteInstance(DeleteInstanceRequest request, StreamObserver<Operation> responseObserver)

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

Deletes a single Instance.

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

getEnvironment(GetEnvironmentRequest request, StreamObserver<Environment> responseObserver)

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

Gets details of a single Environment.

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

getInstance(GetInstanceRequest request, StreamObserver<Instance> responseObserver)

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

Gets details of a single Instance.

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

isInstanceUpgradeable(IsInstanceUpgradeableRequest request, StreamObserver<IsInstanceUpgradeableResponse> responseObserver) (deprecated)

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

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

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

listEnvironments(ListEnvironmentsRequest request, StreamObserver<ListEnvironmentsResponse> responseObserver)

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

Lists environments in a project.

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

listInstances(ListInstancesRequest request, StreamObserver<ListInstancesResponse> responseObserver)

public default 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>

registerInstance(RegisterInstanceRequest request, StreamObserver<Operation> responseObserver)

public default 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 default 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 default void resetInstance(ResetInstanceRequest request, StreamObserver<Operation> responseObserver)

Resets a notebook instance.

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

setInstanceAccelerator(SetInstanceAcceleratorRequest request, StreamObserver<Operation> responseObserver)

public default 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 default void setInstanceLabels(SetInstanceLabelsRequest request, StreamObserver<Operation> responseObserver)

Updates the labels of an Instance.

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

setInstanceMachineType(SetInstanceMachineTypeRequest request, StreamObserver<Operation> responseObserver)

public default 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 default 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 default void stopInstance(StopInstanceRequest request, StreamObserver<Operation> responseObserver)

Stops a notebook instance.

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

upgradeInstance(UpgradeInstanceRequest request, StreamObserver<Operation> responseObserver) (deprecated)

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

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

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

upgradeInstanceInternal(UpgradeInstanceInternalRequest request, StreamObserver<Operation> responseObserver) (deprecated)

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

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

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