ListNotebookRuntimesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)Request message for NotebookService.ListNotebookRuntimes.
Attributes |
|
|---|---|
| Name | Description |
parent |
str
Required. The resource name of the Location from which to list the NotebookRuntimes. Format: projects/{project}/locations/{location}
|
filter |
str
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]
[google.cloud.aiplatform.v1.NotebookRuntime.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]
[google.cloud.aiplatform.v1.NotebookRuntimeTemplate.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].
- machineType supports = and !=.
- acceleratorType supports = and !=.
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
- machineType=e2-standard-4
- acceleratorType=NVIDIA_TESLA_T4
|
page_size |
int
Optional. The standard list page size. |
page_token |
str
Optional. The standard list page token. Typically obtained via ListNotebookRuntimesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimes call. |
read_mask |
google.protobuf.field_mask_pb2.FieldMask
Optional. Mask specifying which fields to read. |
order_by |
str
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.
|
Methods
ListNotebookRuntimesRequest
ListNotebookRuntimesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)Request message for NotebookService.ListNotebookRuntimes.