Console
    Start free

    Method: projects.locations.queryUserRootContents

    Returns the contents of a caller's root folder in a given location. The root folder contains all resources that are created by the user and not contained in any other folder.

    HTTP request

    GET https://dataform.googleapis.com/v1beta1/{location=projects/*/locations/*}:queryUserRootContents

    The URL uses gRPC Transcoding syntax.

    Path parameters

    Parameters
    location

    string

    Required. Location of the user root folder whose contents to list. Format: projects/*/locations/*

    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 locations.queryUserRootContents call. Provide this to retrieve the subsequent page.

    When paginating, all other parameters provided to QueryUserRootFolderContents , 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), created_at, last_modified_at. 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

    locations.queryUserRootContents response message.

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

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

    object ( RootContentsEntry )

    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 location resource:

    • iam.permissions.none

    For more information, see the IAM documentation .

    RootContentsEntry

    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.
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: