list method

Future<ListMulticloudDataTransferConfigsResponse> list(String parent, { String? filter, String? orderBy, int? pageSize, String? pageToken, bool? returnPartialSuccess, String? $fields, })

Lists the MulticloudDataTransferConfig resources in a specified project and location.

Request parameters:

parent - Required. The name of the parent resource. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+$.

filter - Optional. An expression that filters the results listed in the response.

orderBy - Optional. The sort order of the results.

pageSize - Optional. The maximum number of results listed per page.

pageToken - Optional. The page token.

returnPartialSuccess - Optional. If true, allows partial responses for multi-regional aggregated list requests.

$fields - Selector specifying which fields to include in a partial response.

Completes with a ListMulticloudDataTransferConfigsResponse.

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<ListMulticloudDataTransferConfigsResponse> list(
  core.String parent, {
  core.String? filter,
  core.String? orderBy,
  core.int? pageSize,
  core.String? pageToken,
  core.bool? returnPartialSuccess,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    'filter': ?filter == null ? null : [filter],
    'orderBy': ?orderBy == null ? null : [orderBy],
    'pageSize': ?pageSize == null ? null : ['${pageSize}'],
    'pageToken': ?pageToken == null ? null : [pageToken],
    'returnPartialSuccess': ?returnPartialSuccess == null
        ? null
        : ['${returnPartialSuccess}'],
    'fields': ?$fields == null ? null : [$fields],
  };

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

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