list method
List curation resources in the API hub.
Request parameters:
parent
- Required. The parent, which owns this collection of curation
resources. Format: projects/{project}/locations/{location}
Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+$
.
filter
- Optional. An expression that filters the list of curation
resources. A filter expression consists of a field name, a comparison
operator, and a value for filtering. The value must be a string. The
comparison operator must be one of: <
, >
, :
or =
. Filters are case
insensitive. The following fields in the curation resource
are eligible
for filtering: * create_time
- The time at which the curation was
created. The value should be in the
(RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed
comparison operators: >
and <
. * display_name
- The display name of
the curation. Allowed comparison operators: =
. * state
- The state of
the curation. Allowed comparison operators: =
. Expressions are combined
with either AND
logic operator or OR
logical operator but not both of
them together i.e. only one of the AND
or OR
operator can be used
throughout the filter string and both the operators cannot be used
together. No other logical operators are supported. At most three filter
fields are allowed in the filter string and if provided more than that
then INVALID_ARGUMENT
error is returned by the API. Here are a few
examples: * create_time < \"2021-08-15T14:50:00Z\" AND create_time > \"2021-08-10T12:00:00Z\"
- The curation resource was created before
2021-08-15 14:50:00 UTC and after 2021-08-10 12:00:00 UTC.
pageSize
- Optional. The maximum number of curation resources to return.
The service may return fewer than this value. If unspecified, at most 50
curations will be returned. The maximum value is 1000; values above 1000
will be coerced to 1000.
pageToken
- Optional. A page token, received from a previous
ListCurations
call. Provide this to retrieve the subsequent page. When
paginating, all other parameters (except page_size) provided to
ListCurations
must match the call that provided the page token.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a GoogleCloudApihubV1ListCurationsResponse.
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<GoogleCloudApihubV1ListCurationsResponse> 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_ = 'v1/' + core.Uri.encodeFull('$parent') + '/curations';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return GoogleCloudApihubV1ListCurationsResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>,
);
}