list method
Lists Models in a Location.
Request parameters:
parent
- Required. The resource name of the Location to list the Models
from. Format: projects/{project}/locations/{location}
Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+$
.
filter
- 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. * `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"`
orderBy
- 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
.
pageSize
- The standard list page size.
pageToken
- The standard list page token. Typically obtained via
ListModelsResponse.next_page_token of the previous ModelService.ListModels
call.
readMask
- Mask specifying which fields to read.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a GoogleCloudAiplatformV1ListModelsResponse.
Completes with a commons.ApiRequestError if the API endpoint returned an error.
If the used http.Client
completes with an error when making a REST call,
this method will complete with the same error.
Implementation
async.Future<GoogleCloudAiplatformV1ListModelsResponse> list(
core.String parent, {
core.String? filter,
core.String? orderBy,
core.int? pageSize,
core.String? pageToken,
core.String? readMask,
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if (filter != null) 'filter': [filter],
if (orderBy != null) 'orderBy': [orderBy],
if (pageSize != null) 'pageSize': ['${pageSize}'],
if (pageToken != null) 'pageToken': [pageToken],
if (readMask != null) 'readMask': [readMask],
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v1/' + core.Uri.encodeFull('$parent') + '/models';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return GoogleCloudAiplatformV1ListModelsResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>);
}