Class: Google::Cloud::AIPlatform::V1::ListModelsRequest

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

Overview

Request message for ModelService.ListModels.

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ ::String

Returns An expression for filtering the results of the request. For field names both snake_case and camelCase are supported.

  • model supports = and !=. model represents the Model ID, i.e. the last segment of the Model's [resource name][google.cloud.aiplatform.v1.Model.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".
  • base_model_name only supports =

Some examples:

  • model=1234
  • displayName="myDisplayName"
  • labels.myKey="myValue"
  • baseModelName="text-bison".

Returns:

  • (::String) —

    An expression for filtering the results of the request. For field names both snake_case and camelCase are supported.

    • model supports = and !=. model represents the Model ID, i.e. the last segment of the Model's [resource name][google.cloud.aiplatform.v1.Model.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".
    • base_model_name only supports =

    Some examples:

    • model=1234
    • displayName="myDisplayName"
    • labels.myKey="myValue"
    • baseModelName="text-bison"


157
158
159
160
 
# File 'proto_docs/google/cloud/aiplatform/v1/model_service.rb', line 157

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

#order_by ⇒ ::String

Returns 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) —

    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.



157
158
159
160
 
# File 'proto_docs/google/cloud/aiplatform/v1/model_service.rb', line 157

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

#page_size ⇒ ::Integer

Returns The standard list page size.

Returns:

  • (::Integer) —

    The standard list page size.



157
158
159
160
 
# File 'proto_docs/google/cloud/aiplatform/v1/model_service.rb', line 157

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

#page_token ⇒ ::String

Returns The standard list page token. Typically obtained via ListModelsResponse.next_page_token of the previous ModelService.ListModels call.

Returns:



157
158
159
160
 
# File 'proto_docs/google/cloud/aiplatform/v1/model_service.rb', line 157

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

#parent ⇒ ::String

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

Returns:

  • (::String) —

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



157
158
159
160
 
# File 'proto_docs/google/cloud/aiplatform/v1/model_service.rb', line 157

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

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

Returns Mask specifying which fields to read.

Returns:



157
158
159
160
 
# File 'proto_docs/google/cloud/aiplatform/v1/model_service.rb', line 157

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