ManagedNotebookService

google .cloud .notebooks .v1. ManagedNotebookService

Represents a ManagedNotebookService

Constructor

new ManagedNotebookService(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new ManagedNotebookService 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

createRuntime(request, callback) → {undefined}

Calls CreateRuntime.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.ICreateRuntimeRequest	CreateRuntimeRequest message or plain object
`callback`	google.cloud.notebooks.v1.ManagedNotebookService.CreateRuntimeCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

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

Calls CreateRuntime.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.ICreateRuntimeRequest	CreateRuntimeRequest message or plain object

Returns:

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

deleteRuntime(request, callback) → {undefined}

Calls DeleteRuntime.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IDeleteRuntimeRequest	DeleteRuntimeRequest message or plain object
`callback`	google.cloud.notebooks.v1.ManagedNotebookService.DeleteRuntimeCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

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

Calls DeleteRuntime.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IDeleteRuntimeRequest	DeleteRuntimeRequest message or plain object

Returns:

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

diagnoseRuntime(request, callback) → {undefined}

Calls DiagnoseRuntime.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IDiagnoseRuntimeRequest	DiagnoseRuntimeRequest message or plain object
`callback`	google.cloud.notebooks.v1.ManagedNotebookService.DiagnoseRuntimeCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

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

Calls DiagnoseRuntime.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IDiagnoseRuntimeRequest	DiagnoseRuntimeRequest message or plain object

Returns:

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

getRuntime(request, callback) → {undefined}

Calls GetRuntime.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IGetRuntimeRequest	GetRuntimeRequest message or plain object
`callback`	google.cloud.notebooks.v1.ManagedNotebookService.GetRuntimeCallback	Node-style callback called with the error, if any, and Runtime

Returns:

Type	Description
undefined

getRuntime(request) → {Promise.<google.cloud.notebooks.v1.Runtime>}

Calls GetRuntime.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IGetRuntimeRequest	GetRuntimeRequest message or plain object

Returns:

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

listRuntimes(request, callback) → {undefined}

Calls ListRuntimes.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IListRuntimesRequest	ListRuntimesRequest message or plain object
`callback`	google.cloud.notebooks.v1.ManagedNotebookService.ListRuntimesCallback	Node-style callback called with the error, if any, and ListRuntimesResponse

Returns:

Type	Description
undefined

listRuntimes(request) → {Promise.<google.cloud.notebooks.v1.ListRuntimesResponse>}

Calls ListRuntimes.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IListRuntimesRequest	ListRuntimesRequest message or plain object

Returns:

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

refreshRuntimeTokenInternal(request, callback) → {undefined}

Calls RefreshRuntimeTokenInternal.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IRefreshRuntimeTokenInternalRequest	RefreshRuntimeTokenInternalRequest message or plain object
`callback`	google.cloud.notebooks.v1.ManagedNotebookService.RefreshRuntimeTokenInternalCallback	Node-style callback called with the error, if any, and RefreshRuntimeTokenInternalResponse

Returns:

Type	Description
undefined

refreshRuntimeTokenInternal(request) → {Promise.<google.cloud.notebooks.v1.RefreshRuntimeTokenInternalResponse>}

Calls RefreshRuntimeTokenInternal.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IRefreshRuntimeTokenInternalRequest	RefreshRuntimeTokenInternalRequest message or plain object

Returns:

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

reportRuntimeEvent(request, callback) → {undefined}

Calls ReportRuntimeEvent.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IReportRuntimeEventRequest	ReportRuntimeEventRequest message or plain object
`callback`	google.cloud.notebooks.v1.ManagedNotebookService.ReportRuntimeEventCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

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

Calls ReportRuntimeEvent.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IReportRuntimeEventRequest	ReportRuntimeEventRequest message or plain object

Returns:

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

resetRuntime(request, callback) → {undefined}

Calls ResetRuntime.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IResetRuntimeRequest	ResetRuntimeRequest message or plain object
`callback`	google.cloud.notebooks.v1.ManagedNotebookService.ResetRuntimeCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

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

Calls ResetRuntime.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IResetRuntimeRequest	ResetRuntimeRequest message or plain object

Returns:

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

startRuntime(request, callback) → {undefined}

Calls StartRuntime.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IStartRuntimeRequest	StartRuntimeRequest message or plain object
`callback`	google.cloud.notebooks.v1.ManagedNotebookService.StartRuntimeCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

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

Calls StartRuntime.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IStartRuntimeRequest	StartRuntimeRequest message or plain object

Returns:

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

stopRuntime(request, callback) → {undefined}

Calls StopRuntime.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IStopRuntimeRequest	StopRuntimeRequest message or plain object
`callback`	google.cloud.notebooks.v1.ManagedNotebookService.StopRuntimeCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

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

Calls StopRuntime.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IStopRuntimeRequest	StopRuntimeRequest message or plain object

Returns:

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

switchRuntime(request, callback) → {undefined}

Calls SwitchRuntime.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.ISwitchRuntimeRequest	SwitchRuntimeRequest message or plain object
`callback`	google.cloud.notebooks.v1.ManagedNotebookService.SwitchRuntimeCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

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

Calls SwitchRuntime.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.ISwitchRuntimeRequest	SwitchRuntimeRequest message or plain object

Returns:

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

updateRuntime(request, callback) → {undefined}

Calls UpdateRuntime.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IUpdateRuntimeRequest	UpdateRuntimeRequest message or plain object
`callback`	google.cloud.notebooks.v1.ManagedNotebookService.UpdateRuntimeCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

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

Calls UpdateRuntime.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IUpdateRuntimeRequest	UpdateRuntimeRequest message or plain object

Returns:

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

upgradeRuntime(request, callback) → {undefined}

Calls UpgradeRuntime.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IUpgradeRuntimeRequest	UpgradeRuntimeRequest message or plain object
`callback`	google.cloud.notebooks.v1.ManagedNotebookService.UpgradeRuntimeCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

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

Calls UpgradeRuntime.

Parameters:

Name	Type	Description
`request`	google.cloud.notebooks.v1.IUpgradeRuntimeRequest	UpgradeRuntimeRequest message or plain object

Returns:

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

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

Creates new ManagedNotebookService 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
ManagedNotebookService	RPC service. Useful where requests and/or responses are streamed.

Type Definitions

CreateRuntimeCallback(error, responseopt)

Callback as used by createRuntime.

Parameters:

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

DeleteRuntimeCallback(error, responseopt)

Callback as used by deleteRuntime.

Parameters:

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

DiagnoseRuntimeCallback(error, responseopt)

Callback as used by diagnoseRuntime.

Parameters:

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

GetRuntimeCallback(error, responseopt)

Callback as used by getRuntime.

Parameters:

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

ListRuntimesCallback(error, responseopt)

Callback as used by listRuntimes.

Parameters:

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

RefreshRuntimeTokenInternalCallback(error, responseopt)

Callback as used by refreshRuntimeTokenInternal.

Parameters:

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

ReportRuntimeEventCallback(error, responseopt)

Callback as used by reportRuntimeEvent.

Parameters:

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

ResetRuntimeCallback(error, responseopt)

Callback as used by resetRuntime.

Parameters:

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

StartRuntimeCallback(error, responseopt)

Callback as used by startRuntime.

Parameters:

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

StopRuntimeCallback(error, responseopt)

Callback as used by stopRuntime.

Parameters:

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

SwitchRuntimeCallback(error, responseopt)

Callback as used by switchRuntime.

Parameters:

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

UpdateRuntimeCallback(error, responseopt)

Callback as used by updateRuntime.

Parameters:

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

UpgradeRuntimeCallback(error, responseopt)

Callback as used by upgradeRuntime.

Parameters:

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