list method
Lists NotebookRuntimes in a Location.
Request parameters:
parent
- Required. The resource name of the Location from which to list
the NotebookRuntimes. Format: projects/{project}/locations/{location}
Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+$
.
filter
- Optional. An expression for filtering the results of the
request. For field names both snake_case and camelCase are supported. *
notebookRuntime
supports = and !=. notebookRuntime
represents the
NotebookRuntime ID, i.e. the last segment of the NotebookRuntime's
resource name. * displayName
supports = and != and regex. *
notebookRuntimeTemplate
supports = and !=. notebookRuntimeTemplate
represents the NotebookRuntimeTemplate ID, i.e. the last segment of the
NotebookRuntimeTemplate's resource name. * healthState
supports = and
!=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED]. *
runtimeState
supports = and !=. runtimeState enum:
[RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED,
STOPPED, BEING_UPGRADED, ERROR, INVALID]. * runtimeUser
supports = and
!=. * API version is UI only: uiState
supports = 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]. * notebookRuntimeType
supports =
and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. Some
examples: * notebookRuntime="notebookRuntime123"
*
displayName="myDisplayName"
and displayName=~"myDisplayNameRegex"
*
notebookRuntimeTemplate="notebookRuntimeTemplate321"
*
healthState=HEALTHY
* runtimeState=RUNNING
*
runtimeUser="test@google.com"
*
uiState=UI_RESOURCE_STATE_BEING_DELETED
*
notebookRuntimeType=USER_DEFINED
orderBy
- Optional. A comma-separated list of fields to order by, sorted
in ascending order. Use "desc" after a field name for descending.
Supported fields: * display_name
* create_time
* update_time
Example: display_name, create_time desc
.
pageSize
- Optional. The standard list page size.
pageToken
- Optional. The standard list page token. Typically obtained
via ListNotebookRuntimesResponse.next_page_token of the previous
NotebookService.ListNotebookRuntimes call.
readMask
- Optional. Mask specifying which fields to read.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a GoogleCloudAiplatformV1ListNotebookRuntimesResponse.
Completes with a commons.ApiRequestError if the API endpoint returned an error.
If the used http.Client
completes with an error when making a REST call,
this method will complete with the same error.
Implementation
async.Future<GoogleCloudAiplatformV1ListNotebookRuntimesResponse> list(
core.String parent, {
core.String? filter,
core.String? orderBy,
core.int? pageSize,
core.String? pageToken,
core.String? readMask,
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if (filter != null) 'filter': [filter],
if (orderBy != null) 'orderBy': [orderBy],
if (pageSize != null) 'pageSize': ['${pageSize}'],
if (pageToken != null) 'pageToken': [pageToken],
if (readMask != null) 'readMask': [readMask],
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v1/' + core.Uri.encodeFull('$parent') + '/notebookRuntimes';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return GoogleCloudAiplatformV1ListNotebookRuntimesResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>);
}