Class protos.google.cloud.notebooks.v2.NotebookService (4.1.0)

Represents a NotebookService

Inheritance

$protobuf.rpc.Service > protos.google.cloud.notebooks.v2.NotebookService

Package

@google-cloud/notebooks

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

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

Constructs a new NotebookService service.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited

Methods

checkInstanceUpgradability(request, callback)

public checkInstanceUpgradability(request: google.cloud.notebooks.v2.ICheckInstanceUpgradabilityRequest, callback: google.cloud.notebooks.v2.NotebookService.CheckInstanceUpgradabilityCallback): void;

Calls CheckInstanceUpgradability.

Parameters
Name Description
request ICheckInstanceUpgradabilityRequest

CheckInstanceUpgradabilityRequest message or plain object
callback CheckInstanceUpgradabilityCallback

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

checkInstanceUpgradability(request)

public checkInstanceUpgradability(request: google.cloud.notebooks.v2.ICheckInstanceUpgradabilityRequest): Promise<google.cloud.notebooks.v2.CheckInstanceUpgradabilityResponse>;

Calls CheckInstanceUpgradability.

Parameter
Name Description
request ICheckInstanceUpgradabilityRequest

CheckInstanceUpgradabilityRequest message or plain object
Returns
Type Description
Promise<google.cloud.notebooks.v2.CheckInstanceUpgradabilityResponse>

Promise

create(rpcImpl, requestDelimited, responseDelimited)

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

Creates new NotebookService 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
NotebookService

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

createInstance(request, callback)

public createInstance(request: google.cloud.notebooks.v2.ICreateInstanceRequest, callback: google.cloud.notebooks.v2.NotebookService.CreateInstanceCallback): void;

Calls CreateInstance.

Parameters
Name Description
request ICreateInstanceRequest

CreateInstanceRequest message or plain object
callback CreateInstanceCallback

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

createInstance(request)

public createInstance(request: google.cloud.notebooks.v2.ICreateInstanceRequest): Promise<google.longrunning.Operation>;

Calls CreateInstance.

Parameter
Name Description
request ICreateInstanceRequest

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

Promise

deleteInstance(request, callback)

public deleteInstance(request: google.cloud.notebooks.v2.IDeleteInstanceRequest, callback: google.cloud.notebooks.v2.NotebookService.DeleteInstanceCallback): void;

Calls DeleteInstance.

Parameters
Name Description
request IDeleteInstanceRequest

DeleteInstanceRequest message or plain object
callback DeleteInstanceCallback

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

deleteInstance(request)

public deleteInstance(request: google.cloud.notebooks.v2.IDeleteInstanceRequest): Promise<google.longrunning.Operation>;

Calls DeleteInstance.

Parameter
Name Description
request IDeleteInstanceRequest

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

Promise

diagnoseInstance(request, callback)

public diagnoseInstance(request: google.cloud.notebooks.v2.IDiagnoseInstanceRequest, callback: google.cloud.notebooks.v2.NotebookService.DiagnoseInstanceCallback): void;

Calls DiagnoseInstance.

Parameters
Name Description
request IDiagnoseInstanceRequest

DiagnoseInstanceRequest message or plain object
callback DiagnoseInstanceCallback

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

diagnoseInstance(request)

public diagnoseInstance(request: google.cloud.notebooks.v2.IDiagnoseInstanceRequest): Promise<google.longrunning.Operation>;

Calls DiagnoseInstance.

Parameter
Name Description
request IDiagnoseInstanceRequest

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

Promise

getInstance(request, callback)

public getInstance(request: google.cloud.notebooks.v2.IGetInstanceRequest, callback: google.cloud.notebooks.v2.NotebookService.GetInstanceCallback): void;

Calls GetInstance.

Parameters
Name Description
request IGetInstanceRequest

GetInstanceRequest message or plain object
callback GetInstanceCallback

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

getInstance(request)

public getInstance(request: google.cloud.notebooks.v2.IGetInstanceRequest): Promise<google.cloud.notebooks.v2.Instance>;

Calls GetInstance.

Parameter
Name Description
request IGetInstanceRequest

GetInstanceRequest message or plain object
Returns
Type Description
Promise<google.cloud.notebooks.v2.Instance>

Promise

listInstances(request, callback)

public listInstances(request: google.cloud.notebooks.v2.IListInstancesRequest, callback: google.cloud.notebooks.v2.NotebookService.ListInstancesCallback): void;

Calls ListInstances.

Parameters
Name Description
request IListInstancesRequest

ListInstancesRequest message or plain object
callback ListInstancesCallback

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

listInstances(request)

public listInstances(request: google.cloud.notebooks.v2.IListInstancesRequest): Promise<google.cloud.notebooks.v2.ListInstancesResponse>;

Calls ListInstances.

Parameter
Name Description
request IListInstancesRequest

ListInstancesRequest message or plain object
Returns
Type Description
Promise<google.cloud.notebooks.v2.ListInstancesResponse>

Promise

resetInstance(request, callback)

public resetInstance(request: google.cloud.notebooks.v2.IResetInstanceRequest, callback: google.cloud.notebooks.v2.NotebookService.ResetInstanceCallback): void;

Calls ResetInstance.

Parameters
Name Description
request IResetInstanceRequest

ResetInstanceRequest message or plain object
callback ResetInstanceCallback

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

resetInstance(request)

public resetInstance(request: google.cloud.notebooks.v2.IResetInstanceRequest): Promise<google.longrunning.Operation>;

Calls ResetInstance.

Parameter
Name Description
request IResetInstanceRequest

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

Promise

rollbackInstance(request, callback)

public rollbackInstance(request: google.cloud.notebooks.v2.IRollbackInstanceRequest, callback: google.cloud.notebooks.v2.NotebookService.RollbackInstanceCallback): void;

Calls RollbackInstance.

Parameters
Name Description
request IRollbackInstanceRequest

RollbackInstanceRequest message or plain object
callback RollbackInstanceCallback

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

rollbackInstance(request)

public rollbackInstance(request: google.cloud.notebooks.v2.IRollbackInstanceRequest): Promise<google.longrunning.Operation>;

Calls RollbackInstance.

Parameter
Name Description
request IRollbackInstanceRequest

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

Promise

startInstance(request, callback)

public startInstance(request: google.cloud.notebooks.v2.IStartInstanceRequest, callback: google.cloud.notebooks.v2.NotebookService.StartInstanceCallback): void;

Calls StartInstance.

Parameters
Name Description
request IStartInstanceRequest

StartInstanceRequest message or plain object
callback StartInstanceCallback

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

startInstance(request)

public startInstance(request: google.cloud.notebooks.v2.IStartInstanceRequest): Promise<google.longrunning.Operation>;

Calls StartInstance.

Parameter
Name Description
request IStartInstanceRequest

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

Promise

stopInstance(request, callback)

public stopInstance(request: google.cloud.notebooks.v2.IStopInstanceRequest, callback: google.cloud.notebooks.v2.NotebookService.StopInstanceCallback): void;

Calls StopInstance.

Parameters
Name Description
request IStopInstanceRequest

StopInstanceRequest message or plain object
callback StopInstanceCallback

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

stopInstance(request)

public stopInstance(request: google.cloud.notebooks.v2.IStopInstanceRequest): Promise<google.longrunning.Operation>;

Calls StopInstance.

Parameter
Name Description
request IStopInstanceRequest

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

Promise

updateInstance(request, callback)

public updateInstance(request: google.cloud.notebooks.v2.IUpdateInstanceRequest, callback: google.cloud.notebooks.v2.NotebookService.UpdateInstanceCallback): void;

Calls UpdateInstance.

Parameters
Name Description
request IUpdateInstanceRequest

UpdateInstanceRequest message or plain object
callback UpdateInstanceCallback

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

updateInstance(request)

public updateInstance(request: google.cloud.notebooks.v2.IUpdateInstanceRequest): Promise<google.longrunning.Operation>;

Calls UpdateInstance.

Parameter
Name Description
request IUpdateInstanceRequest

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

Promise

upgradeInstance(request, callback)

public upgradeInstance(request: google.cloud.notebooks.v2.IUpgradeInstanceRequest, callback: google.cloud.notebooks.v2.NotebookService.UpgradeInstanceCallback): void;

Calls UpgradeInstance.

Parameters
Name Description
request IUpgradeInstanceRequest

UpgradeInstanceRequest message or plain object
callback UpgradeInstanceCallback

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

upgradeInstance(request)

public upgradeInstance(request: google.cloud.notebooks.v2.IUpgradeInstanceRequest): Promise<google.longrunning.Operation>;

Calls UpgradeInstance.

Parameter
Name Description
request IUpgradeInstanceRequest

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

Promise