NotebookEngineService

Returns a collection of NotebookEngines within a workspace.

get/v1/{parent}/notebookEngines

Request

Base URL
https://docs.h2o.ai (the document declares no server; this is the origin it was published from)
Auth
none declared
TypeScript
https://skmtc.dev/h2o/apis/ai-h2o-engine-sandbox-v1-filesystem-proto/docs/v1/:parent/notebookEngines/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

parentstring required

Workspace resource name. Format: workspaces/{workspace}

Authorization may require the following permission on the engine's parent workspace:

actions/enginemanager/notebookEngines/LIST

Query parameters

pageSizeinteger

Maximum number of NotebookEngines to return in a response. If unspecified (or set to 0), at most 50 NotebookEngines will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

pageTokenstring

Leave unset to receive the initial page. To list any subsequent pages use the value of 'next_page_token' returned from the ListNotebookEnginesResponse.

Response

A successful response.

nextPageTokenstring

Used to retrieve the next page of results. When unset, no further items are available (this response was the last page).

totalSizeinteger

Total number of NotebookEngines matched by the List request.

Changes

No recorded changes to this operation across all 1 revision of this API.