NotebookService

google .cloud .notebooks .v2. NotebookService

Represents a NotebookService

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

checkInstanceUpgradability(request, callback) → {undefined}

Calls CheckInstanceUpgradability.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v2.ICheckInstanceUpgradabilityRequest	CheckInstanceUpgradabilityRequest message or plain object
`callback`	google.cloud.notebooks.v2.NotebookService.CheckInstanceUpgradabilityCallback	Node-style callback called with the error, if any, and CheckInstanceUpgradabilityResponse

Returns:

Type	Description
undefined

checkInstanceUpgradability(request) → {Promise.<google.cloud.notebooks.v2.CheckInstanceUpgradabilityResponse>}

Calls CheckInstanceUpgradability.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v2.ICheckInstanceUpgradabilityRequest	CheckInstanceUpgradabilityRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.notebooks.v2.CheckInstanceUpgradabilityResponse>	Promise

createInstance(request, callback) → {undefined}

Calls CreateInstance.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v2.ICreateInstanceRequest	CreateInstanceRequest message or plain object
`callback`	google.cloud.notebooks.v2.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.v2.ICreateInstanceRequest	CreateInstanceRequest 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.v2.IDeleteInstanceRequest	DeleteInstanceRequest message or plain object
`callback`	google.cloud.notebooks.v2.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.v2.IDeleteInstanceRequest	DeleteInstanceRequest 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.v2.IDiagnoseInstanceRequest	DiagnoseInstanceRequest message or plain object
`callback`	google.cloud.notebooks.v2.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.v2.IDiagnoseInstanceRequest	DiagnoseInstanceRequest message or plain object

Returns:

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

getInstance(request, callback) → {undefined}

Calls GetInstance.

Parameters:

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

Returns:

Type	Description
undefined

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

Calls GetInstance.

Parameters:

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

Returns:

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

listInstances(request, callback) → {undefined}

Calls ListInstances.

Parameters:

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

Returns:

Type	Description
undefined

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

Calls ListInstances.

Parameters:

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

Returns:

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

resetInstance(request, callback) → {undefined}

Calls ResetInstance.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v2.IResetInstanceRequest	ResetInstanceRequest message or plain object
`callback`	google.cloud.notebooks.v2.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.v2.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.v2.IRollbackInstanceRequest	RollbackInstanceRequest message or plain object
`callback`	google.cloud.notebooks.v2.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.v2.IRollbackInstanceRequest	RollbackInstanceRequest 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.v2.IStartInstanceRequest	StartInstanceRequest message or plain object
`callback`	google.cloud.notebooks.v2.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.v2.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.v2.IStopInstanceRequest	StopInstanceRequest message or plain object
`callback`	google.cloud.notebooks.v2.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.v2.IStopInstanceRequest	StopInstanceRequest message or plain object

Returns:

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

updateInstance(request, callback) → {undefined}

Calls UpdateInstance.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v2.IUpdateInstanceRequest	UpdateInstanceRequest message or plain object
`callback`	google.cloud.notebooks.v2.NotebookService.UpdateInstanceCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

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

Calls UpdateInstance.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v2.IUpdateInstanceRequest	UpdateInstanceRequest 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.v2.IUpgradeInstanceRequest	UpgradeInstanceRequest message or plain object
`callback`	google.cloud.notebooks.v2.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.v2.IUpgradeInstanceRequest	UpgradeInstanceRequest 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

CheckInstanceUpgradabilityCallback(error, responseopt)

Callback as used by checkInstanceUpgradability.

Parameters:

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

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

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

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

GetInstanceCallback(error, responseopt)

Callback as used by getInstance.

Parameters:

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

ListInstancesCallback(error, responseopt)

Callback as used by listInstances.

Parameters:

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

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

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

UpdateInstanceCallback(error, responseopt)

Callback as used by updateInstance.

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