Class protos.google.cloud.notebooks.v1.ManagedNotebookService (4.1.0)

Represents a ManagedNotebookService

Inheritance

$protobuf.rpc.Service > protos.google.cloud.notebooks.v1.ManagedNotebookService

Package

@google-cloud/notebooks

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new ManagedNotebookService service.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited

Methods

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): ManagedNotebookService;

Creates new ManagedNotebookService service using the specified rpc implementation.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited
Returns
Type Description
ManagedNotebookService

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

createRuntime(request, callback)

public createRuntime(request: google.cloud.notebooks.v1.ICreateRuntimeRequest, callback: google.cloud.notebooks.v1.ManagedNotebookService.CreateRuntimeCallback): void;

Calls CreateRuntime.

Parameters
Name Description
request ICreateRuntimeRequest

CreateRuntimeRequest message or plain object
callback CreateRuntimeCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

createRuntime(request)

public createRuntime(request: google.cloud.notebooks.v1.ICreateRuntimeRequest): Promise<google.longrunning.Operation>;

Calls CreateRuntime.

Parameter
Name Description
request ICreateRuntimeRequest

CreateRuntimeRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

deleteRuntime(request, callback)

public deleteRuntime(request: google.cloud.notebooks.v1.IDeleteRuntimeRequest, callback: google.cloud.notebooks.v1.ManagedNotebookService.DeleteRuntimeCallback): void;

Calls DeleteRuntime.

Parameters
Name Description
request IDeleteRuntimeRequest

DeleteRuntimeRequest message or plain object
callback DeleteRuntimeCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

deleteRuntime(request)

public deleteRuntime(request: google.cloud.notebooks.v1.IDeleteRuntimeRequest): Promise<google.longrunning.Operation>;

Calls DeleteRuntime.

Parameter
Name Description
request IDeleteRuntimeRequest

DeleteRuntimeRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

diagnoseRuntime(request, callback)

public diagnoseRuntime(request: google.cloud.notebooks.v1.IDiagnoseRuntimeRequest, callback: google.cloud.notebooks.v1.ManagedNotebookService.DiagnoseRuntimeCallback): void;

Calls DiagnoseRuntime.

Parameters
Name Description
request IDiagnoseRuntimeRequest

DiagnoseRuntimeRequest message or plain object
callback DiagnoseRuntimeCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

diagnoseRuntime(request)

public diagnoseRuntime(request: google.cloud.notebooks.v1.IDiagnoseRuntimeRequest): Promise<google.longrunning.Operation>;

Calls DiagnoseRuntime.

Parameter
Name Description
request IDiagnoseRuntimeRequest

DiagnoseRuntimeRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

getRuntime(request, callback)

public getRuntime(request: google.cloud.notebooks.v1.IGetRuntimeRequest, callback: google.cloud.notebooks.v1.ManagedNotebookService.GetRuntimeCallback): void;

Calls GetRuntime.

Parameters
Name Description
request IGetRuntimeRequest

GetRuntimeRequest message or plain object
callback GetRuntimeCallback

Node-style callback called with the error, if any, and Runtime
Returns
Type Description
void

getRuntime(request)

public getRuntime(request: google.cloud.notebooks.v1.IGetRuntimeRequest): Promise<google.cloud.notebooks.v1.Runtime>;

Calls GetRuntime.

Parameter
Name Description
request IGetRuntimeRequest

GetRuntimeRequest message or plain object
Returns
Type Description
Promise<google.cloud.notebooks.v1.Runtime>

Promise

listRuntimes(request, callback)

public listRuntimes(request: google.cloud.notebooks.v1.IListRuntimesRequest, callback: google.cloud.notebooks.v1.ManagedNotebookService.ListRuntimesCallback): void;

Calls ListRuntimes.

Parameters
Name Description
request IListRuntimesRequest

ListRuntimesRequest message or plain object
callback ListRuntimesCallback

Node-style callback called with the error, if any, and ListRuntimesResponse
Returns
Type Description
void

listRuntimes(request)

public listRuntimes(request: google.cloud.notebooks.v1.IListRuntimesRequest): Promise<google.cloud.notebooks.v1.ListRuntimesResponse>;

Calls ListRuntimes.

Parameter
Name Description
request IListRuntimesRequest

ListRuntimesRequest message or plain object
Returns
Type Description
Promise<google.cloud.notebooks.v1.ListRuntimesResponse>

Promise

refreshRuntimeTokenInternal(request, callback)

public refreshRuntimeTokenInternal(request: google.cloud.notebooks.v1.IRefreshRuntimeTokenInternalRequest, callback: google.cloud.notebooks.v1.ManagedNotebookService.RefreshRuntimeTokenInternalCallback): void;

Calls RefreshRuntimeTokenInternal.

Parameters
Name Description
request IRefreshRuntimeTokenInternalRequest

RefreshRuntimeTokenInternalRequest message or plain object
callback RefreshRuntimeTokenInternalCallback

Node-style callback called with the error, if any, and RefreshRuntimeTokenInternalResponse
Returns
Type Description
void

refreshRuntimeTokenInternal(request)

public refreshRuntimeTokenInternal(request: google.cloud.notebooks.v1.IRefreshRuntimeTokenInternalRequest): Promise<google.cloud.notebooks.v1.RefreshRuntimeTokenInternalResponse>;

Calls RefreshRuntimeTokenInternal.

Parameter
Name Description
request IRefreshRuntimeTokenInternalRequest

RefreshRuntimeTokenInternalRequest message or plain object
Returns
Type Description
Promise<google.cloud.notebooks.v1.RefreshRuntimeTokenInternalResponse>

Promise

reportRuntimeEvent(request, callback)

public reportRuntimeEvent(request: google.cloud.notebooks.v1.IReportRuntimeEventRequest, callback: google.cloud.notebooks.v1.ManagedNotebookService.ReportRuntimeEventCallback): void;

Calls ReportRuntimeEvent.

Parameters
Name Description
request IReportRuntimeEventRequest

ReportRuntimeEventRequest message or plain object
callback ReportRuntimeEventCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

reportRuntimeEvent(request)

public reportRuntimeEvent(request: google.cloud.notebooks.v1.IReportRuntimeEventRequest): Promise<google.longrunning.Operation>;

Calls ReportRuntimeEvent.

Parameter
Name Description
request IReportRuntimeEventRequest

ReportRuntimeEventRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

resetRuntime(request, callback)

public resetRuntime(request: google.cloud.notebooks.v1.IResetRuntimeRequest, callback: google.cloud.notebooks.v1.ManagedNotebookService.ResetRuntimeCallback): void;

Calls ResetRuntime.

Parameters
Name Description
request IResetRuntimeRequest

ResetRuntimeRequest message or plain object
callback ResetRuntimeCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

resetRuntime(request)

public resetRuntime(request: google.cloud.notebooks.v1.IResetRuntimeRequest): Promise<google.longrunning.Operation>;

Calls ResetRuntime.

Parameter
Name Description
request IResetRuntimeRequest

ResetRuntimeRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

startRuntime(request, callback)

public startRuntime(request: google.cloud.notebooks.v1.IStartRuntimeRequest, callback: google.cloud.notebooks.v1.ManagedNotebookService.StartRuntimeCallback): void;

Calls StartRuntime.

Parameters
Name Description
request IStartRuntimeRequest

StartRuntimeRequest message or plain object
callback StartRuntimeCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

startRuntime(request)

public startRuntime(request: google.cloud.notebooks.v1.IStartRuntimeRequest): Promise<google.longrunning.Operation>;

Calls StartRuntime.

Parameter
Name Description
request IStartRuntimeRequest

StartRuntimeRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

stopRuntime(request, callback)

public stopRuntime(request: google.cloud.notebooks.v1.IStopRuntimeRequest, callback: google.cloud.notebooks.v1.ManagedNotebookService.StopRuntimeCallback): void;

Calls StopRuntime.

Parameters
Name Description
request IStopRuntimeRequest

StopRuntimeRequest message or plain object
callback StopRuntimeCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

stopRuntime(request)

public stopRuntime(request: google.cloud.notebooks.v1.IStopRuntimeRequest): Promise<google.longrunning.Operation>;

Calls StopRuntime.

Parameter
Name Description
request IStopRuntimeRequest

StopRuntimeRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

switchRuntime(request, callback)

public switchRuntime(request: google.cloud.notebooks.v1.ISwitchRuntimeRequest, callback: google.cloud.notebooks.v1.ManagedNotebookService.SwitchRuntimeCallback): void;

Calls SwitchRuntime.

Parameters
Name Description
request ISwitchRuntimeRequest

SwitchRuntimeRequest message or plain object
callback SwitchRuntimeCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

switchRuntime(request)

public switchRuntime(request: google.cloud.notebooks.v1.ISwitchRuntimeRequest): Promise<google.longrunning.Operation>;

Calls SwitchRuntime.

Parameter
Name Description
request ISwitchRuntimeRequest

SwitchRuntimeRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

updateRuntime(request, callback)

public updateRuntime(request: google.cloud.notebooks.v1.IUpdateRuntimeRequest, callback: google.cloud.notebooks.v1.ManagedNotebookService.UpdateRuntimeCallback): void;

Calls UpdateRuntime.

Parameters
Name Description
request IUpdateRuntimeRequest

UpdateRuntimeRequest message or plain object
callback UpdateRuntimeCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

updateRuntime(request)

public updateRuntime(request: google.cloud.notebooks.v1.IUpdateRuntimeRequest): Promise<google.longrunning.Operation>;

Calls UpdateRuntime.

Parameter
Name Description
request IUpdateRuntimeRequest

UpdateRuntimeRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

upgradeRuntime(request, callback)

public upgradeRuntime(request: google.cloud.notebooks.v1.IUpgradeRuntimeRequest, callback: google.cloud.notebooks.v1.ManagedNotebookService.UpgradeRuntimeCallback): void;

Calls UpgradeRuntime.

Parameters
Name Description
request IUpgradeRuntimeRequest

UpgradeRuntimeRequest message or plain object
callback UpgradeRuntimeCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

upgradeRuntime(request)

public upgradeRuntime(request: google.cloud.notebooks.v1.IUpgradeRuntimeRequest): Promise<google.longrunning.Operation>;

Calls UpgradeRuntime.

Parameter
Name Description
request IUpgradeRuntimeRequest

UpgradeRuntimeRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise