list method
Lists the versions that have been created for the specified site.
This list includes versions for both the default live
channel and any
active preview channels for the specified site.
Request parameters:
parent
- Required. The site or channel for which to list versions, in
either of the following formats: - sites/SITE_ID -
sites/SITE_ID/channels/CHANNEL_ID
Value must have pattern ^sites/\[^/\]+$
.
filter
- A filter string used to return a subset of versions in the
response. The currently supported fields for filtering are: name
,
status
, and create_time
. Learn more about filtering in Google's
AIP 160 standard.
pageSize
- The maximum number of versions to return. The service may
return a lower number if fewer versions exist than this maximum number. If
unspecified, defaults to 25. The maximum value is 100; values above 100
will be coerced to 100.
pageToken
- A token from a previous call to ListVersions
that tells
the server where to resume listing.
$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.int? pageSize,
core.String? pageToken,
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if (filter != null) 'filter': [filter],
if (pageSize != null) 'pageSize': ['${pageSize}'],
if (pageToken != null) 'pageToken': [pageToken],
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v1beta1/' + 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>);
}