queryDirectoryContents method

Future<QueryRepositoryDirectoryContentsResponse> queryDirectoryContents(String name, { String? commitSha, int? pageSize, String? pageToken, String? path, String? $fields, })

Returns the contents of a given Repository directory.

The Repository must not have a value for git_remote_settings.url.

Request parameters:

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

commitSha - Optional. The Commit SHA for the commit to query from. If unset, the directory will be queried from HEAD.

pageSize - Optional. Maximum number of paths 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 QueryRepositoryDirectoryContents call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to QueryRepositoryDirectoryContents, with the exception of page_size, must match the call that provided the page token.

path - Optional. The directory's full path including directory name, relative to root. If left unset, the root is used.

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

Completes with a QueryRepositoryDirectoryContentsResponse.

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<QueryRepositoryDirectoryContentsResponse> queryDirectoryContents(
  core.String name, {
  core.String? commitSha,
  core.int? pageSize,
  core.String? pageToken,
  core.String? path,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    'commitSha': ?commitSha == null ? null : [commitSha],
    'pageSize': ?pageSize == null ? null : ['${pageSize}'],
    'pageToken': ?pageToken == null ? null : [pageToken],
    'path': ?path == null ? null : [path],
    'fields': ?$fields == null ? null : [$fields],
  };

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

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