Represents a NotebookService
Inheritance
$protobuf.rpc.Service > protos.google.cloud.aiplatform.v1.NotebookServicePackage
@google-cloud/aiplatformConstructors
(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
assignNotebookRuntime(request, callback)
public assignNotebookRuntime(request: google.cloud.aiplatform.v1.IAssignNotebookRuntimeRequest, callback: google.cloud.aiplatform.v1.NotebookService.AssignNotebookRuntimeCallback): void;Calls AssignNotebookRuntime.
| Parameters | |
|---|---|
| Name | Description |
request |
IAssignNotebookRuntimeRequest
AssignNotebookRuntimeRequest message or plain object |
callback |
AssignNotebookRuntimeCallback
Node-style callback called with the error, if any, and Operation |
| Returns | |
|---|---|
| Type | Description |
void |
|
assignNotebookRuntime(request)
public assignNotebookRuntime(request: google.cloud.aiplatform.v1.IAssignNotebookRuntimeRequest): Promise<google.longrunning.Operation>;Calls AssignNotebookRuntime.
| Parameter | |
|---|---|
| Name | Description |
request |
IAssignNotebookRuntimeRequest
AssignNotebookRuntimeRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.longrunning.Operation> |
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. |
createNotebookExecutionJob(request, callback)
public createNotebookExecutionJob(request: google.cloud.aiplatform.v1.ICreateNotebookExecutionJobRequest, callback: google.cloud.aiplatform.v1.NotebookService.CreateNotebookExecutionJobCallback): void;Calls CreateNotebookExecutionJob.
| Parameters | |
|---|---|
| Name | Description |
request |
ICreateNotebookExecutionJobRequest
CreateNotebookExecutionJobRequest message or plain object |
callback |
CreateNotebookExecutionJobCallback
Node-style callback called with the error, if any, and Operation |
| Returns | |
|---|---|
| Type | Description |
void |
|
createNotebookExecutionJob(request)
public createNotebookExecutionJob(request: google.cloud.aiplatform.v1.ICreateNotebookExecutionJobRequest): Promise<google.longrunning.Operation>;Calls CreateNotebookExecutionJob.
| Parameter | |
|---|---|
| Name | Description |
request |
ICreateNotebookExecutionJobRequest
CreateNotebookExecutionJobRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.longrunning.Operation> |
Promise |
createNotebookRuntimeTemplate(request, callback)
public createNotebookRuntimeTemplate(request: google.cloud.aiplatform.v1.ICreateNotebookRuntimeTemplateRequest, callback: google.cloud.aiplatform.v1.NotebookService.CreateNotebookRuntimeTemplateCallback): void;Calls CreateNotebookRuntimeTemplate.
| Parameters | |
|---|---|
| Name | Description |
request |
ICreateNotebookRuntimeTemplateRequest
CreateNotebookRuntimeTemplateRequest message or plain object |
callback |
CreateNotebookRuntimeTemplateCallback
Node-style callback called with the error, if any, and Operation |
| Returns | |
|---|---|
| Type | Description |
void |
|
createNotebookRuntimeTemplate(request)
public createNotebookRuntimeTemplate(request: google.cloud.aiplatform.v1.ICreateNotebookRuntimeTemplateRequest): Promise<google.longrunning.Operation>;Calls CreateNotebookRuntimeTemplate.
| Parameter | |
|---|---|
| Name | Description |
request |
ICreateNotebookRuntimeTemplateRequest
CreateNotebookRuntimeTemplateRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.longrunning.Operation> |
Promise |
deleteNotebookExecutionJob(request, callback)
public deleteNotebookExecutionJob(request: google.cloud.aiplatform.v1.IDeleteNotebookExecutionJobRequest, callback: google.cloud.aiplatform.v1.NotebookService.DeleteNotebookExecutionJobCallback): void;Calls DeleteNotebookExecutionJob.
| Parameters | |
|---|---|
| Name | Description |
request |
IDeleteNotebookExecutionJobRequest
DeleteNotebookExecutionJobRequest message or plain object |
callback |
DeleteNotebookExecutionJobCallback
Node-style callback called with the error, if any, and Operation |
| Returns | |
|---|---|
| Type | Description |
void |
|
deleteNotebookExecutionJob(request)
public deleteNotebookExecutionJob(request: google.cloud.aiplatform.v1.IDeleteNotebookExecutionJobRequest): Promise<google.longrunning.Operation>;Calls DeleteNotebookExecutionJob.
| Parameter | |
|---|---|
| Name | Description |
request |
IDeleteNotebookExecutionJobRequest
DeleteNotebookExecutionJobRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.longrunning.Operation> |
Promise |
deleteNotebookRuntime(request, callback)
public deleteNotebookRuntime(request: google.cloud.aiplatform.v1.IDeleteNotebookRuntimeRequest, callback: google.cloud.aiplatform.v1.NotebookService.DeleteNotebookRuntimeCallback): void;Calls DeleteNotebookRuntime.
| Parameters | |
|---|---|
| Name | Description |
request |
IDeleteNotebookRuntimeRequest
DeleteNotebookRuntimeRequest message or plain object |
callback |
DeleteNotebookRuntimeCallback
Node-style callback called with the error, if any, and Operation |
| Returns | |
|---|---|
| Type | Description |
void |
|
deleteNotebookRuntime(request)
public deleteNotebookRuntime(request: google.cloud.aiplatform.v1.IDeleteNotebookRuntimeRequest): Promise<google.longrunning.Operation>;Calls DeleteNotebookRuntime.
| Parameter | |
|---|---|
| Name | Description |
request |
IDeleteNotebookRuntimeRequest
DeleteNotebookRuntimeRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.longrunning.Operation> |
Promise |
deleteNotebookRuntimeTemplate(request, callback)
public deleteNotebookRuntimeTemplate(request: google.cloud.aiplatform.v1.IDeleteNotebookRuntimeTemplateRequest, callback: google.cloud.aiplatform.v1.NotebookService.DeleteNotebookRuntimeTemplateCallback): void;Calls DeleteNotebookRuntimeTemplate.
| Parameters | |
|---|---|
| Name | Description |
request |
IDeleteNotebookRuntimeTemplateRequest
DeleteNotebookRuntimeTemplateRequest message or plain object |
callback |
DeleteNotebookRuntimeTemplateCallback
Node-style callback called with the error, if any, and Operation |
| Returns | |
|---|---|
| Type | Description |
void |
|
deleteNotebookRuntimeTemplate(request)
public deleteNotebookRuntimeTemplate(request: google.cloud.aiplatform.v1.IDeleteNotebookRuntimeTemplateRequest): Promise<google.longrunning.Operation>;Calls DeleteNotebookRuntimeTemplate.
| Parameter | |
|---|---|
| Name | Description |
request |
IDeleteNotebookRuntimeTemplateRequest
DeleteNotebookRuntimeTemplateRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.longrunning.Operation> |
Promise |
getNotebookExecutionJob(request, callback)
public getNotebookExecutionJob(request: google.cloud.aiplatform.v1.IGetNotebookExecutionJobRequest, callback: google.cloud.aiplatform.v1.NotebookService.GetNotebookExecutionJobCallback): void;Calls GetNotebookExecutionJob.
| Parameters | |
|---|---|
| Name | Description |
request |
IGetNotebookExecutionJobRequest
GetNotebookExecutionJobRequest message or plain object |
callback |
GetNotebookExecutionJobCallback
Node-style callback called with the error, if any, and NotebookExecutionJob |
| Returns | |
|---|---|
| Type | Description |
void |
|
getNotebookExecutionJob(request)
public getNotebookExecutionJob(request: google.cloud.aiplatform.v1.IGetNotebookExecutionJobRequest): Promise<google.cloud.aiplatform.v1.NotebookExecutionJob>;Calls GetNotebookExecutionJob.
| Parameter | |
|---|---|
| Name | Description |
request |
IGetNotebookExecutionJobRequest
GetNotebookExecutionJobRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.cloud.aiplatform.v1.NotebookExecutionJob> |
Promise |
getNotebookRuntime(request, callback)
public getNotebookRuntime(request: google.cloud.aiplatform.v1.IGetNotebookRuntimeRequest, callback: google.cloud.aiplatform.v1.NotebookService.GetNotebookRuntimeCallback): void;Calls GetNotebookRuntime.
| Parameters | |
|---|---|
| Name | Description |
request |
IGetNotebookRuntimeRequest
GetNotebookRuntimeRequest message or plain object |
callback |
GetNotebookRuntimeCallback
Node-style callback called with the error, if any, and NotebookRuntime |
| Returns | |
|---|---|
| Type | Description |
void |
|
getNotebookRuntime(request)
public getNotebookRuntime(request: google.cloud.aiplatform.v1.IGetNotebookRuntimeRequest): Promise<google.cloud.aiplatform.v1.NotebookRuntime>;Calls GetNotebookRuntime.
| Parameter | |
|---|---|
| Name | Description |
request |
IGetNotebookRuntimeRequest
GetNotebookRuntimeRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.cloud.aiplatform.v1.NotebookRuntime> |
Promise |
getNotebookRuntimeTemplate(request, callback)
public getNotebookRuntimeTemplate(request: google.cloud.aiplatform.v1.IGetNotebookRuntimeTemplateRequest, callback: google.cloud.aiplatform.v1.NotebookService.GetNotebookRuntimeTemplateCallback): void;Calls GetNotebookRuntimeTemplate.
| Parameters | |
|---|---|
| Name | Description |
request |
IGetNotebookRuntimeTemplateRequest
GetNotebookRuntimeTemplateRequest message or plain object |
callback |
GetNotebookRuntimeTemplateCallback
Node-style callback called with the error, if any, and NotebookRuntimeTemplate |
| Returns | |
|---|---|
| Type | Description |
void |
|
getNotebookRuntimeTemplate(request)
public getNotebookRuntimeTemplate(request: google.cloud.aiplatform.v1.IGetNotebookRuntimeTemplateRequest): Promise<google.cloud.aiplatform.v1.NotebookRuntimeTemplate>;Calls GetNotebookRuntimeTemplate.
| Parameter | |
|---|---|
| Name | Description |
request |
IGetNotebookRuntimeTemplateRequest
GetNotebookRuntimeTemplateRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.cloud.aiplatform.v1.NotebookRuntimeTemplate> |
Promise |
listNotebookExecutionJobs(request, callback)
public listNotebookExecutionJobs(request: google.cloud.aiplatform.v1.IListNotebookExecutionJobsRequest, callback: google.cloud.aiplatform.v1.NotebookService.ListNotebookExecutionJobsCallback): void;Calls ListNotebookExecutionJobs.
| Parameters | |
|---|---|
| Name | Description |
request |
IListNotebookExecutionJobsRequest
ListNotebookExecutionJobsRequest message or plain object |
callback |
ListNotebookExecutionJobsCallback
Node-style callback called with the error, if any, and ListNotebookExecutionJobsResponse |
| Returns | |
|---|---|
| Type | Description |
void |
|
listNotebookExecutionJobs(request)
public listNotebookExecutionJobs(request: google.cloud.aiplatform.v1.IListNotebookExecutionJobsRequest): Promise<google.cloud.aiplatform.v1.ListNotebookExecutionJobsResponse>;Calls ListNotebookExecutionJobs.
| Parameter | |
|---|---|
| Name | Description |
request |
IListNotebookExecutionJobsRequest
ListNotebookExecutionJobsRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.cloud.aiplatform.v1.ListNotebookExecutionJobsResponse> |
Promise |
listNotebookRuntimes(request, callback)
public listNotebookRuntimes(request: google.cloud.aiplatform.v1.IListNotebookRuntimesRequest, callback: google.cloud.aiplatform.v1.NotebookService.ListNotebookRuntimesCallback): void;Calls ListNotebookRuntimes.
| Parameters | |
|---|---|
| Name | Description |
request |
IListNotebookRuntimesRequest
ListNotebookRuntimesRequest message or plain object |
callback |
ListNotebookRuntimesCallback
Node-style callback called with the error, if any, and ListNotebookRuntimesResponse |
| Returns | |
|---|---|
| Type | Description |
void |
|
listNotebookRuntimes(request)
public listNotebookRuntimes(request: google.cloud.aiplatform.v1.IListNotebookRuntimesRequest): Promise<google.cloud.aiplatform.v1.ListNotebookRuntimesResponse>;Calls ListNotebookRuntimes.
| Parameter | |
|---|---|
| Name | Description |
request |
IListNotebookRuntimesRequest
ListNotebookRuntimesRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.cloud.aiplatform.v1.ListNotebookRuntimesResponse> |
Promise |
listNotebookRuntimeTemplates(request, callback)
public listNotebookRuntimeTemplates(request: google.cloud.aiplatform.v1.IListNotebookRuntimeTemplatesRequest, callback: google.cloud.aiplatform.v1.NotebookService.ListNotebookRuntimeTemplatesCallback): void;Calls ListNotebookRuntimeTemplates.
| Parameters | |
|---|---|
| Name | Description |
request |
IListNotebookRuntimeTemplatesRequest
ListNotebookRuntimeTemplatesRequest message or plain object |
callback |
ListNotebookRuntimeTemplatesCallback
Node-style callback called with the error, if any, and ListNotebookRuntimeTemplatesResponse |
| Returns | |
|---|---|
| Type | Description |
void |
|
listNotebookRuntimeTemplates(request)
public listNotebookRuntimeTemplates(request: google.cloud.aiplatform.v1.IListNotebookRuntimeTemplatesRequest): Promise<google.cloud.aiplatform.v1.ListNotebookRuntimeTemplatesResponse>;Calls ListNotebookRuntimeTemplates.
| Parameter | |
|---|---|
| Name | Description |
request |
IListNotebookRuntimeTemplatesRequest
ListNotebookRuntimeTemplatesRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.cloud.aiplatform.v1.ListNotebookRuntimeTemplatesResponse> |
Promise |
startNotebookRuntime(request, callback)
public startNotebookRuntime(request: google.cloud.aiplatform.v1.IStartNotebookRuntimeRequest, callback: google.cloud.aiplatform.v1.NotebookService.StartNotebookRuntimeCallback): void;Calls StartNotebookRuntime.
| Parameters | |
|---|---|
| Name | Description |
request |
IStartNotebookRuntimeRequest
StartNotebookRuntimeRequest message or plain object |
callback |
StartNotebookRuntimeCallback
Node-style callback called with the error, if any, and Operation |
| Returns | |
|---|---|
| Type | Description |
void |
|
startNotebookRuntime(request)
public startNotebookRuntime(request: google.cloud.aiplatform.v1.IStartNotebookRuntimeRequest): Promise<google.longrunning.Operation>;Calls StartNotebookRuntime.
| Parameter | |
|---|---|
| Name | Description |
request |
IStartNotebookRuntimeRequest
StartNotebookRuntimeRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.longrunning.Operation> |
Promise |
stopNotebookRuntime(request, callback)
public stopNotebookRuntime(request: google.cloud.aiplatform.v1.IStopNotebookRuntimeRequest, callback: google.cloud.aiplatform.v1.NotebookService.StopNotebookRuntimeCallback): void;Calls StopNotebookRuntime.
| Parameters | |
|---|---|
| Name | Description |
request |
IStopNotebookRuntimeRequest
StopNotebookRuntimeRequest message or plain object |
callback |
StopNotebookRuntimeCallback
Node-style callback called with the error, if any, and Operation |
| Returns | |
|---|---|
| Type | Description |
void |
|
stopNotebookRuntime(request)
public stopNotebookRuntime(request: google.cloud.aiplatform.v1.IStopNotebookRuntimeRequest): Promise<google.longrunning.Operation>;Calls StopNotebookRuntime.
| Parameter | |
|---|---|
| Name | Description |
request |
IStopNotebookRuntimeRequest
StopNotebookRuntimeRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.longrunning.Operation> |
Promise |
updateNotebookRuntimeTemplate(request, callback)
public updateNotebookRuntimeTemplate(request: google.cloud.aiplatform.v1.IUpdateNotebookRuntimeTemplateRequest, callback: google.cloud.aiplatform.v1.NotebookService.UpdateNotebookRuntimeTemplateCallback): void;Calls UpdateNotebookRuntimeTemplate.
| Parameters | |
|---|---|
| Name | Description |
request |
IUpdateNotebookRuntimeTemplateRequest
UpdateNotebookRuntimeTemplateRequest message or plain object |
callback |
UpdateNotebookRuntimeTemplateCallback
Node-style callback called with the error, if any, and NotebookRuntimeTemplate |
| Returns | |
|---|---|
| Type | Description |
void |
|
updateNotebookRuntimeTemplate(request)
public updateNotebookRuntimeTemplate(request: google.cloud.aiplatform.v1.IUpdateNotebookRuntimeTemplateRequest): Promise<google.cloud.aiplatform.v1.NotebookRuntimeTemplate>;Calls UpdateNotebookRuntimeTemplate.
| Parameter | |
|---|---|
| Name | Description |
request |
IUpdateNotebookRuntimeTemplateRequest
UpdateNotebookRuntimeTemplateRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.cloud.aiplatform.v1.NotebookRuntimeTemplate> |
Promise |
upgradeNotebookRuntime(request, callback)
public upgradeNotebookRuntime(request: google.cloud.aiplatform.v1.IUpgradeNotebookRuntimeRequest, callback: google.cloud.aiplatform.v1.NotebookService.UpgradeNotebookRuntimeCallback): void;Calls UpgradeNotebookRuntime.
| Parameters | |
|---|---|
| Name | Description |
request |
IUpgradeNotebookRuntimeRequest
UpgradeNotebookRuntimeRequest message or plain object |
callback |
UpgradeNotebookRuntimeCallback
Node-style callback called with the error, if any, and Operation |
| Returns | |
|---|---|
| Type | Description |
void |
|
upgradeNotebookRuntime(request)
public upgradeNotebookRuntime(request: google.cloud.aiplatform.v1.IUpgradeNotebookRuntimeRequest): Promise<google.longrunning.Operation>;Calls UpgradeNotebookRuntime.
| Parameter | |
|---|---|
| Name | Description |
request |
IUpgradeNotebookRuntimeRequest
UpgradeNotebookRuntimeRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.longrunning.Operation> |
Promise |