Google Cloud Ai Platform V1 Client - Class ListNotebookRuntimesRequest (1.54.0)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class ListNotebookRuntimesRequest.

Request message for NotebookService.ListNotebookRuntimes.

Generated from protobuf message google.cloud.aiplatform.v1.ListNotebookRuntimesRequest

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ parent string

Required. The resource name of the Location from which to list the NotebookRuntimes. Format: projects/{project}/locations/{location}
↳ filter 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]. * * 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 string

Optional. The standard list page token. Typically obtained via ListNotebookRuntimesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimes call.
↳ read_mask Google\Protobuf\FieldMask

Optional. Mask specifying which fields to read.
↳ order_by 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.

getParent

Required. The resource name of the Location from which to list the NotebookRuntimes.

Format: projects/{project}/locations/{location}

Returns
Type Description
string

setParent

Required. The resource name of the Location from which to list the NotebookRuntimes.

Format: projects/{project}/locations/{location}

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

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
Returns
Type Description
string

setFilter

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
Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

Optional. The standard list page size.

Returns
Type Description
int

setPageSize

Optional. The standard list page size.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

Optional. The standard list page token.

Typically obtained via ListNotebookRuntimesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimes call.

Returns
Type Description
string

setPageToken

Optional. The standard list page token.

Typically obtained via ListNotebookRuntimesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimes call.

Parameter
Name Description
var string
Returns
Type Description
$this

getReadMask

Optional. Mask specifying which fields to read.

Returns
Type Description
Google\Protobuf\FieldMask|null

hasReadMask

clearReadMask

setReadMask

Optional. Mask specifying which fields to read.

Parameter
Name Description
var Google\Protobuf\FieldMask
Returns
Type Description
$this

getOrderBy

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

setOrderBy

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.
Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The resource name of the Location from which to list the NotebookRuntimes. Format: projects/{project}/locations/{location} Please see NotebookServiceClient::locationName() for help formatting this field.
Returns
Type Description
ListNotebookRuntimesRequest