list method
Lists CustomTargetTypes in a given project and location.
Request parameters:
parent
- Required. The parent that owns this collection of custom target
types. Format must be projects/{project_id}/locations/{location_name}
.
Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+$
.
filter
- Optional. Filter custom target types to be returned. See
https://google.aip.dev/160 for more details.
orderBy
- Optional. Field to sort by. See
https://google.aip.dev/132#ordering for more details.
pageSize
- Optional. The maximum number of CustomTargetType
objects to
return. The service may return fewer than this value. If unspecified, at
most 50 CustomTargetType
objects will be returned. The maximum value is
1000; values above 1000 will be set to 1000.
pageToken
- Optional. A page token, received from a previous
ListCustomTargetTypes
call. Provide this to retrieve the subsequent
page. When paginating, all other provided parameters match the call that
provided the page token.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a ListCustomTargetTypesResponse.
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<ListCustomTargetTypesResponse> 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') + '/customTargetTypes';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return ListCustomTargetTypesResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>);
}