Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::ListModelsRequest (v0.18.0)

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::ListModelsRequest.

Request message for ModelService.ListModels.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#filter

def filter() -> ::String
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".

    Some examples:

    • model=1234
    • displayName="myDisplayName"
    • labels.myKey="myValue"

#filter=

def filter=(value) -> ::String
Parameter
  • value (::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".

    Some examples:

    • model=1234
    • displayName="myDisplayName"
    • labels.myKey="myValue"
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".

    Some examples:

    • model=1234
    • displayName="myDisplayName"
    • labels.myKey="myValue"

#order_by

def order_by() -> ::String
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.

#order_by=

def order_by=(value) -> ::String
Parameter
  • value (::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.

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.

#page_size

def page_size() -> ::Integer
Returns
  • (::Integer) — The standard list page size.

#page_size=

def page_size=(value) -> ::Integer
Parameter
  • value (::Integer) — The standard list page size.
Returns
  • (::Integer) — The standard list page size.

#page_token

def page_token() -> ::String
Returns

#page_token=

def page_token=(value) -> ::String
Parameter
Returns

#parent

def parent() -> ::String
Returns
  • (::String) — Required. The resource name of the Location to list the Models from. Format: projects/{project}/locations/{location}

#parent=

def parent=(value) -> ::String
Parameter
  • value (::String) — 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}

#read_mask

def read_mask() -> ::Google::Protobuf::FieldMask
Returns

#read_mask=

def read_mask=(value) -> ::Google::Protobuf::FieldMask
Parameter
Returns