Method: projects.locations.repositories.queryDirectoryContents

Returns the contents of a given Repository directory. The Repository must not have a value for gitRemoteSettings.url.

HTTP request

GET https://dataform.googleapis.com/v1/{name=projects/*/locations/*/repositories/*}:queryDirectoryContents

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The repository's name.

Authorization requires the following IAM permission on the specified resource name:

  • dataform.repositories.queryDirectoryContents

Query parameters

Parameters
commitSha

string

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

string

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

integer

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

string

Optional. Page token received from a previous repositories.queryDirectoryContents call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to repositories.queryDirectoryContents, with the exception of pageSize, must match the call that provided the page token.

Request body

The request body must be empty.

Response body

repositories.queryDirectoryContents response message.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "directoryEntries": [
    {
      object (DirectoryEntry)
    }
  ],
  "nextPageToken": string
}
Fields
directoryEntries[]

object (DirectoryEntry)

List of entries in the directory.
nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/bigquery

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • dataform.repositories.queryDirectoryContents

For more information, see the IAM documentation.