list method
Returns list of version for the given platform/channel.
Request parameters:
parent
- Required. The channel, which owns this collection of versions.
Format: {product}/platforms/{platform}/channels/{channel}
Value must have pattern ^\[^/\]+/platforms/\[^/\]+/channels/\[^/\]+$
.
filter
- Optional. Filter string. Format is a comma separated list of
All comma separated filter clauses are conjoined with a logical "and".
Valid field_names are "version", "name", "platform", and "channel". Valid
operators are "<", "<=", "=", ">=", and ">". Channel comparison is
done by distance from stable. Ex) stable < beta, beta < dev, canary <
canary_asan. Version comparison is done numerically. If version is not
entirely written, the version will be appended with 0 in missing fields.
Ex) version > 80 becoms version > 80.0.0.0 Name and platform are
filtered by string comparison. Ex) "...?filter=channel<=beta, version >=
80 Ex) "...?filter=version > 80, version < 81
orderBy
- Optional. Ordering string. Valid order_by strings are
"version", "name", "platform", and "channel". Optionally, you can append "
desc" or " asc" to specify the sorting order. Multiple order_by strings
can be used in a comma separated list. Ordering by channel will sort by
distance from the stable channel (not alphabetically). A list of channels
sorted in this order is: stable, beta, dev, canary, and canary_asan.
Sorting by name may cause unexpected behaviour as it is a naive string
sort. For example, 1.0.0.8 will be before 1.0.0.10 in descending order. If
order_by is not specified the response will be sorted by version in
descending order. Ex) "...?order_by=version asc" Ex)
"...?order_by=platform desc, channel, version"
pageSize
- Optional. Optional limit on the number of versions to include
in the response. If unspecified, the server will pick an appropriate
default.
pageToken
- Optional. A page token, received from a previous
ListVersions
call. Provide this to retrieve the subsequent page.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a ListVersionsResponse.
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<ListVersionsResponse> list(
core.String parent, {
core.String? filter,
core.String? orderBy,
core.int? pageSize,
core.String? pageToken,
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 ($fields != null) 'fields': [$fields],
};
final url_ = 'v1/' + core.Uri.encodeFull('$parent') + '/versions';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return ListVersionsResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>);
}