Represents a NotebookService
Inheritance
$protobuf.rpc.Service > protos.google.cloud.notebooks.v1beta1.NotebookServicePackage
@google-cloud/notebooksConstructors
(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
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. |
createEnvironment(request, callback)
public createEnvironment(request: google.cloud.notebooks.v1beta1.ICreateEnvironmentRequest, callback: google.cloud.notebooks.v1beta1.NotebookService.CreateEnvironmentCallback): void;
Calls CreateEnvironment.
Parameters | |
---|---|
Name | Description |
request |
google.cloud.notebooks.v1beta1.ICreateEnvironmentRequest
CreateEnvironmentRequest message or plain object |
callback |
google.cloud.notebooks.v1beta1.NotebookService.CreateEnvironmentCallback
Node-style callback called with the error, if any, and Operation |
Returns | |
---|---|
Type | Description |
void |
createEnvironment(request)
public createEnvironment(request: google.cloud.notebooks.v1beta1.ICreateEnvironmentRequest): Promise<google.longrunning.Operation>;
Calls CreateEnvironment.
Parameter | |
---|---|
Name | Description |
request |
google.cloud.notebooks.v1beta1.ICreateEnvironmentRequest
CreateEnvironmentRequest message or plain object |
Returns | |
---|---|
Type | Description |
Promise<google.longrunning.Operation> | Promise |
createInstance(request, callback)
public createInstance(request: google.cloud.notebooks.v1beta1.ICreateInstanceRequest, callback: google.cloud.notebooks.v1beta1.NotebookService.CreateInstanceCallback): void;
Calls CreateInstance.
Parameters | |
---|---|
Name | Description |
request |
ICreateInstanceRequest
CreateInstanceRequest message or plain object |
callback |
google.cloud.notebooks.v1beta1.NotebookService.CreateInstanceCallback
Node-style callback called with the error, if any, and Operation |
Returns | |
---|---|
Type | Description |
void |
createInstance(request)
public createInstance(request: google.cloud.notebooks.v1beta1.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 |
deleteEnvironment(request, callback)
public deleteEnvironment(request: google.cloud.notebooks.v1beta1.IDeleteEnvironmentRequest, callback: google.cloud.notebooks.v1beta1.NotebookService.DeleteEnvironmentCallback): void;
Calls DeleteEnvironment.
Parameters | |
---|---|
Name | Description |
request |
IDeleteEnvironmentRequest
DeleteEnvironmentRequest message or plain object |
callback |
google.cloud.notebooks.v1beta1.NotebookService.DeleteEnvironmentCallback
Node-style callback called with the error, if any, and Operation |
Returns | |
---|---|
Type | Description |
void |
deleteEnvironment(request)
public deleteEnvironment(request: google.cloud.notebooks.v1beta1.IDeleteEnvironmentRequest): Promise<google.longrunning.Operation>;
Calls DeleteEnvironment.
Parameter | |
---|---|
Name | Description |
request |
IDeleteEnvironmentRequest
DeleteEnvironmentRequest message or plain object |
Returns | |
---|---|
Type | Description |
Promise<google.longrunning.Operation> | Promise |
deleteInstance(request, callback)
public deleteInstance(request: google.cloud.notebooks.v1beta1.IDeleteInstanceRequest, callback: google.cloud.notebooks.v1beta1.NotebookService.DeleteInstanceCallback): void;
Calls DeleteInstance.
Parameters | |
---|---|
Name | Description |
request |
IDeleteInstanceRequest
DeleteInstanceRequest message or plain object |
callback |
google.cloud.notebooks.v1beta1.NotebookService.DeleteInstanceCallback
Node-style callback called with the error, if any, and Operation |
Returns | |
---|---|
Type | Description |
void |
deleteInstance(request)
public deleteInstance(request: google.cloud.notebooks.v1beta1.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 |
getEnvironment(request, callback)
public getEnvironment(request: google.cloud.notebooks.v1beta1.IGetEnvironmentRequest, callback: google.cloud.notebooks.v1beta1.NotebookService.GetEnvironmentCallback): void;
Calls GetEnvironment.
Parameters | |
---|---|
Name | Description |
request |
google.cloud.notebooks.v1beta1.IGetEnvironmentRequest
GetEnvironmentRequest message or plain object |
callback |
google.cloud.notebooks.v1beta1.NotebookService.GetEnvironmentCallback
Node-style callback called with the error, if any, and Environment |
Returns | |
---|---|
Type | Description |
void |
getEnvironment(request)
public getEnvironment(request: google.cloud.notebooks.v1beta1.IGetEnvironmentRequest): Promise<google.cloud.notebooks.v1beta1.Environment>;
Calls GetEnvironment.
Parameter | |
---|---|
Name | Description |
request |
google.cloud.notebooks.v1beta1.IGetEnvironmentRequest
GetEnvironmentRequest message or plain object |
Returns | |
---|---|
Type | Description |
Promise<google.cloud.notebooks.v1beta1.Environment> | Promise |
getInstance(request, callback)
public getInstance(request: google.cloud.notebooks.v1beta1.IGetInstanceRequest, callback: google.cloud.notebooks.v1beta1.NotebookService.GetInstanceCallback): void;
Calls GetInstance.
Parameters | |
---|---|
Name | Description |
request |
IGetInstanceRequest
GetInstanceRequest message or plain object |
callback |
google.cloud.notebooks.v1beta1.NotebookService.GetInstanceCallback
Node-style callback called with the error, if any, and Instance |
Returns | |
---|---|
Type | Description |
void |
getInstance(request)
public getInstance(request: google.cloud.notebooks.v1beta1.IGetInstanceRequest): Promise<google.cloud.notebooks.v1beta1.Instance>;
Calls GetInstance.
Parameter | |
---|---|
Name | Description |
request |
IGetInstanceRequest
GetInstanceRequest message or plain object |
Returns | |
---|---|
Type | Description |
Promise<google.cloud.notebooks.v1beta1.Instance> | Promise |
isInstanceUpgradeable(request, callback)
public isInstanceUpgradeable(request: google.cloud.notebooks.v1beta1.IIsInstanceUpgradeableRequest, callback: google.cloud.notebooks.v1beta1.NotebookService.IsInstanceUpgradeableCallback): void;
Calls IsInstanceUpgradeable.
Parameters | |
---|---|
Name | Description |
request |
IIsInstanceUpgradeableRequest
IsInstanceUpgradeableRequest message or plain object |
callback |
google.cloud.notebooks.v1beta1.NotebookService.IsInstanceUpgradeableCallback
Node-style callback called with the error, if any, and IsInstanceUpgradeableResponse |
Returns | |
---|---|
Type | Description |
void |
isInstanceUpgradeable(request)
public isInstanceUpgradeable(request: google.cloud.notebooks.v1beta1.IIsInstanceUpgradeableRequest): Promise<google.cloud.notebooks.v1beta1.IsInstanceUpgradeableResponse>;
Calls IsInstanceUpgradeable.
Parameter | |
---|---|
Name | Description |
request |
IIsInstanceUpgradeableRequest
IsInstanceUpgradeableRequest message or plain object |
Returns | |
---|---|
Type | Description |
Promise<google.cloud.notebooks.v1beta1.IsInstanceUpgradeableResponse> | Promise |
listEnvironments(request, callback)
public listEnvironments(request: google.cloud.notebooks.v1beta1.IListEnvironmentsRequest, callback: google.cloud.notebooks.v1beta1.NotebookService.ListEnvironmentsCallback): void;
Calls ListEnvironments.
Parameters | |
---|---|
Name | Description |
request |
IListEnvironmentsRequest
ListEnvironmentsRequest message or plain object |
callback |
google.cloud.notebooks.v1beta1.NotebookService.ListEnvironmentsCallback
Node-style callback called with the error, if any, and ListEnvironmentsResponse |
Returns | |
---|---|
Type | Description |
void |
listEnvironments(request)
public listEnvironments(request: google.cloud.notebooks.v1beta1.IListEnvironmentsRequest): Promise<google.cloud.notebooks.v1beta1.ListEnvironmentsResponse>;
Calls ListEnvironments.
Parameter | |
---|---|
Name | Description |
request |
IListEnvironmentsRequest
ListEnvironmentsRequest message or plain object |
Returns | |
---|---|
Type | Description |
Promise<google.cloud.notebooks.v1beta1.ListEnvironmentsResponse> | Promise |
listInstances(request, callback)
public listInstances(request: google.cloud.notebooks.v1beta1.IListInstancesRequest, callback: google.cloud.notebooks.v1beta1.NotebookService.ListInstancesCallback): void;
Calls ListInstances.
Parameters | |
---|---|
Name | Description |
request |
IListInstancesRequest
ListInstancesRequest message or plain object |
callback |
google.cloud.notebooks.v1beta1.NotebookService.ListInstancesCallback
Node-style callback called with the error, if any, and ListInstancesResponse |
Returns | |
---|---|
Type | Description |
void |
listInstances(request)
public listInstances(request: google.cloud.notebooks.v1beta1.IListInstancesRequest): Promise<google.cloud.notebooks.v1beta1.ListInstancesResponse>;
Calls ListInstances.
Parameter | |
---|---|
Name | Description |
request |
IListInstancesRequest
ListInstancesRequest message or plain object |
Returns | |
---|---|
Type | Description |
Promise<google.cloud.notebooks.v1beta1.ListInstancesResponse> | Promise |
registerInstance(request, callback)
public registerInstance(request: google.cloud.notebooks.v1beta1.IRegisterInstanceRequest, callback: google.cloud.notebooks.v1beta1.NotebookService.RegisterInstanceCallback): void;
Calls RegisterInstance.
Parameters | |
---|---|
Name | Description |
request |
IRegisterInstanceRequest
RegisterInstanceRequest message or plain object |
callback |
google.cloud.notebooks.v1beta1.NotebookService.RegisterInstanceCallback
Node-style callback called with the error, if any, and Operation |
Returns | |
---|---|
Type | Description |
void |
registerInstance(request)
public registerInstance(request: google.cloud.notebooks.v1beta1.IRegisterInstanceRequest): Promise<google.longrunning.Operation>;
Calls RegisterInstance.
Parameter | |
---|---|
Name | Description |
request |
IRegisterInstanceRequest
RegisterInstanceRequest message or plain object |
Returns | |
---|---|
Type | Description |
Promise<google.longrunning.Operation> | Promise |
reportInstanceInfo(request, callback)
public reportInstanceInfo(request: google.cloud.notebooks.v1beta1.IReportInstanceInfoRequest, callback: google.cloud.notebooks.v1beta1.NotebookService.ReportInstanceInfoCallback): void;
Calls ReportInstanceInfo.
Parameters | |
---|---|
Name | Description |
request |
IReportInstanceInfoRequest
ReportInstanceInfoRequest message or plain object |
callback |
google.cloud.notebooks.v1beta1.NotebookService.ReportInstanceInfoCallback
Node-style callback called with the error, if any, and Operation |
Returns | |
---|---|
Type | Description |
void |
reportInstanceInfo(request)
public reportInstanceInfo(request: google.cloud.notebooks.v1beta1.IReportInstanceInfoRequest): Promise<google.longrunning.Operation>;
Calls ReportInstanceInfo.
Parameter | |
---|---|
Name | Description |
request |
IReportInstanceInfoRequest
ReportInstanceInfoRequest message or plain object |
Returns | |
---|---|
Type | Description |
Promise<google.longrunning.Operation> | Promise |
resetInstance(request, callback)
public resetInstance(request: google.cloud.notebooks.v1beta1.IResetInstanceRequest, callback: google.cloud.notebooks.v1beta1.NotebookService.ResetInstanceCallback): void;
Calls ResetInstance.
Parameters | |
---|---|
Name | Description |
request |
google.cloud.notebooks.v1beta1.IResetInstanceRequest
ResetInstanceRequest message or plain object |
callback |
google.cloud.notebooks.v1beta1.NotebookService.ResetInstanceCallback
Node-style callback called with the error, if any, and Operation |
Returns | |
---|---|
Type | Description |
void |
resetInstance(request)
public resetInstance(request: google.cloud.notebooks.v1beta1.IResetInstanceRequest): Promise<google.longrunning.Operation>;
Calls ResetInstance.
Parameter | |
---|---|
Name | Description |
request |
google.cloud.notebooks.v1beta1.IResetInstanceRequest
ResetInstanceRequest message or plain object |
Returns | |
---|---|
Type | Description |
Promise<google.longrunning.Operation> | Promise |
setInstanceAccelerator(request, callback)
public setInstanceAccelerator(request: google.cloud.notebooks.v1beta1.ISetInstanceAcceleratorRequest, callback: google.cloud.notebooks.v1beta1.NotebookService.SetInstanceAcceleratorCallback): void;
Calls SetInstanceAccelerator.
Parameters | |
---|---|
Name | Description |
request |
ISetInstanceAcceleratorRequest
SetInstanceAcceleratorRequest message or plain object |
callback |
google.cloud.notebooks.v1beta1.NotebookService.SetInstanceAcceleratorCallback
Node-style callback called with the error, if any, and Operation |
Returns | |
---|---|
Type | Description |
void |
setInstanceAccelerator(request)
public setInstanceAccelerator(request: google.cloud.notebooks.v1beta1.ISetInstanceAcceleratorRequest): Promise<google.longrunning.Operation>;
Calls SetInstanceAccelerator.
Parameter | |
---|---|
Name | Description |
request |
ISetInstanceAcceleratorRequest
SetInstanceAcceleratorRequest message or plain object |
Returns | |
---|---|
Type | Description |
Promise<google.longrunning.Operation> | Promise |
setInstanceLabels(request, callback)
public setInstanceLabels(request: google.cloud.notebooks.v1beta1.ISetInstanceLabelsRequest, callback: google.cloud.notebooks.v1beta1.NotebookService.SetInstanceLabelsCallback): void;
Calls SetInstanceLabels.
Parameters | |
---|---|
Name | Description |
request |
ISetInstanceLabelsRequest
SetInstanceLabelsRequest message or plain object |
callback |
google.cloud.notebooks.v1beta1.NotebookService.SetInstanceLabelsCallback
Node-style callback called with the error, if any, and Operation |
Returns | |
---|---|
Type | Description |
void |
setInstanceLabels(request)
public setInstanceLabels(request: google.cloud.notebooks.v1beta1.ISetInstanceLabelsRequest): Promise<google.longrunning.Operation>;
Calls SetInstanceLabels.
Parameter | |
---|---|
Name | Description |
request |
ISetInstanceLabelsRequest
SetInstanceLabelsRequest message or plain object |
Returns | |
---|---|
Type | Description |
Promise<google.longrunning.Operation> | Promise |
setInstanceMachineType(request, callback)
public setInstanceMachineType(request: google.cloud.notebooks.v1beta1.ISetInstanceMachineTypeRequest, callback: google.cloud.notebooks.v1beta1.NotebookService.SetInstanceMachineTypeCallback): void;
Calls SetInstanceMachineType.
Parameters | |
---|---|
Name | Description |
request |
ISetInstanceMachineTypeRequest
SetInstanceMachineTypeRequest message or plain object |
callback |
google.cloud.notebooks.v1beta1.NotebookService.SetInstanceMachineTypeCallback
Node-style callback called with the error, if any, and Operation |
Returns | |
---|---|
Type | Description |
void |
setInstanceMachineType(request)
public setInstanceMachineType(request: google.cloud.notebooks.v1beta1.ISetInstanceMachineTypeRequest): Promise<google.longrunning.Operation>;
Calls SetInstanceMachineType.
Parameter | |
---|---|
Name | Description |
request |
ISetInstanceMachineTypeRequest
SetInstanceMachineTypeRequest message or plain object |
Returns | |
---|---|
Type | Description |
Promise<google.longrunning.Operation> | Promise |
startInstance(request, callback)
public startInstance(request: google.cloud.notebooks.v1beta1.IStartInstanceRequest, callback: google.cloud.notebooks.v1beta1.NotebookService.StartInstanceCallback): void;
Calls StartInstance.
Parameters | |
---|---|
Name | Description |
request |
IStartInstanceRequest
StartInstanceRequest message or plain object |
callback |
google.cloud.notebooks.v1beta1.NotebookService.StartInstanceCallback
Node-style callback called with the error, if any, and Operation |
Returns | |
---|---|
Type | Description |
void |
startInstance(request)
public startInstance(request: google.cloud.notebooks.v1beta1.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.v1beta1.IStopInstanceRequest, callback: google.cloud.notebooks.v1beta1.NotebookService.StopInstanceCallback): void;
Calls StopInstance.
Parameters | |
---|---|
Name | Description |
request |
IStopInstanceRequest
StopInstanceRequest message or plain object |
callback |
google.cloud.notebooks.v1beta1.NotebookService.StopInstanceCallback
Node-style callback called with the error, if any, and Operation |
Returns | |
---|---|
Type | Description |
void |
stopInstance(request)
public stopInstance(request: google.cloud.notebooks.v1beta1.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 |
upgradeInstance(request, callback)
public upgradeInstance(request: google.cloud.notebooks.v1beta1.IUpgradeInstanceRequest, callback: google.cloud.notebooks.v1beta1.NotebookService.UpgradeInstanceCallback): void;
Calls UpgradeInstance.
Parameters | |
---|---|
Name | Description |
request |
IUpgradeInstanceRequest
UpgradeInstanceRequest message or plain object |
callback |
google.cloud.notebooks.v1beta1.NotebookService.UpgradeInstanceCallback
Node-style callback called with the error, if any, and Operation |
Returns | |
---|---|
Type | Description |
void |
upgradeInstance(request)
public upgradeInstance(request: google.cloud.notebooks.v1beta1.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 |
upgradeInstanceInternal(request, callback)
public upgradeInstanceInternal(request: google.cloud.notebooks.v1beta1.IUpgradeInstanceInternalRequest, callback: google.cloud.notebooks.v1beta1.NotebookService.UpgradeInstanceInternalCallback): void;
Calls UpgradeInstanceInternal.
Parameters | |
---|---|
Name | Description |
request |
IUpgradeInstanceInternalRequest
UpgradeInstanceInternalRequest message or plain object |
callback |
google.cloud.notebooks.v1beta1.NotebookService.UpgradeInstanceInternalCallback
Node-style callback called with the error, if any, and Operation |
Returns | |
---|---|
Type | Description |
void |
upgradeInstanceInternal(request)
public upgradeInstanceInternal(request: google.cloud.notebooks.v1beta1.IUpgradeInstanceInternalRequest): Promise<google.longrunning.Operation>;
Calls UpgradeInstanceInternal.
Parameter | |
---|---|
Name | Description |
request |
IUpgradeInstanceInternalRequest
UpgradeInstanceInternalRequest message or plain object |
Returns | |
---|---|
Type | Description |
Promise<google.longrunning.Operation> | Promise |