list method
Returns log messages for the transfer run.
Request parameters:
parent
- Required. Transfer run name in the form:
projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}
or
projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}
Value must have pattern
^projects/\[^/\]+/transferConfigs/\[^/\]+/runs/\[^/\]+$
.
messageTypes
- Message types to return. If not populated - INFO, WARNING
and ERROR messages are returned.
pageSize
- Page size. The default page size is the maximum value of 1000
results.
pageToken
- Pagination token, which can be used to request a specific
page of ListTransferLogsRequest
list results. For multiple-page results,
ListTransferLogsResponse
outputs a next_page
token, which can be used
as the page_token
value to request the next page of list results.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a ListTransferLogsResponse.
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<ListTransferLogsResponse> list(
core.String parent, {
core.List<core.String>? messageTypes,
core.int? pageSize,
core.String? pageToken,
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if (messageTypes != null) 'messageTypes': messageTypes,
if (pageSize != null) 'pageSize': ['${pageSize}'],
if (pageToken != null) 'pageToken': [pageToken],
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v1/' + core.Uri.encodeFull('$parent') + '/transferLogs';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return ListTransferLogsResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>);
}