Google Cloud Ai Platform V1 Client - Class ListNotebookRuntimeTemplatesRequest (1.13.1)

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

Request message for NotebookService.ListNotebookRuntimeTemplates.

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

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 NotebookRuntimeTemplates. 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. * * 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]. * * display_name supports = and != * * labels supports general map functions that is: * * labels.key=value - key:value equality * * labels.key:* or labels:key - key existence * * A key including a space must be quoted.labels."a key". *notebookRuntimeTypesupports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. Some examples: *notebookRuntimeTemplate=notebookRuntimeTemplate123*displayName="myDisplayName"*labels.myKey="myValue"*notebookRuntimeType=USER_DEFINED`
↳ page_size int

Optional. The standard list page size.
↳ page_token string

Optional. The standard list page token. Typically obtained via ListNotebookRuntimeTemplatesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimeTemplates 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 NotebookRuntimeTemplates.

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

Returns
Type Description
string

setParent

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

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.

  • 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].
    • display_name supports = and !=
    • labels supports general map functions that is:
      • labels.key=value - key:value equality
      • `labels.key:* or labels:key - key existence
      • A key including a space must be quoted. labels."a key".
    • notebookRuntimeType supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. Some examples:
    • notebookRuntimeTemplate=notebookRuntimeTemplate123
    • displayName="myDisplayName"
    • labels.myKey="myValue"
    • notebookRuntimeType=USER_DEFINED
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.

  • 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].
    • display_name supports = and !=
    • labels supports general map functions that is:
      • labels.key=value - key:value equality
      • `labels.key:* or labels:key - key existence
      • A key including a space must be quoted. labels."a key".
    • notebookRuntimeType supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. Some examples:
    • notebookRuntimeTemplate=notebookRuntimeTemplate123
    • displayName="myDisplayName"
    • labels.myKey="myValue"
    • notebookRuntimeType=USER_DEFINED
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 ListNotebookRuntimeTemplatesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimeTemplates call.

Returns
Type Description
string

setPageToken

Optional. The standard list page token.

Typically obtained via ListNotebookRuntimeTemplatesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimeTemplates 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 NotebookRuntimeTemplates. Format: projects/{project}/locations/{location} Please see NotebookServiceClient::locationName() for help formatting this field.
Returns
Type Description
ListNotebookRuntimeTemplatesRequest