Full name: projects.locations.notebookRuntimes.list
Lists NotebookRuntimes in a Location.
Endpoint
gethttps:
Where {service-endpoint}
is one of the supported service endpoints
.
Path parameters
parent
string
Required. The resource name of the Location from which to list the NotebookRuntimes. Format: projects/{project}/locations/{location}
Query parameters
filter
string
Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported.
-
notebookRuntimesupports = and !=.notebookRuntimerepresents the NotebookRuntime id, i.e. the last segment of the NotebookRuntime'sresource name. -
displayNamesupports = and != and regex. -
notebookRuntimeTemplatesupports = and !=.notebookRuntimeTemplaterepresents the NotebookRuntimeTemplate id, i.e. the last segment of the NotebookRuntimeTemplate'sresource name. -
healthStatesupports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED]. -
runtimeStatesupports = and !=. runtimeState enum: [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED, ERROR, INVALID]. -
runtimeUsersupports = and !=. - API version is UI only:
uiStatesupports = and !=. uiState enum: [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED, UI_RESOURCE_STATE_CREATION_FAILED]. -
notebookRuntimeTypesupports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. -
machineTypesupports = and !=. -
acceleratorTypesupports = and !=.
Some examples:
-
notebookRuntime="notebookRuntime123" -
displayName="myDisplayName"anddisplayName=~"myDisplayNameRegex" -
notebookRuntimeTemplate="notebookRuntimeTemplate321" -
healthState=HEALTHY -
runtimeState=RUNNING -
runtimeUser="test@google.com" -
uiState=UI_RESOURCE_STATE_BEING_DELETED -
notebookRuntimeType=USER_DEFINED -
machineType=e2-standard-4 -
acceleratorType=NVIDIA_TESLA_T4
pageSize
integer
Optional. The standard list page size.
pageToken
string
Optional. The standard list page token. Typically obtained via ListNotebookRuntimesResponse.next_page_token
of the previous NotebookService.ListNotebookRuntimes
call.
readMask
string ( FieldMask
format)
Optional. Mask specifying which fields to read.
This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo"
.
orderBy
string
Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields:
-
displayName -
createTime -
updateTime
Example: displayName, createTime desc
.
Request body
The request body must be empty.
Response body
Response message for NotebookService.ListNotebookRuntimes
.
If successful, the response body contains data with the following structure:
notebookRuntimes[]
object ( NotebookRuntime
)
List of NotebookRuntimes in the requested page.
nextPageToken
string
A token to retrieve next page of results. Pass to ListNotebookRuntimesRequest.page_token
to obtain that page.
| JSON representation |
|---|
{
"notebookRuntimes"
:
[
{
object (
|
