Class NotebookServiceGrpc.NotebookServiceBlockingStub (1.43.0)

public static final class NotebookServiceGrpc.NotebookServiceBlockingStub extends AbstractBlockingStub<NotebookServiceGrpc.NotebookServiceBlockingStub>

A stub to allow clients to do synchronous rpc calls to service NotebookService.

API v1 service for Cloud AI Platform Notebooks.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractBlockingStub > NotebookServiceGrpc.NotebookServiceBlockingStub

Methods

build(Channel channel, CallOptions callOptions)

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

createEnvironment(CreateEnvironmentRequest request)

public Operation createEnvironment(CreateEnvironmentRequest request)

Creates a new Environment.

Parameter
Name Description
request CreateEnvironmentRequest
Returns
Type Description
Operation

createExecution(CreateExecutionRequest request)

public Operation createExecution(CreateExecutionRequest request)

Creates a new Execution in a given project and location.

Parameter
Name Description
request CreateExecutionRequest
Returns
Type Description
Operation

createInstance(CreateInstanceRequest request)

public Operation createInstance(CreateInstanceRequest request)

Creates a new Instance in a given project and location.

Parameter
Name Description
request CreateInstanceRequest
Returns
Type Description
Operation

createSchedule(CreateScheduleRequest request)

public Operation createSchedule(CreateScheduleRequest request)

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

Parameter
Name Description
request CreateScheduleRequest
Returns
Type Description
Operation

deleteEnvironment(DeleteEnvironmentRequest request)

public Operation deleteEnvironment(DeleteEnvironmentRequest request)

Deletes a single Environment.

Parameter
Name Description
request DeleteEnvironmentRequest
Returns
Type Description
Operation

deleteExecution(DeleteExecutionRequest request)

public Operation deleteExecution(DeleteExecutionRequest request)

Deletes execution

Parameter
Name Description
request DeleteExecutionRequest
Returns
Type Description
Operation

deleteInstance(DeleteInstanceRequest request)

public Operation deleteInstance(DeleteInstanceRequest request)

Deletes a single Instance.

Parameter
Name Description
request DeleteInstanceRequest
Returns
Type Description
Operation

deleteSchedule(DeleteScheduleRequest request)

public Operation deleteSchedule(DeleteScheduleRequest request)

Deletes schedule and all underlying jobs

Parameter
Name Description
request DeleteScheduleRequest
Returns
Type Description
Operation

diagnoseInstance(DiagnoseInstanceRequest request)

public Operation diagnoseInstance(DiagnoseInstanceRequest request)

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

Parameter
Name Description
request DiagnoseInstanceRequest
Returns
Type Description
Operation

getEnvironment(GetEnvironmentRequest request)

public Environment getEnvironment(GetEnvironmentRequest request)

Gets details of a single Environment.

Parameter
Name Description
request GetEnvironmentRequest
Returns
Type Description
Environment

getExecution(GetExecutionRequest request)

public Execution getExecution(GetExecutionRequest request)

Gets details of executions

Parameter
Name Description
request GetExecutionRequest
Returns
Type Description
Execution

getInstance(GetInstanceRequest request)

public Instance getInstance(GetInstanceRequest request)

Gets details of a single Instance.

Parameter
Name Description
request GetInstanceRequest
Returns
Type Description
Instance

getInstanceHealth(GetInstanceHealthRequest request)

public GetInstanceHealthResponse getInstanceHealth(GetInstanceHealthRequest request)

Check if a notebook instance is healthy.

Parameter
Name Description
request GetInstanceHealthRequest
Returns
Type Description
GetInstanceHealthResponse

getSchedule(GetScheduleRequest request)

public Schedule getSchedule(GetScheduleRequest request)

Gets details of schedule

Parameter
Name Description
request GetScheduleRequest
Returns
Type Description
Schedule

isInstanceUpgradeable(IsInstanceUpgradeableRequest request)

public IsInstanceUpgradeableResponse isInstanceUpgradeable(IsInstanceUpgradeableRequest request)

Check if a notebook instance is upgradable.

Parameter
Name Description
request IsInstanceUpgradeableRequest
Returns
Type Description
IsInstanceUpgradeableResponse

listEnvironments(ListEnvironmentsRequest request)

public ListEnvironmentsResponse listEnvironments(ListEnvironmentsRequest request)

Lists environments in a project.

Parameter
Name Description
request ListEnvironmentsRequest
Returns
Type Description
ListEnvironmentsResponse

listExecutions(ListExecutionsRequest request)

public ListExecutionsResponse listExecutions(ListExecutionsRequest request)

Lists executions in a given project and location

Parameter
Name Description
request ListExecutionsRequest
Returns
Type Description
ListExecutionsResponse

listInstances(ListInstancesRequest request)

public ListInstancesResponse listInstances(ListInstancesRequest request)

Lists instances in a given project and location.

Parameter
Name Description
request ListInstancesRequest
Returns
Type Description
ListInstancesResponse

listSchedules(ListSchedulesRequest request)

public ListSchedulesResponse listSchedules(ListSchedulesRequest request)

Lists schedules in a given project and location.

Parameter
Name Description
request ListSchedulesRequest
Returns
Type Description
ListSchedulesResponse

registerInstance(RegisterInstanceRequest request)

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

reportInstanceInfo(ReportInstanceInfoRequest request)

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

resetInstance(ResetInstanceRequest request)

public Operation resetInstance(ResetInstanceRequest request)

Resets a notebook instance.

Parameter
Name Description
request ResetInstanceRequest
Returns
Type Description
Operation

rollbackInstance(RollbackInstanceRequest request)

public Operation rollbackInstance(RollbackInstanceRequest request)

Rollbacks a notebook instance to the previous version.

Parameter
Name Description
request RollbackInstanceRequest
Returns
Type Description
Operation

setInstanceAccelerator(SetInstanceAcceleratorRequest request)

public Operation setInstanceAccelerator(SetInstanceAcceleratorRequest request)

Updates the guest accelerators of a single Instance.

Parameter
Name Description
request SetInstanceAcceleratorRequest
Returns
Type Description
Operation

setInstanceLabels(SetInstanceLabelsRequest request)

public Operation setInstanceLabels(SetInstanceLabelsRequest request)

Replaces all the labels of an Instance.

Parameter
Name Description
request SetInstanceLabelsRequest
Returns
Type Description
Operation

setInstanceMachineType(SetInstanceMachineTypeRequest request)

public Operation setInstanceMachineType(SetInstanceMachineTypeRequest request)

Updates the machine type of a single Instance.

Parameter
Name Description
request SetInstanceMachineTypeRequest
Returns
Type Description
Operation

startInstance(StartInstanceRequest request)

public Operation startInstance(StartInstanceRequest request)

Starts a notebook instance.

Parameter
Name Description
request StartInstanceRequest
Returns
Type Description
Operation

stopInstance(StopInstanceRequest request)

public Operation stopInstance(StopInstanceRequest request)

Stops a notebook instance.

Parameter
Name Description
request StopInstanceRequest
Returns
Type Description
Operation

triggerSchedule(TriggerScheduleRequest request)

public Operation triggerSchedule(TriggerScheduleRequest request)

Triggers execution of an existing schedule.

Parameter
Name Description
request TriggerScheduleRequest
Returns
Type Description
Operation

updateInstanceConfig(UpdateInstanceConfigRequest request)

public Operation updateInstanceConfig(UpdateInstanceConfigRequest request)

Update Notebook Instance configurations.

Parameter
Name Description
request UpdateInstanceConfigRequest
Returns
Type Description
Operation

updateInstanceMetadataItems(UpdateInstanceMetadataItemsRequest request)

public UpdateInstanceMetadataItemsResponse updateInstanceMetadataItems(UpdateInstanceMetadataItemsRequest request)

Add/update metadata items for an instance.

Parameter
Name Description
request UpdateInstanceMetadataItemsRequest
Returns
Type Description
UpdateInstanceMetadataItemsResponse

updateShieldedInstanceConfig(UpdateShieldedInstanceConfigRequest request)

public Operation updateShieldedInstanceConfig(UpdateShieldedInstanceConfigRequest request)

Updates the Shielded instance configuration of a single Instance.

Parameter
Name Description
request UpdateShieldedInstanceConfigRequest
Returns
Type Description
Operation

upgradeInstance(UpgradeInstanceRequest request)

public Operation upgradeInstance(UpgradeInstanceRequest request)

Upgrades a notebook instance to the latest version.

Parameter
Name Description
request UpgradeInstanceRequest
Returns
Type Description
Operation

upgradeInstanceInternal(UpgradeInstanceInternalRequest request)

public Operation upgradeInstanceInternal(UpgradeInstanceInternalRequest request)

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

Parameter
Name Description
request UpgradeInstanceInternalRequest
Returns
Type Description
Operation