Method: projects.locations.folders.queryFolderContents

Returns the contents of a given Folder.

HTTP request

GET https://dataform.googleapis.com/v1beta1/{folder=projects/*/locations/*/folders/*}:queryFolderContents

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
folder

string

Required. Name of the folder whose contents to list. Format: projects/*/locations/*/folders/*

Query parameters

Parameters
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 folders.queryFolderContents call. Provide this to retrieve the subsequent page.

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

string

Optional. Field to additionally sort results by. Will order Folders before Repositories, and then by orderBy in ascending order. Supported keywords: displayName (default), createTime, last_modified_time. Examples: - orderBy="displayName" - orderBy="displayName desc"
filter

string

Optional. Optional filtering for the returned list. Filtering is currently only supported on the displayName field.

Example: - filter="displayName="MyFolder""

Request body

The request body must be empty.

Response body

folders.queryFolderContents response message.

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

JSON representation 
{
  "entries": [
    {
      object (FolderContentsEntry)
    }
  ],
  "nextPageToken": string
}
Fields
entries[]

object (FolderContentsEntry)

List of entries in the folder.
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 folder resource:

  • dataform.folders.queryContents

For more information, see the IAM documentation.

FolderContentsEntry

Represents a single content entry.

JSON representation 
{

  // Union field entry can be only one of the following:
  "folder": {
    object (Folder)
  },
  "repository": {
    object (Repository)
  }
  // End of list of possible types for union field entry.
}
Fields
Union field entry. The content entry. entry can be only one of the following:
folder

object (Folder)

A subfolder.
repository

object (Repository)

A repository.