Class ListNotebookRuntimesRequest (1.49.0)

Version latest

• 1.49.0 (latest)
• 1.48.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.39.0
• 1.38.1
• 1.37.0
• 1.36.4
• 1.35.0
• 1.34.0
• 1.33.1
• 1.32.0
• 1.31.1
• 1.30.1
• 1.29.0
• 1.28.1
• 1.27.1
• 1.26.1
• 1.25.0
• 1.24.1
• 1.23.0
• 1.22.1
• 1.21.0
• 1.20.0
• 1.19.1
• 1.18.3
• 1.17.1
• 1.16.1
• 1.15.1
• 1.14.0
• 1.13.1
• 1.12.1
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.1
• 1.7.1
• 1.6.2
• 1.5.0
• 1.4.3
• 1.3.0
• 1.2.0
• 1.1.1
• 1.0.1
• 0.9.0
• 0.8.0
• 0.7.1
• 0.6.0
• 0.5.1
• 0.4.0
• 0.3.1

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.v1beta1.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.v1beta1.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]. Some examples: - notebookRuntime="notebookRuntime123" - displayName="myDisplayName" and displayName="myDisplayNameRegex"` - notebookRuntimeTemplate="notebookRuntimeTemplate321" - healthState=HEALTHY - runtimeState=RUNNING - runtimeUser="[e-mail]" - uiState=UI_RESOURCE_STATE_BEING_DELETED - notebookRuntimeType=USER_DEFINED
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.