list method
List API versions of an API resource in the API hub.
Request parameters:
parent
- Required. The parent which owns this collection of API versions
i.e., the API resource Format:
projects/{project}/locations/{location}/apis/{api}
Value must have pattern
^projects/\[^/\]+/locations/\[^/\]+/apis/\[^/\]+$
.
filter
- Optional. An expression that filters the list of Versions. A
filter expression consists of a field name, a comparison operator, and a
value for filtering. The value must be a string, a number, or a boolean.
The comparison operator must be one of: <
, >
or =
. Filters are not
case sensitive. The following fields in the Version
are eligible for
filtering: * display_name
- The display name of the Version. Allowed
comparison operators: =
. * create_time
- The time at which the Version
was created. The value should be in the
(RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed
comparison operators: >
and <
. * lifecycle.enum_values.values.id
-
The allowed value id of the lifecycle attribute associated with the
Version. Allowed comparison operators: :
. *
lifecycle.enum_values.values.display_name
- The allowed value display
name of the lifecycle attribute associated with the Version. Allowed
comparison operators: :
. * compliance.enum_values.values.id
- The
allowed value id of the compliances attribute associated with the Version.
Allowed comparison operators: :
. *
compliance.enum_values.values.display_name
- The allowed value display
name of the compliances attribute associated with the Version. Allowed
comparison operators: :
. * accreditation.enum_values.values.id
- The
allowed value id of the accreditations attribute associated with the
Version. Allowed comparison operators: :
. *
accreditation.enum_values.values.display_name
- The allowed value
display name of the accreditations attribute associated with the Version.
Allowed comparison operators: :
. *
attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.id
- The allowed
value id of the user defined enum attribute associated with the Resource.
Allowed comparison operator is :
. Here user-defined-attribute-enum-id is
a placeholder that can be replaced with any user defined enum attribute
name. * attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.display_name
-
The allowed value display name of the user defined enum attribute
associated with the Resource. Allowed comparison operator is :
. Here
user-defined-attribute-enum-display-name is a placeholder that can be
replaced with any user defined enum attribute enum name. *
attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.string_values.values
- The allowed
value of the user defined string attribute associated with the Resource.
Allowed comparison operator is :
. Here user-defined-attribute-string is
a placeholder that can be replaced with any user defined string attribute
name. * attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.json_values.values
- The allowed
value of the user defined JSON attribute associated with the Resource.
Allowed comparison operator is :
. Here user-defined-attribute-json is a
placeholder that can be replaced with any user defined JSON attribute
name. 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: * lifecycle.enum_values.values.id: preview-id
- The filter string specifies that the id of the allowed value
associated with the lifecycle attribute of the Version is preview-id. *
lifecycle.enum_values.values.display_name: \"Preview Display Name\"
-
The filter string specifies that the display name of the allowed value
associated with the lifecycle attribute of the Version is Preview Display Name
. * lifecycle.enum_values.values.id: preview-id AND create_time < \"2021-08-15T14:50:00Z\" AND create_time > \"2021-08-10T12:00:00Z\"
- The
id of the allowed value associated with the lifecycle attribute of the
Version is preview-id and it was created before 2021-08-15 14:50:00
UTC and after 2021-08-10 12:00:00 UTC. *
compliance.enum_values.values.id: gdpr-id OR compliance.enum_values.values.id: pci-dss-id
- The id of the allowed
value associated with the compliance attribute is gdpr-id or
pci-dss-id. * lifecycle.enum_values.values.id: preview-id AND attributes.projects/test-project-id/locations/test-location-id/ attributes/17650f90-4a29-4971-b3c0-d5532da3764b.string_values.values: test
- The filter string specifies that the id of the allowed value
associated with the lifecycle attribute of the Version is preview-id and
the value of the user defined attribute of type string is test.
pageSize
- Optional. The maximum number of versions to return. The
service may return fewer than this value. If unspecified, at most 50
versions 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
ListVersions
call. Provide this to retrieve the subsequent page. When
paginating, all other parameters (except page_size) provided to
ListVersions
must match the call that provided the page token.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a GoogleCloudApihubV1ListVersionsResponse.
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<GoogleCloudApihubV1ListVersionsResponse> 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') + '/versions';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return GoogleCloudApihubV1ListVersionsResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>,
);
}