Class NotebookServiceGrpc.NotebookServiceFutureStub (1.21.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 v1 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
NameDescription
channelio.grpc.Channel
callOptionsio.grpc.CallOptions
Returns
TypeDescription
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
NameDescription
requestCreateEnvironmentRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

createExecution(CreateExecutionRequest request)

public ListenableFuture<Operation> createExecution(CreateExecutionRequest request)

Creates a new Execution in a given project and location.

Parameter
NameDescription
requestCreateExecutionRequest
Returns
TypeDescription
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
NameDescription
requestCreateInstanceRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

createSchedule(CreateScheduleRequest request)

public ListenableFuture<Operation> createSchedule(CreateScheduleRequest request)

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

Parameter
NameDescription
requestCreateScheduleRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

deleteEnvironment(DeleteEnvironmentRequest request)

public ListenableFuture<Operation> deleteEnvironment(DeleteEnvironmentRequest request)

Deletes a single Environment.

Parameter
NameDescription
requestDeleteEnvironmentRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

deleteExecution(DeleteExecutionRequest request)

public ListenableFuture<Operation> deleteExecution(DeleteExecutionRequest request)

Deletes execution

Parameter
NameDescription
requestDeleteExecutionRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

deleteInstance(DeleteInstanceRequest request)

public ListenableFuture<Operation> deleteInstance(DeleteInstanceRequest request)

Deletes a single Instance.

Parameter
NameDescription
requestDeleteInstanceRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

deleteSchedule(DeleteScheduleRequest request)

public ListenableFuture<Operation> deleteSchedule(DeleteScheduleRequest request)

Deletes schedule and all underlying jobs

Parameter
NameDescription
requestDeleteScheduleRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

diagnoseInstance(DiagnoseInstanceRequest request)

public ListenableFuture<Operation> diagnoseInstance(DiagnoseInstanceRequest request)

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

Parameter
NameDescription
requestDiagnoseInstanceRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

getEnvironment(GetEnvironmentRequest request)

public ListenableFuture<Environment> getEnvironment(GetEnvironmentRequest request)

Gets details of a single Environment.

Parameter
NameDescription
requestGetEnvironmentRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Environment>

getExecution(GetExecutionRequest request)

public ListenableFuture<Execution> getExecution(GetExecutionRequest request)

Gets details of executions

Parameter
NameDescription
requestGetExecutionRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Execution>

getInstance(GetInstanceRequest request)

public ListenableFuture<Instance> getInstance(GetInstanceRequest request)

Gets details of a single Instance.

Parameter
NameDescription
requestGetInstanceRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Instance>

getInstanceHealth(GetInstanceHealthRequest request)

public ListenableFuture<GetInstanceHealthResponse> getInstanceHealth(GetInstanceHealthRequest request)

Check if a notebook instance is healthy.

Parameter
NameDescription
requestGetInstanceHealthRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<GetInstanceHealthResponse>

getSchedule(GetScheduleRequest request)

public ListenableFuture<Schedule> getSchedule(GetScheduleRequest request)

Gets details of schedule

Parameter
NameDescription
requestGetScheduleRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Schedule>

isInstanceUpgradeable(IsInstanceUpgradeableRequest request)

public ListenableFuture<IsInstanceUpgradeableResponse> isInstanceUpgradeable(IsInstanceUpgradeableRequest request)

Check if a notebook instance is upgradable.

Parameter
NameDescription
requestIsInstanceUpgradeableRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<IsInstanceUpgradeableResponse>

listEnvironments(ListEnvironmentsRequest request)

public ListenableFuture<ListEnvironmentsResponse> listEnvironments(ListEnvironmentsRequest request)

Lists environments in a project.

Parameter
NameDescription
requestListEnvironmentsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListEnvironmentsResponse>

listExecutions(ListExecutionsRequest request)

public ListenableFuture<ListExecutionsResponse> listExecutions(ListExecutionsRequest request)

Lists executions in a given project and location

Parameter
NameDescription
requestListExecutionsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListExecutionsResponse>

listInstances(ListInstancesRequest request)

public ListenableFuture<ListInstancesResponse> listInstances(ListInstancesRequest request)

Lists instances in a given project and location.

Parameter
NameDescription
requestListInstancesRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListInstancesResponse>

listSchedules(ListSchedulesRequest request)

public ListenableFuture<ListSchedulesResponse> listSchedules(ListSchedulesRequest request)

Lists schedules in a given project and location.

Parameter
NameDescription
requestListSchedulesRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListSchedulesResponse>

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
NameDescription
requestRegisterInstanceRequest
Returns
TypeDescription
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
NameDescription
requestReportInstanceInfoRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

resetInstance(ResetInstanceRequest request)

public ListenableFuture<Operation> resetInstance(ResetInstanceRequest request)

Resets a notebook instance.

Parameter
NameDescription
requestResetInstanceRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

rollbackInstance(RollbackInstanceRequest request)

public ListenableFuture<Operation> rollbackInstance(RollbackInstanceRequest request)

Rollbacks a notebook instance to the previous version.

Parameter
NameDescription
requestRollbackInstanceRequest
Returns
TypeDescription
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
NameDescription
requestSetInstanceAcceleratorRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

setInstanceLabels(SetInstanceLabelsRequest request)

public ListenableFuture<Operation> setInstanceLabels(SetInstanceLabelsRequest request)

Replaces all the labels of an Instance.

Parameter
NameDescription
requestSetInstanceLabelsRequest
Returns
TypeDescription
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
NameDescription
requestSetInstanceMachineTypeRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

startInstance(StartInstanceRequest request)

public ListenableFuture<Operation> startInstance(StartInstanceRequest request)

Starts a notebook instance.

Parameter
NameDescription
requestStartInstanceRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

stopInstance(StopInstanceRequest request)

public ListenableFuture<Operation> stopInstance(StopInstanceRequest request)

Stops a notebook instance.

Parameter
NameDescription
requestStopInstanceRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

triggerSchedule(TriggerScheduleRequest request)

public ListenableFuture<Operation> triggerSchedule(TriggerScheduleRequest request)

Triggers execution of an existing schedule.

Parameter
NameDescription
requestTriggerScheduleRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

updateInstanceConfig(UpdateInstanceConfigRequest request)

public ListenableFuture<Operation> updateInstanceConfig(UpdateInstanceConfigRequest request)

Update Notebook Instance configurations.

Parameter
NameDescription
requestUpdateInstanceConfigRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

updateInstanceMetadataItems(UpdateInstanceMetadataItemsRequest request)

public ListenableFuture<UpdateInstanceMetadataItemsResponse> updateInstanceMetadataItems(UpdateInstanceMetadataItemsRequest request)

Add/update metadata items for an instance.

Parameter
NameDescription
requestUpdateInstanceMetadataItemsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<UpdateInstanceMetadataItemsResponse>

updateShieldedInstanceConfig(UpdateShieldedInstanceConfigRequest request)

public ListenableFuture<Operation> updateShieldedInstanceConfig(UpdateShieldedInstanceConfigRequest request)

Updates the Shielded instance configuration of a single Instance.

Parameter
NameDescription
requestUpdateShieldedInstanceConfigRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

upgradeInstance(UpgradeInstanceRequest request)

public ListenableFuture<Operation> upgradeInstance(UpgradeInstanceRequest request)

Upgrades a notebook instance to the latest version.

Parameter
NameDescription
requestUpgradeInstanceRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

upgradeInstanceInternal(UpgradeInstanceInternalRequest request)

public ListenableFuture<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
com.google.common.util.concurrent.ListenableFuture<Operation>