Cloud AI Platform v1 API - Class ListNotebookRuntimesRequest (3.3.0) 

public sealed class ListNotebookRuntimesRequest : IMessage<ListNotebookRuntimesRequest>, IEquatable<ListNotebookRuntimesRequest>, IDeepCloneable<ListNotebookRuntimesRequest>, IBufferMessage, IMessage, IPageRequest

Reference documentation and code samples for the Cloud AI Platform v1 API class ListNotebookRuntimesRequest.

Request message for [NotebookService.ListNotebookRuntimes][google.cloud.aiplatform.v1.NotebookService.ListNotebookRuntimes].

Inheritance

object > ListNotebookRuntimesRequest

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

ListNotebookRuntimesRequest()

public ListNotebookRuntimesRequest()

ListNotebookRuntimesRequest(ListNotebookRuntimesRequest)

public ListNotebookRuntimesRequest(ListNotebookRuntimesRequest other)
Parameter
Name Description
other ListNotebookRuntimesRequest

Properties

Filter

public string Filter { get; set; }

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
Property Value
Type Description
string

OrderBy

public string OrderBy { get; set; }

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.

Property Value
Type Description
string

PageSize

public int PageSize { get; set; }

Optional. The standard list page size.

Property Value
Type Description
int

PageToken

public string PageToken { get; set; }

Optional. The standard list page token. Typically obtained via [ListNotebookRuntimesResponse.next_page_token][google.cloud.aiplatform.v1.ListNotebookRuntimesResponse.next_page_token] of the previous [NotebookService.ListNotebookRuntimes][google.cloud.aiplatform.v1.NotebookService.ListNotebookRuntimes] call.

Property Value
Type Description
string

Parent

public string Parent { get; set; }

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

Property Value
Type Description
string

ParentAsLocationName

public LocationName ParentAsLocationName { get; set; }

LocationName-typed view over the Parent resource name property.

Property Value
Type Description
LocationName

ReadMask

public FieldMask ReadMask { get; set; }

Optional. Mask specifying which fields to read.

Property Value
Type Description
FieldMask