- 0.58.0 (latest)
- 0.57.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.49.0
- 0.48.0
- 0.47.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.1
- 0.8.0
- 0.7.0
- 0.6.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::ListNotebookRuntimesRequest.
Request message for NotebookService.ListNotebookRuntimes.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#filter
def filter() -> ::String
-
(::String) —
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].
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
#filter=
def filter=(value) -> ::String
-
value (::String) —
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].
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
-
(::String) —
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].
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
#order_by
def order_by() -> ::String
-
(::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:
display_name
create_time
update_time
Example:
display_name, create_time desc
.
#order_by=
def order_by=(value) -> ::String
-
value (::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:
display_name
create_time
update_time
Example:
display_name, create_time desc
.
-
(::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:
display_name
create_time
update_time
Example:
display_name, create_time desc
.
#page_size
def page_size() -> ::Integer
- (::Integer) — Optional. The standard list page size.
#page_size=
def page_size=(value) -> ::Integer
- value (::Integer) — Optional. The standard list page size.
- (::Integer) — Optional. The standard list page size.
#page_token
def page_token() -> ::String
- (::String) — Optional. The standard list page token. Typically obtained via ListNotebookRuntimesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimes call.
#page_token=
def page_token=(value) -> ::String
- value (::String) — Optional. The standard list page token. Typically obtained via ListNotebookRuntimesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimes call.
- (::String) — Optional. The standard list page token. Typically obtained via ListNotebookRuntimesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimes call.
#parent
def parent() -> ::String
-
(::String) — Required. The resource name of the Location from which to list the
NotebookRuntimes.
Format:
projects/{project}/locations/{location}
#parent=
def parent=(value) -> ::String
-
value (::String) — Required. The resource name of the Location from which to list the
NotebookRuntimes.
Format:
projects/{project}/locations/{location}
-
(::String) — Required. The resource name of the Location from which to list the
NotebookRuntimes.
Format:
projects/{project}/locations/{location}
#read_mask
def read_mask() -> ::Google::Protobuf::FieldMask
- (::Google::Protobuf::FieldMask) — Optional. Mask specifying which fields to read.
#read_mask=
def read_mask=(value) -> ::Google::Protobuf::FieldMask
- value (::Google::Protobuf::FieldMask) — Optional. Mask specifying which fields to read.
- (::Google::Protobuf::FieldMask) — Optional. Mask specifying which fields to read.