Class: Google::Cloud::AIPlatform::V1::ListNotebookRuntimeTemplatesRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/aiplatform/v1/notebook_service.rb

Overview

Request message for NotebookService.ListNotebookRuntimeTemplates.

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ ::String

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

  • (::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".
    • notebookRuntimeType supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK].

    Some examples:

    • notebookRuntimeTemplate=notebookRuntimeTemplate123
    • displayName="myDisplayName"
    • labels.myKey="myValue"
    • notebookRuntimeType=USER_DEFINED


117
118
119
120
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_service.rb', line 117

class ListNotebookRuntimeTemplatesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#order_by ⇒ ::String

Returns 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.



117
118
119
120
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_service.rb', line 117

class ListNotebookRuntimeTemplatesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_size ⇒ ::Integer

Returns Optional. The standard list page size.

Returns:

  • (::Integer) —

    Optional. The standard list page size.



117
118
119
120
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_service.rb', line 117

class ListNotebookRuntimeTemplatesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_token ⇒ ::String

Returns Optional. The standard list page token. Typically obtained via ListNotebookRuntimeTemplatesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimeTemplates call.

Returns:



117
118
119
120
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_service.rb', line 117

class ListNotebookRuntimeTemplatesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#parent ⇒ ::String

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

Returns:

  • (::String) —

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



117
118
119
120
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_service.rb', line 117

class ListNotebookRuntimeTemplatesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#read_mask ⇒ ::Google::Protobuf::FieldMask

Returns Optional. Mask specifying which fields to read.

Returns:



117
118
119
120
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_service.rb', line 117

class ListNotebookRuntimeTemplatesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end