NotebookService - Documentation

Constructor

new NotebookService(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new NotebookService service.

Parameters:

Name	Type	Attributes	Default	Description
`rpcImpl`	$protobuf.RPCImpl			RPC implementation
`requestDelimited`	boolean	<optional>	false	Whether requests are length-delimited
`responseDelimited`	boolean	<optional>	false	Whether responses are length-delimited

Extends

$protobuf.rpc.Service

Methods

createEnvironment(request, callback) → {undefined}

Calls CreateEnvironment.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.ICreateEnvironmentRequest	CreateEnvironmentRequest message or plain object
`callback`	google.cloud.notebooks.v1.NotebookService.CreateEnvironmentCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

createEnvironment(request) → {Promise.<google.longrunning.Operation>}

Calls CreateEnvironment.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.ICreateEnvironmentRequest	CreateEnvironmentRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

createExecution(request, callback) → {undefined}

Calls CreateExecution.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.ICreateExecutionRequest	CreateExecutionRequest message or plain object
`callback`	google.cloud.notebooks.v1.NotebookService.CreateExecutionCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

createExecution(request) → {Promise.<google.longrunning.Operation>}

Calls CreateExecution.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.ICreateExecutionRequest	CreateExecutionRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

createInstance(request, callback) → {undefined}

Calls CreateInstance.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.ICreateInstanceRequest	CreateInstanceRequest message or plain object
`callback`	google.cloud.notebooks.v1.NotebookService.CreateInstanceCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

createInstance(request) → {Promise.<google.longrunning.Operation>}

Calls CreateInstance.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.ICreateInstanceRequest	CreateInstanceRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

createSchedule(request, callback) → {undefined}

Calls CreateSchedule.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.ICreateScheduleRequest	CreateScheduleRequest message or plain object
`callback`	google.cloud.notebooks.v1.NotebookService.CreateScheduleCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

createSchedule(request) → {Promise.<google.longrunning.Operation>}

Calls CreateSchedule.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.ICreateScheduleRequest	CreateScheduleRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

deleteEnvironment(request, callback) → {undefined}

Calls DeleteEnvironment.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IDeleteEnvironmentRequest	DeleteEnvironmentRequest message or plain object
`callback`	google.cloud.notebooks.v1.NotebookService.DeleteEnvironmentCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

deleteEnvironment(request) → {Promise.<google.longrunning.Operation>}

Calls DeleteEnvironment.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IDeleteEnvironmentRequest	DeleteEnvironmentRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

deleteExecution(request, callback) → {undefined}

Calls DeleteExecution.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IDeleteExecutionRequest	DeleteExecutionRequest message or plain object
`callback`	google.cloud.notebooks.v1.NotebookService.DeleteExecutionCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

deleteExecution(request) → {Promise.<google.longrunning.Operation>}

Calls DeleteExecution.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IDeleteExecutionRequest	DeleteExecutionRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

deleteInstance(request, callback) → {undefined}

Calls DeleteInstance.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IDeleteInstanceRequest	DeleteInstanceRequest message or plain object
`callback`	google.cloud.notebooks.v1.NotebookService.DeleteInstanceCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

deleteInstance(request) → {Promise.<google.longrunning.Operation>}

Calls DeleteInstance.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IDeleteInstanceRequest	DeleteInstanceRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

deleteSchedule(request, callback) → {undefined}

Calls DeleteSchedule.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IDeleteScheduleRequest	DeleteScheduleRequest message or plain object
`callback`	google.cloud.notebooks.v1.NotebookService.DeleteScheduleCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

deleteSchedule(request) → {Promise.<google.longrunning.Operation>}

Calls DeleteSchedule.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IDeleteScheduleRequest	DeleteScheduleRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

diagnoseInstance(request, callback) → {undefined}

Calls DiagnoseInstance.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IDiagnoseInstanceRequest	DiagnoseInstanceRequest message or plain object
`callback`	google.cloud.notebooks.v1.NotebookService.DiagnoseInstanceCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

diagnoseInstance(request) → {Promise.<google.longrunning.Operation>}

Calls DiagnoseInstance.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IDiagnoseInstanceRequest	DiagnoseInstanceRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

getEnvironment(request, callback) → {undefined}

Calls GetEnvironment.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IGetEnvironmentRequest	GetEnvironmentRequest message or plain object
`callback`	google.cloud.notebooks.v1.NotebookService.GetEnvironmentCallback	Node-style callback called with the error, if any, and Environment

Returns:

Type	Description
undefined

getEnvironment(request) → {Promise.<google.cloud.notebooks.v1.Environment>}

Calls GetEnvironment.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IGetEnvironmentRequest	GetEnvironmentRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.notebooks.v1.Environment>	Promise

getExecution(request, callback) → {undefined}

Calls GetExecution.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IGetExecutionRequest	GetExecutionRequest message or plain object
`callback`	google.cloud.notebooks.v1.NotebookService.GetExecutionCallback	Node-style callback called with the error, if any, and Execution

Returns:

Type	Description
undefined

getExecution(request) → {Promise.<google.cloud.notebooks.v1.Execution>}

Calls GetExecution.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IGetExecutionRequest	GetExecutionRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.notebooks.v1.Execution>	Promise

getInstance(request, callback) → {undefined}

Calls GetInstance.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IGetInstanceRequest	GetInstanceRequest message or plain object
`callback`	google.cloud.notebooks.v1.NotebookService.GetInstanceCallback	Node-style callback called with the error, if any, and Instance

Returns:

Type	Description
undefined

getInstance(request) → {Promise.<google.cloud.notebooks.v1.Instance>}

Calls GetInstance.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IGetInstanceRequest	GetInstanceRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.notebooks.v1.Instance>	Promise

getInstanceHealth(request, callback) → {undefined}

Calls GetInstanceHealth.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IGetInstanceHealthRequest	GetInstanceHealthRequest message or plain object
`callback`	google.cloud.notebooks.v1.NotebookService.GetInstanceHealthCallback	Node-style callback called with the error, if any, and GetInstanceHealthResponse

Returns:

Type	Description
undefined

getInstanceHealth(request) → {Promise.<google.cloud.notebooks.v1.GetInstanceHealthResponse>}

Calls GetInstanceHealth.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IGetInstanceHealthRequest	GetInstanceHealthRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.notebooks.v1.GetInstanceHealthResponse>	Promise

getSchedule(request, callback) → {undefined}

Calls GetSchedule.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IGetScheduleRequest	GetScheduleRequest message or plain object
`callback`	google.cloud.notebooks.v1.NotebookService.GetScheduleCallback	Node-style callback called with the error, if any, and Schedule

Returns:

Type	Description
undefined

getSchedule(request) → {Promise.<google.cloud.notebooks.v1.Schedule>}

Calls GetSchedule.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IGetScheduleRequest	GetScheduleRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.notebooks.v1.Schedule>	Promise

isInstanceUpgradeable(request, callback) → {undefined}

Calls IsInstanceUpgradeable.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IIsInstanceUpgradeableRequest	IsInstanceUpgradeableRequest message or plain object
`callback`	google.cloud.notebooks.v1.NotebookService.IsInstanceUpgradeableCallback	Node-style callback called with the error, if any, and IsInstanceUpgradeableResponse

Returns:

Type	Description
undefined

isInstanceUpgradeable(request) → {Promise.<google.cloud.notebooks.v1.IsInstanceUpgradeableResponse>}

Calls IsInstanceUpgradeable.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IIsInstanceUpgradeableRequest	IsInstanceUpgradeableRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.notebooks.v1.IsInstanceUpgradeableResponse>	Promise

listEnvironments(request, callback) → {undefined}

Calls ListEnvironments.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IListEnvironmentsRequest	ListEnvironmentsRequest message or plain object
`callback`	google.cloud.notebooks.v1.NotebookService.ListEnvironmentsCallback	Node-style callback called with the error, if any, and ListEnvironmentsResponse

Returns:

Type	Description
undefined

listEnvironments(request) → {Promise.<google.cloud.notebooks.v1.ListEnvironmentsResponse>}

Calls ListEnvironments.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IListEnvironmentsRequest	ListEnvironmentsRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.notebooks.v1.ListEnvironmentsResponse>	Promise

listExecutions(request, callback) → {undefined}

Calls ListExecutions.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IListExecutionsRequest	ListExecutionsRequest message or plain object
`callback`	google.cloud.notebooks.v1.NotebookService.ListExecutionsCallback	Node-style callback called with the error, if any, and ListExecutionsResponse

Returns:

Type	Description
undefined

listExecutions(request) → {Promise.<google.cloud.notebooks.v1.ListExecutionsResponse>}

Calls ListExecutions.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IListExecutionsRequest	ListExecutionsRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.notebooks.v1.ListExecutionsResponse>	Promise

listInstances(request, callback) → {undefined}

Calls ListInstances.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IListInstancesRequest	ListInstancesRequest message or plain object
`callback`	google.cloud.notebooks.v1.NotebookService.ListInstancesCallback	Node-style callback called with the error, if any, and ListInstancesResponse

Returns:

Type	Description
undefined

listInstances(request) → {Promise.<google.cloud.notebooks.v1.ListInstancesResponse>}

Calls ListInstances.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IListInstancesRequest	ListInstancesRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.notebooks.v1.ListInstancesResponse>	Promise

listSchedules(request, callback) → {undefined}

Calls ListSchedules.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IListSchedulesRequest	ListSchedulesRequest message or plain object
`callback`	google.cloud.notebooks.v1.NotebookService.ListSchedulesCallback	Node-style callback called with the error, if any, and ListSchedulesResponse

Returns:

Type	Description
undefined

listSchedules(request) → {Promise.<google.cloud.notebooks.v1.ListSchedulesResponse>}

Calls ListSchedules.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IListSchedulesRequest	ListSchedulesRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.notebooks.v1.ListSchedulesResponse>	Promise

registerInstance(request, callback) → {undefined}

Calls RegisterInstance.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IRegisterInstanceRequest	RegisterInstanceRequest message or plain object
`callback`	google.cloud.notebooks.v1.NotebookService.RegisterInstanceCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

registerInstance(request) → {Promise.<google.longrunning.Operation>}

Calls RegisterInstance.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IRegisterInstanceRequest	RegisterInstanceRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

reportInstanceInfo(request, callback) → {undefined}

Calls ReportInstanceInfo.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IReportInstanceInfoRequest	ReportInstanceInfoRequest message or plain object
`callback`	google.cloud.notebooks.v1.NotebookService.ReportInstanceInfoCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

reportInstanceInfo(request) → {Promise.<google.longrunning.Operation>}

Calls ReportInstanceInfo.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IReportInstanceInfoRequest	ReportInstanceInfoRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

resetInstance(request, callback) → {undefined}

Calls ResetInstance.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IResetInstanceRequest	ResetInstanceRequest message or plain object
`callback`	google.cloud.notebooks.v1.NotebookService.ResetInstanceCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

resetInstance(request) → {Promise.<google.longrunning.Operation>}

Calls ResetInstance.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IResetInstanceRequest	ResetInstanceRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

rollbackInstance(request, callback) → {undefined}

Calls RollbackInstance.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IRollbackInstanceRequest	RollbackInstanceRequest message or plain object
`callback`	google.cloud.notebooks.v1.NotebookService.RollbackInstanceCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

rollbackInstance(request) → {Promise.<google.longrunning.Operation>}

Calls RollbackInstance.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IRollbackInstanceRequest	RollbackInstanceRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

setInstanceAccelerator(request, callback) → {undefined}

Calls SetInstanceAccelerator.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.ISetInstanceAcceleratorRequest	SetInstanceAcceleratorRequest message or plain object
`callback`	google.cloud.notebooks.v1.NotebookService.SetInstanceAcceleratorCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

setInstanceAccelerator(request) → {Promise.<google.longrunning.Operation>}

Calls SetInstanceAccelerator.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.ISetInstanceAcceleratorRequest	SetInstanceAcceleratorRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

setInstanceLabels(request, callback) → {undefined}

Calls SetInstanceLabels.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.ISetInstanceLabelsRequest	SetInstanceLabelsRequest message or plain object
`callback`	google.cloud.notebooks.v1.NotebookService.SetInstanceLabelsCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

setInstanceLabels(request) → {Promise.<google.longrunning.Operation>}

Calls SetInstanceLabels.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.ISetInstanceLabelsRequest	SetInstanceLabelsRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

setInstanceMachineType(request, callback) → {undefined}

Calls SetInstanceMachineType.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.ISetInstanceMachineTypeRequest	SetInstanceMachineTypeRequest message or plain object
`callback`	google.cloud.notebooks.v1.NotebookService.SetInstanceMachineTypeCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

setInstanceMachineType(request) → {Promise.<google.longrunning.Operation>}

Calls SetInstanceMachineType.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.ISetInstanceMachineTypeRequest	SetInstanceMachineTypeRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

startInstance(request, callback) → {undefined}

Calls StartInstance.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IStartInstanceRequest	StartInstanceRequest message or plain object
`callback`	google.cloud.notebooks.v1.NotebookService.StartInstanceCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

startInstance(request) → {Promise.<google.longrunning.Operation>}

Calls StartInstance.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IStartInstanceRequest	StartInstanceRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

stopInstance(request, callback) → {undefined}

Calls StopInstance.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IStopInstanceRequest	StopInstanceRequest message or plain object
`callback`	google.cloud.notebooks.v1.NotebookService.StopInstanceCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

stopInstance(request) → {Promise.<google.longrunning.Operation>}

Calls StopInstance.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IStopInstanceRequest	StopInstanceRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

triggerSchedule(request, callback) → {undefined}

Calls TriggerSchedule.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.ITriggerScheduleRequest	TriggerScheduleRequest message or plain object
`callback`	google.cloud.notebooks.v1.NotebookService.TriggerScheduleCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

triggerSchedule(request) → {Promise.<google.longrunning.Operation>}

Calls TriggerSchedule.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.ITriggerScheduleRequest	TriggerScheduleRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

updateInstanceConfig(request, callback) → {undefined}

Calls UpdateInstanceConfig.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IUpdateInstanceConfigRequest	UpdateInstanceConfigRequest message or plain object
`callback`	google.cloud.notebooks.v1.NotebookService.UpdateInstanceConfigCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

updateInstanceConfig(request) → {Promise.<google.longrunning.Operation>}

Calls UpdateInstanceConfig.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IUpdateInstanceConfigRequest	UpdateInstanceConfigRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

updateInstanceMetadataItems(request, callback) → {undefined}

Calls UpdateInstanceMetadataItems.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IUpdateInstanceMetadataItemsRequest	UpdateInstanceMetadataItemsRequest message or plain object
`callback`	google.cloud.notebooks.v1.NotebookService.UpdateInstanceMetadataItemsCallback	Node-style callback called with the error, if any, and UpdateInstanceMetadataItemsResponse

Returns:

Type	Description
undefined

updateInstanceMetadataItems(request) → {Promise.<google.cloud.notebooks.v1.UpdateInstanceMetadataItemsResponse>}

Calls UpdateInstanceMetadataItems.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IUpdateInstanceMetadataItemsRequest	UpdateInstanceMetadataItemsRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.notebooks.v1.UpdateInstanceMetadataItemsResponse>	Promise

updateShieldedInstanceConfig(request, callback) → {undefined}

Calls UpdateShieldedInstanceConfig.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IUpdateShieldedInstanceConfigRequest	UpdateShieldedInstanceConfigRequest message or plain object
`callback`	google.cloud.notebooks.v1.NotebookService.UpdateShieldedInstanceConfigCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

updateShieldedInstanceConfig(request) → {Promise.<google.longrunning.Operation>}

Calls UpdateShieldedInstanceConfig.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IUpdateShieldedInstanceConfigRequest	UpdateShieldedInstanceConfigRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

upgradeInstance(request, callback) → {undefined}

Calls UpgradeInstance.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IUpgradeInstanceRequest	UpgradeInstanceRequest message or plain object
`callback`	google.cloud.notebooks.v1.NotebookService.UpgradeInstanceCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

upgradeInstance(request) → {Promise.<google.longrunning.Operation>}

Calls UpgradeInstance.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IUpgradeInstanceRequest	UpgradeInstanceRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

upgradeInstanceInternal(request, callback) → {undefined}

Calls UpgradeInstanceInternal.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IUpgradeInstanceInternalRequest	UpgradeInstanceInternalRequest message or plain object
`callback`	google.cloud.notebooks.v1.NotebookService.UpgradeInstanceInternalCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

upgradeInstanceInternal(request) → {Promise.<google.longrunning.Operation>}

Calls UpgradeInstanceInternal.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IUpgradeInstanceInternalRequest	UpgradeInstanceInternalRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {NotebookService}

Creates new NotebookService service using the specified rpc implementation.

Parameters:

Name	Type	Attributes	Default	Description
`rpcImpl`	$protobuf.RPCImpl			RPC implementation
`requestDelimited`	boolean	<optional>	false	Whether requests are length-delimited
`responseDelimited`	boolean	<optional>	false	Whether responses are length-delimited

Returns:

Type	Description
NotebookService	RPC service. Useful where requests and/or responses are streamed.

Type Definitions

CreateEnvironmentCallback(error, responseopt)

Callback as used by createEnvironment.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

CreateExecutionCallback(error, responseopt)

Callback as used by createExecution.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

CreateInstanceCallback(error, responseopt)

Callback as used by createInstance.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

CreateScheduleCallback(error, responseopt)

Callback as used by createSchedule.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

DeleteEnvironmentCallback(error, responseopt)

Callback as used by deleteEnvironment.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

DeleteExecutionCallback(error, responseopt)

Callback as used by deleteExecution.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

DeleteInstanceCallback(error, responseopt)

Callback as used by deleteInstance.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

DeleteScheduleCallback(error, responseopt)

Callback as used by deleteSchedule.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

DiagnoseInstanceCallback(error, responseopt)

Callback as used by diagnoseInstance.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

GetEnvironmentCallback(error, responseopt)

Callback as used by getEnvironment.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.notebooks.v1.Environment	<optional>	Environment

GetExecutionCallback(error, responseopt)

Callback as used by getExecution.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.notebooks.v1.Execution	<optional>	Execution

GetInstanceCallback(error, responseopt)

Callback as used by getInstance.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.notebooks.v1.Instance	<optional>	Instance

GetInstanceHealthCallback(error, responseopt)

Callback as used by getInstanceHealth.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.notebooks.v1.GetInstanceHealthResponse	<optional>	GetInstanceHealthResponse

GetScheduleCallback(error, responseopt)

Callback as used by getSchedule.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.notebooks.v1.Schedule	<optional>	Schedule

IsInstanceUpgradeableCallback(error, responseopt)

Callback as used by isInstanceUpgradeable.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.notebooks.v1.IsInstanceUpgradeableResponse	<optional>	IsInstanceUpgradeableResponse

ListEnvironmentsCallback(error, responseopt)

Callback as used by listEnvironments.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.notebooks.v1.ListEnvironmentsResponse	<optional>	ListEnvironmentsResponse

ListExecutionsCallback(error, responseopt)

Callback as used by listExecutions.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.notebooks.v1.ListExecutionsResponse	<optional>	ListExecutionsResponse

ListInstancesCallback(error, responseopt)

Callback as used by listInstances.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.notebooks.v1.ListInstancesResponse	<optional>	ListInstancesResponse

ListSchedulesCallback(error, responseopt)

Callback as used by listSchedules.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.notebooks.v1.ListSchedulesResponse	<optional>	ListSchedulesResponse

RegisterInstanceCallback(error, responseopt)

Callback as used by registerInstance.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

ReportInstanceInfoCallback(error, responseopt)

Callback as used by reportInstanceInfo.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

ResetInstanceCallback(error, responseopt)

Callback as used by resetInstance.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

RollbackInstanceCallback(error, responseopt)

Callback as used by rollbackInstance.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

SetInstanceAcceleratorCallback(error, responseopt)

Callback as used by setInstanceAccelerator.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

SetInstanceLabelsCallback(error, responseopt)

Callback as used by setInstanceLabels.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

SetInstanceMachineTypeCallback(error, responseopt)

Callback as used by setInstanceMachineType.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

StartInstanceCallback(error, responseopt)

Callback as used by startInstance.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

StopInstanceCallback(error, responseopt)

Callback as used by stopInstance.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

TriggerScheduleCallback(error, responseopt)

Callback as used by triggerSchedule.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

UpdateInstanceConfigCallback(error, responseopt)

Callback as used by updateInstanceConfig.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

UpdateInstanceMetadataItemsCallback(error, responseopt)

Callback as used by updateInstanceMetadataItems.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.notebooks.v1.UpdateInstanceMetadataItemsResponse	<optional>	UpdateInstanceMetadataItemsResponse

UpdateShieldedInstanceConfigCallback(error, responseopt)

Callback as used by updateShieldedInstanceConfig.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

UpgradeInstanceCallback(error, responseopt)

Callback as used by upgradeInstance.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

UpgradeInstanceInternalCallback(error, responseopt)

Callback as used by upgradeInstanceInternal.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation