searchFiles method

Future<SearchFilesResponse> searchFiles(
  1. String workspace, {
  2. String? filter,
  3. int? pageSize,
  4. String? pageToken,
  5. String? $fields,
})

Finds the contents of a given Workspace directory by filter.

Request parameters:

workspace - Required. The workspace's name. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/repositories/\[^/\]+/workspaces/\[^/\]+$.

filter - Optional. Optional filter for the returned list in filtering format. Filtering is only currently supported on the path field. See https://google.aip.dev/160 for details.

pageSize - Optional. Maximum number of search results to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.

pageToken - Optional. Page token received from a previous SearchFilesRequest call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchFilesRequest, with the exception of page_size, must match the call that provided the page token.

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

Completes with a SearchFilesResponse.

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<SearchFilesResponse> searchFiles(
  core.String workspace, {
  core.String? filter,
  core.int? pageSize,
  core.String? pageToken,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    'filter': ?filter == null ? null : [filter],
    'pageSize': ?pageSize == null ? null : ['${pageSize}'],
    'pageToken': ?pageToken == null ? null : [pageToken],
    'fields': ?$fields == null ? null : [$fields],
  };

  final url_ = 'v1/' + core.Uri.encodeFull('$workspace') + ':searchFiles';

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