Class NotebookServiceGrpc.NotebookServiceBlockingStub (1.39.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
NameDescription
channelio.grpc.Channel
callOptionsio.grpc.CallOptions
Returns
TypeDescription
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
NameDescription
requestCreateEnvironmentRequest
Returns
TypeDescription
Operation

createExecution(CreateExecutionRequest request)

public Operation createExecution(CreateExecutionRequest request)

Creates a new Execution in a given project and location.

Parameter
NameDescription
requestCreateExecutionRequest
Returns
TypeDescription
Operation

createInstance(CreateInstanceRequest request)

public Operation createInstance(CreateInstanceRequest request)

Creates a new Instance in a given project and location.

Parameter
NameDescription
requestCreateInstanceRequest
Returns
TypeDescription
Operation

createSchedule(CreateScheduleRequest request)

public Operation createSchedule(CreateScheduleRequest request)

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

Parameter
NameDescription
requestCreateScheduleRequest
Returns
TypeDescription
Operation

deleteEnvironment(DeleteEnvironmentRequest request)

public Operation deleteEnvironment(DeleteEnvironmentRequest request)

Deletes a single Environment.

Parameter
NameDescription
requestDeleteEnvironmentRequest
Returns
TypeDescription
Operation

deleteExecution(DeleteExecutionRequest request)

public Operation deleteExecution(DeleteExecutionRequest request)

Deletes execution

Parameter
NameDescription
requestDeleteExecutionRequest
Returns
TypeDescription
Operation

deleteInstance(DeleteInstanceRequest request)

public Operation deleteInstance(DeleteInstanceRequest request)

Deletes a single Instance.

Parameter
NameDescription
requestDeleteInstanceRequest
Returns
TypeDescription
Operation

deleteSchedule(DeleteScheduleRequest request)

public Operation deleteSchedule(DeleteScheduleRequest request)

Deletes schedule and all underlying jobs

Parameter
NameDescription
requestDeleteScheduleRequest
Returns
TypeDescription
Operation

diagnoseInstance(DiagnoseInstanceRequest request)

public Operation diagnoseInstance(DiagnoseInstanceRequest request)

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

Parameter
NameDescription
requestDiagnoseInstanceRequest
Returns
TypeDescription
Operation

getEnvironment(GetEnvironmentRequest request)

public Environment getEnvironment(GetEnvironmentRequest request)

Gets details of a single Environment.

Parameter
NameDescription
requestGetEnvironmentRequest
Returns
TypeDescription
Environment

getExecution(GetExecutionRequest request)

public Execution getExecution(GetExecutionRequest request)

Gets details of executions

Parameter
NameDescription
requestGetExecutionRequest
Returns
TypeDescription
Execution

getInstance(GetInstanceRequest request)

public Instance getInstance(GetInstanceRequest request)

Gets details of a single Instance.

Parameter
NameDescription
requestGetInstanceRequest
Returns
TypeDescription
Instance

getInstanceHealth(GetInstanceHealthRequest request)

public GetInstanceHealthResponse getInstanceHealth(GetInstanceHealthRequest request)

Check if a notebook instance is healthy.

Parameter
NameDescription
requestGetInstanceHealthRequest
Returns
TypeDescription
GetInstanceHealthResponse

getSchedule(GetScheduleRequest request)

public Schedule getSchedule(GetScheduleRequest request)

Gets details of schedule

Parameter
NameDescription
requestGetScheduleRequest
Returns
TypeDescription
Schedule

isInstanceUpgradeable(IsInstanceUpgradeableRequest request)

public IsInstanceUpgradeableResponse isInstanceUpgradeable(IsInstanceUpgradeableRequest request)

Check if a notebook instance is upgradable.

Parameter
NameDescription
requestIsInstanceUpgradeableRequest
Returns
TypeDescription
IsInstanceUpgradeableResponse

listEnvironments(ListEnvironmentsRequest request)

public ListEnvironmentsResponse listEnvironments(ListEnvironmentsRequest request)

Lists environments in a project.

Parameter
NameDescription
requestListEnvironmentsRequest
Returns
TypeDescription
ListEnvironmentsResponse

listExecutions(ListExecutionsRequest request)

public ListExecutionsResponse listExecutions(ListExecutionsRequest request)

Lists executions in a given project and location

Parameter
NameDescription
requestListExecutionsRequest
Returns
TypeDescription
ListExecutionsResponse

listInstances(ListInstancesRequest request)

public ListInstancesResponse listInstances(ListInstancesRequest request)

Lists instances in a given project and location.

Parameter
NameDescription
requestListInstancesRequest
Returns
TypeDescription
ListInstancesResponse

listSchedules(ListSchedulesRequest request)

public ListSchedulesResponse listSchedules(ListSchedulesRequest request)

Lists schedules in a given project and location.

Parameter
NameDescription
requestListSchedulesRequest
Returns
TypeDescription
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
NameDescription
requestRegisterInstanceRequest
Returns
TypeDescription
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
NameDescription
requestReportInstanceInfoRequest
Returns
TypeDescription
Operation

resetInstance(ResetInstanceRequest request)

public Operation resetInstance(ResetInstanceRequest request)

Resets a notebook instance.

Parameter
NameDescription
requestResetInstanceRequest
Returns
TypeDescription
Operation

rollbackInstance(RollbackInstanceRequest request)

public Operation rollbackInstance(RollbackInstanceRequest request)

Rollbacks a notebook instance to the previous version.

Parameter
NameDescription
requestRollbackInstanceRequest
Returns
TypeDescription
Operation

setInstanceAccelerator(SetInstanceAcceleratorRequest request)

public Operation setInstanceAccelerator(SetInstanceAcceleratorRequest request)

Updates the guest accelerators of a single Instance.

Parameter
NameDescription
requestSetInstanceAcceleratorRequest
Returns
TypeDescription
Operation

setInstanceLabels(SetInstanceLabelsRequest request)

public Operation setInstanceLabels(SetInstanceLabelsRequest request)

Replaces all the labels of an Instance.

Parameter
NameDescription
requestSetInstanceLabelsRequest
Returns
TypeDescription
Operation

setInstanceMachineType(SetInstanceMachineTypeRequest request)

public Operation setInstanceMachineType(SetInstanceMachineTypeRequest request)

Updates the machine type of a single Instance.

Parameter
NameDescription
requestSetInstanceMachineTypeRequest
Returns
TypeDescription
Operation

startInstance(StartInstanceRequest request)

public Operation startInstance(StartInstanceRequest request)

Starts a notebook instance.

Parameter
NameDescription
requestStartInstanceRequest
Returns
TypeDescription
Operation

stopInstance(StopInstanceRequest request)

public Operation stopInstance(StopInstanceRequest request)

Stops a notebook instance.

Parameter
NameDescription
requestStopInstanceRequest
Returns
TypeDescription
Operation

triggerSchedule(TriggerScheduleRequest request)

public Operation triggerSchedule(TriggerScheduleRequest request)

Triggers execution of an existing schedule.

Parameter
NameDescription
requestTriggerScheduleRequest
Returns
TypeDescription
Operation

updateInstanceConfig(UpdateInstanceConfigRequest request)

public Operation updateInstanceConfig(UpdateInstanceConfigRequest request)

Update Notebook Instance configurations.

Parameter
NameDescription
requestUpdateInstanceConfigRequest
Returns
TypeDescription
Operation

updateInstanceMetadataItems(UpdateInstanceMetadataItemsRequest request)

public UpdateInstanceMetadataItemsResponse updateInstanceMetadataItems(UpdateInstanceMetadataItemsRequest request)

Add/update metadata items for an instance.

Parameter
NameDescription
requestUpdateInstanceMetadataItemsRequest
Returns
TypeDescription
UpdateInstanceMetadataItemsResponse

updateShieldedInstanceConfig(UpdateShieldedInstanceConfigRequest request)

public Operation updateShieldedInstanceConfig(UpdateShieldedInstanceConfigRequest request)

Updates the Shielded instance configuration of a single Instance.

Parameter
NameDescription
requestUpdateShieldedInstanceConfigRequest
Returns
TypeDescription
Operation

upgradeInstance(UpgradeInstanceRequest request)

public Operation upgradeInstance(UpgradeInstanceRequest request)

Upgrades a notebook instance to the latest version.

Parameter
NameDescription
requestUpgradeInstanceRequest
Returns
TypeDescription
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
NameDescription
requestUpgradeInstanceInternalRequest
Returns
TypeDescription
Operation