list method
Lists sentence pairs in the dataset.
Request parameters:
parent
- Required. Name of the parent dataset. In form of
projects/{project-number-or-id}/locations/{location-id}/datasets/{dataset-id}
Value must have pattern
^projects/\[^/\]+/locations/\[^/\]+/datasets/\[^/\]+$
.
filter
- Optional. An expression for filtering the examples that will be
returned. Example filter: * usage=TRAIN
pageSize
- Optional. Requested page size. The server can return fewer
results than requested.
pageToken
- Optional. A token identifying a page of results for the
server to return. Typically obtained from next_page_token field in the
response of a ListExamples call.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a ListExamplesResponse.
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<ListExamplesResponse> 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_ = 'v3/' + core.Uri.encodeFull('$parent') + '/examples';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return ListExamplesResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>);
}