Method: projects.locations.teamFolders.search

Returns all TeamFolders in a given location that the caller has access to and match the provided filter.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
location

string

Required. Location in which to query TeamFolders. Format: projects/*/locations/*.

Query parameters

Parameters
pageSize

integer

Optional. Maximum number of TeamFolders 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 teamFolders.search call. Provide this to retrieve the subsequent page.

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

string

Optional. Field to additionally sort results by. 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

teamFolders.search response message.

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

JSON representation 
{
  "results": [
    {
      object (TeamFolderSearchResult)
    }
  ],
  "nextPageToken": string
}
Fields
results[]

object (TeamFolderSearchResult)

List of TeamFolders that match the search query.
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.

TeamFolderSearchResult

Represents a single content entry.

JSON representation 
{

  // Union field entry can be only one of the following:
  "teamFolder": {
    object (TeamFolder)
  }
  // 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:
teamFolder

object (TeamFolder)

A TeamFolder resource that is in the project / location.