list method

Future<ListTransferConfigsResponse> list(
  1. String parent, {
  2. List<String>? dataSourceIds,
  3. int? pageSize,
  4. String? pageToken,
  5. String? $fields,
})

Returns information about all transfer configs owned by a project in the specified location.

Request parameters:

parent - Required. The BigQuery project id for which transfer configs should be returned: projects/{project_id} or projects/{project_id}/locations/{location_id} Value must have pattern ^projects/\[^/\]+$.

dataSourceIds - When specified, only configurations of requested data sources 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 ListTransfersRequest list results. For multiple-page results, ListTransfersResponse 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 ListTransferConfigsResponse.

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<ListTransferConfigsResponse> list(
  core.String parent, {
  core.List<core.String>? dataSourceIds,
  core.int? pageSize,
  core.String? pageToken,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (dataSourceIds != null) 'dataSourceIds': dataSourceIds,
    if (pageSize != null) 'pageSize': ['${pageSize}'],
    if (pageToken != null) 'pageToken': [pageToken],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v1/' + core.Uri.encodeFull('$parent') + '/transferConfigs';

  final response_ = await _requester.request(
    url_,
    'GET',
    queryParams: queryParams_,
  );
  return ListTransferConfigsResponse.fromJson(
      response_ as core.Map<core.String, core.dynamic>);
}