Interface NotebookServiceGrpc.AsyncService (1.28.0)

public static interface NotebookServiceGrpc.AsyncService

API v1 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
NameDescription
requestCreateEnvironmentRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

createExecution(CreateExecutionRequest request, StreamObserver<Operation> responseObserver)

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

Creates a new Execution in a given project and location.

Parameters
NameDescription
requestCreateExecutionRequest
responseObserverio.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
NameDescription
requestCreateInstanceRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

createSchedule(CreateScheduleRequest request, StreamObserver<Operation> responseObserver)

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

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

Parameters
NameDescription
requestCreateScheduleRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

deleteEnvironment(DeleteEnvironmentRequest request, StreamObserver<Operation> responseObserver)

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

Deletes a single Environment.

Parameters
NameDescription
requestDeleteEnvironmentRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

deleteExecution(DeleteExecutionRequest request, StreamObserver<Operation> responseObserver)

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

Deletes execution

Parameters
NameDescription
requestDeleteExecutionRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

deleteInstance(DeleteInstanceRequest request, StreamObserver<Operation> responseObserver)

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

Deletes a single Instance.

Parameters
NameDescription
requestDeleteInstanceRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

deleteSchedule(DeleteScheduleRequest request, StreamObserver<Operation> responseObserver)

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

Deletes schedule and all underlying jobs

Parameters
NameDescription
requestDeleteScheduleRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

diagnoseInstance(DiagnoseInstanceRequest request, StreamObserver<Operation> responseObserver)

public default void diagnoseInstance(DiagnoseInstanceRequest request, StreamObserver<Operation> responseObserver)

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

Parameters
NameDescription
requestDiagnoseInstanceRequest
responseObserverio.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
NameDescription
requestGetEnvironmentRequest
responseObserverio.grpc.stub.StreamObserver<Environment>

getExecution(GetExecutionRequest request, StreamObserver<Execution> responseObserver)

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

Gets details of executions

Parameters
NameDescription
requestGetExecutionRequest
responseObserverio.grpc.stub.StreamObserver<Execution>

getInstance(GetInstanceRequest request, StreamObserver<Instance> responseObserver)

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

Gets details of a single Instance.

Parameters
NameDescription
requestGetInstanceRequest
responseObserverio.grpc.stub.StreamObserver<Instance>

getInstanceHealth(GetInstanceHealthRequest request, StreamObserver<GetInstanceHealthResponse> responseObserver)

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

Check if a notebook instance is healthy.

Parameters
NameDescription
requestGetInstanceHealthRequest
responseObserverio.grpc.stub.StreamObserver<GetInstanceHealthResponse>

getSchedule(GetScheduleRequest request, StreamObserver<Schedule> responseObserver)

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

Gets details of schedule

Parameters
NameDescription
requestGetScheduleRequest
responseObserverio.grpc.stub.StreamObserver<Schedule>

isInstanceUpgradeable(IsInstanceUpgradeableRequest request, StreamObserver<IsInstanceUpgradeableResponse> responseObserver)

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

Check if a notebook instance is upgradable.

Parameters
NameDescription
requestIsInstanceUpgradeableRequest
responseObserverio.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
NameDescription
requestListEnvironmentsRequest
responseObserverio.grpc.stub.StreamObserver<ListEnvironmentsResponse>

listExecutions(ListExecutionsRequest request, StreamObserver<ListExecutionsResponse> responseObserver)

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

Lists executions in a given project and location

Parameters
NameDescription
requestListExecutionsRequest
responseObserverio.grpc.stub.StreamObserver<ListExecutionsResponse>

listInstances(ListInstancesRequest request, StreamObserver<ListInstancesResponse> responseObserver)

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

Lists instances in a given project and location.

Parameters
NameDescription
requestListInstancesRequest
responseObserverio.grpc.stub.StreamObserver<ListInstancesResponse>

listSchedules(ListSchedulesRequest request, StreamObserver<ListSchedulesResponse> responseObserver)

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

Lists schedules in a given project and location.

Parameters
NameDescription
requestListSchedulesRequest
responseObserverio.grpc.stub.StreamObserver<ListSchedulesResponse>

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
NameDescription
requestRegisterInstanceRequest
responseObserverio.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
NameDescription
requestReportInstanceInfoRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

resetInstance(ResetInstanceRequest request, StreamObserver<Operation> responseObserver)

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

Resets a notebook instance.

Parameters
NameDescription
requestResetInstanceRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

rollbackInstance(RollbackInstanceRequest request, StreamObserver<Operation> responseObserver)

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

Rollbacks a notebook instance to the previous version.

Parameters
NameDescription
requestRollbackInstanceRequest
responseObserverio.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
NameDescription
requestSetInstanceAcceleratorRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

setInstanceLabels(SetInstanceLabelsRequest request, StreamObserver<Operation> responseObserver)

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

Replaces all the labels of an Instance.

Parameters
NameDescription
requestSetInstanceLabelsRequest
responseObserverio.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
NameDescription
requestSetInstanceMachineTypeRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

startInstance(StartInstanceRequest request, StreamObserver<Operation> responseObserver)

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

Starts a notebook instance.

Parameters
NameDescription
requestStartInstanceRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

stopInstance(StopInstanceRequest request, StreamObserver<Operation> responseObserver)

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

Stops a notebook instance.

Parameters
NameDescription
requestStopInstanceRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

triggerSchedule(TriggerScheduleRequest request, StreamObserver<Operation> responseObserver)

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

Triggers execution of an existing schedule.

Parameters
NameDescription
requestTriggerScheduleRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

updateInstanceConfig(UpdateInstanceConfigRequest request, StreamObserver<Operation> responseObserver)

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

Update Notebook Instance configurations.

Parameters
NameDescription
requestUpdateInstanceConfigRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

updateInstanceMetadataItems(UpdateInstanceMetadataItemsRequest request, StreamObserver<UpdateInstanceMetadataItemsResponse> responseObserver)

public default void updateInstanceMetadataItems(UpdateInstanceMetadataItemsRequest request, StreamObserver<UpdateInstanceMetadataItemsResponse> responseObserver)

Add/update metadata items for an instance.

Parameters
NameDescription
requestUpdateInstanceMetadataItemsRequest
responseObserverio.grpc.stub.StreamObserver<UpdateInstanceMetadataItemsResponse>

updateShieldedInstanceConfig(UpdateShieldedInstanceConfigRequest request, StreamObserver<Operation> responseObserver)

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

Updates the Shielded instance configuration of a single Instance.

Parameters
NameDescription
requestUpdateShieldedInstanceConfigRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

upgradeInstance(UpgradeInstanceRequest request, StreamObserver<Operation> responseObserver)

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

Upgrades a notebook instance to the latest version.

Parameters
NameDescription
requestUpgradeInstanceRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

upgradeInstanceInternal(UpgradeInstanceInternalRequest request, StreamObserver<Operation> responseObserver)

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.

Parameters
NameDescription
requestUpgradeInstanceInternalRequest
responseObserverio.grpc.stub.StreamObserver<Operation>