team_folders

Creates, updates, deletes, gets or lists a team_folders resource.

Overview

Name	team_folders
Type	Resource
Id	google.dataform.team_folders

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Identifier. The TeamFolder's name.
createTime	string (google-datetime)	Output only. The timestamp of when the TeamFolder was created.
creatorIamPrincipal	string	Output only. The IAM principal identifier of the creator of the TeamFolder.
displayName	string	Required. The TeamFolder's user-friendly name.
internalMetadata	string	Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.
updateTime	string (google-datetime)	Output only. The timestamp of when the TeamFolder was last updated.

query_contents

Name	Datatype	Description
entries	array	List of entries in the TeamFolder.
nextPageToken	string	A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, teamFoldersId		Fetches a single TeamFolder.
query_contents	select	projectsId, locationsId, teamFoldersId	pageSize, pageToken, filter, orderBy	Returns the contents of a given TeamFolder.
create	insert	projectsId, locationsId		Creates a new TeamFolder in a given project and location.
patch	update	projectsId, locationsId, teamFoldersId	updateMask	Updates a single TeamFolder.
delete	delete	projectsId, locationsId, teamFoldersId		Deletes a single TeamFolder.
search	exec	projectsId, locationsId	filter, orderBy, pageSize, pageToken	Returns all TeamFolders in a given location that the caller has access to and match the provided filter.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
locationsId	string
projectsId	string
teamFoldersId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

get

Fetches a single TeamFolder.

SELECT
name,
createTime,
creatorIamPrincipal,
displayName,
internalMetadata,
updateTime
FROM google.dataform.team_folders
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND teamFoldersId = '{{ teamFoldersId }}' -- required
;

query_contents

Returns the contents of a given TeamFolder.

SELECT
entries,
nextPageToken
FROM google.dataform.team_folders
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND teamFoldersId = '{{ teamFoldersId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
;

INSERT examples

create

Creates a new TeamFolder in a given project and location.

INSERT INTO google.dataform.team_folders (
data__name,
data__displayName,
projectsId,
locationsId
)
SELECT 
'{{ name }}',
'{{ displayName }}',
'{{ projectsId }}',
'{{ locationsId }}'
RETURNING
name,
createTime,
creatorIamPrincipal,
displayName,
internalMetadata,
updateTime
;

Manifest

# Description fields are for documentation purposes
- name: team_folders
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the team_folders resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the team_folders resource.
  - name: name
    value: "{{ name }}"
    description: |
      Identifier. The TeamFolder's name.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      Required. The TeamFolder's user-friendly name.

UPDATE examples

patch

Updates a single TeamFolder.

UPDATE google.dataform.team_folders
SET 
data__name = '{{ name }}',
data__displayName = '{{ displayName }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND teamFoldersId = '{{ teamFoldersId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
createTime,
creatorIamPrincipal,
displayName,
internalMetadata,
updateTime;

DELETE examples

delete

Deletes a single TeamFolder.

DELETE FROM google.dataform.team_folders
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND teamFoldersId = '{{ teamFoldersId }}' --required
;

Lifecycle Methods

search

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

EXEC google.dataform.team_folders.search 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@filter='{{ filter }}', 
@orderBy='{{ orderBy }}', 
@pageSize='{{ pageSize }}', 
@pageToken='{{ pageToken }}'
;