list method
Lists Entries within an EntryGroup.
Request parameters:
parent
- Required. The resource name of the parent Entry Group:
projects/{project}/locations/{location}/entryGroups/{entry_group}.
Value must have pattern
^projects/\[^/\]+/locations/\[^/\]+/entryGroups/\[^/\]+$
.
filter
- Optional. A filter on the entries to return. Filters are
case-sensitive. You can filter the request by the following fields:
entry_type entry_source.display_nameThe comparison operators are =, !=,
<, >, <=, >=. The service compares strings according to lexical
order.You can use the logical operators AND, OR, NOT in the filter.You can
use Wildcard "", but for entry_type you need to provide the full project
id or number.Example filter expressions:
"entry_source.display_name=AnExampleDisplayName"
"entry_type=projects/example-project/locations/global/entryTypes/example-entry_type"
"entry_type=projects/example-project/locations/us/entryTypes/a OR
entry_type=projects/another-project/locations / * " "NOT
entry_source.display_name=AnotherExampleDisplayName"
pageSize
- Optional. Number of items to return per page. If there are
remaining results, the service returns a next_page_token. If unspecified,
the service returns at most 10 Entries. The maximum value is 100; values
above 100 will be coerced to 100.
pageToken
- Optional. Page token received from a previous ListEntries
call. Provide this to retrieve the subsequent page.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a GoogleCloudDataplexV1ListEntriesResponse.
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<GoogleCloudDataplexV1ListEntriesResponse> 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') + '/entries';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return GoogleCloudDataplexV1ListEntriesResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>);
}