Cloud AI Platform v1 API - Class ListModelsRequest (3.13.0) 

public sealed class ListModelsRequest : IMessage<ListModelsRequest>, IEquatable<ListModelsRequest>, IDeepCloneable<ListModelsRequest>, IBufferMessage, IMessage, IPageRequest

Reference documentation and code samples for the Cloud AI Platform v1 API class ListModelsRequest.

Request message for [ModelService.ListModels][google.cloud.aiplatform.v1.ModelService.ListModels].

Inheritance

object > ListModelsRequest

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

ListModelsRequest()

public ListModelsRequest()

ListModelsRequest(ListModelsRequest)

public ListModelsRequest(ListModelsRequest other)
Parameter
Name Description
other ListModelsRequest

Properties

Filter

public string Filter { get; set; }

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"
Property Value
Type Description
string

OrderBy

public string OrderBy { get; set; }

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.

Property Value
Type Description
string

PageSize

public int PageSize { get; set; }

The standard list page size.

Property Value
Type Description
int

PageToken

public string PageToken { get; set; }

The standard list page token. Typically obtained via [ListModelsResponse.next_page_token][google.cloud.aiplatform.v1.ListModelsResponse.next_page_token] of the previous [ModelService.ListModels][google.cloud.aiplatform.v1.ModelService.ListModels] call.

Property Value
Type Description
string

Parent

public string Parent { get; set; }

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

Property Value
Type Description
string

ParentAsLocationName

public LocationName ParentAsLocationName { get; set; }

LocationName-typed view over the Parent resource name property.

Property Value
Type Description
LocationName

ReadMask

public FieldMask ReadMask { get; set; }

Mask specifying which fields to read.

Property Value
Type Description
FieldMask