list method
Lists host project registrations.
Request parameters:
parent
- Required. The parent, which owns this collection of host
projects. Format: projects / * /locations / *
Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+$
.
filter
- Optional. An expression that filters the list of
HostProjectRegistrations. A filter expression consists of a field name, a
comparison operator, and a value for filtering. The value must be a
string. All standard operators as documented at https://google.aip.dev/160
are supported. The following fields in the HostProjectRegistration
are
eligible for filtering: * name
- The name of the
HostProjectRegistration. * create_time
- The time at which the
HostProjectRegistration was created. The value should be in the
(RFC3339)[https://tools.ietf.org/html/rfc3339] format. * gcp_project
-
The Google cloud project associated with the HostProjectRegistration.
orderBy
- Optional. Hint for how to order the results.
pageSize
- Optional. The maximum number of host project registrations to
return. The service may return fewer than this value. If unspecified, at
most 50 host project registrations 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
ListHostProjectRegistrations
call. Provide this to retrieve the
subsequent page. When paginating, all other parameters (except page_size)
provided to ListHostProjectRegistrations
must match the call that
provided the page token.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a GoogleCloudApihubV1ListHostProjectRegistrationsResponse.
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<GoogleCloudApihubV1ListHostProjectRegistrationsResponse> 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') + '/hostProjectRegistrations';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return GoogleCloudApihubV1ListHostProjectRegistrationsResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>,
);
}