Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::ListNotebookRuntimesRequest (v0.41.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

Returns

(::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" and displayName=~"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

Parameter

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" and displayName=~"myDisplayNameRegex"
- notebookRuntimeTemplate="notebookRuntimeTemplate321"
- healthState=HEALTHY
- runtimeState=RUNNING
- runtimeUser="test@google.com"
- uiState=UI_RESOURCE_STATE_BEING_DELETED
- notebookRuntimeType=USER_DEFINED

Returns

(::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" and displayName=~"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

Returns

(::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

Parameter

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.

Returns

(::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

Returns

(::Integer) — Optional. The standard list page size.

#page_size=

def page_size=(value) -> ::Integer

Parameter

value (::Integer) — Optional. The standard list page size.

Returns

(::Integer) — Optional. The standard list page size.

#page_token

def page_token() -> ::String

Returns

(::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

Parameter

value (::String) — Optional. The standard list page token. Typically obtained via ListNotebookRuntimesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimes call.

Returns

(::String) — Optional. The standard list page token. Typically obtained via ListNotebookRuntimesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimes call.

#parent

def parent() -> ::String

Returns

(::String) — Required. The resource name of the Location from which to list the NotebookRuntimes. Format: projects/{project}/locations/{location}

#parent=

def parent=(value) -> ::String

Parameter

value (::String) — Required. The resource name of the Location from which to list the NotebookRuntimes. Format: projects/{project}/locations/{location}

Returns

(::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

Returns

(::Google::Protobuf::FieldMask) — Optional. Mask specifying which fields to read.

#read_mask=

def read_mask=(value) -> ::Google::Protobuf::FieldMask

Parameter

value (::Google::Protobuf::FieldMask) — Optional. Mask specifying which fields to read.

Returns

(::Google::Protobuf::FieldMask) — Optional. Mask specifying which fields to read.