REST Resource: projects.locations.folders

Resource: Folder

Represents a Dataform Folder. This is a resource that is used to organize Files and other Folders and provide hierarchical access controls.

JSON representation
{
  "name": string,
  "displayName": string,
  "containingFolder": string,
  "teamFolderName": string,
  "createTime": string,
  "updateTime": string,
  "internalMetadata": string,
  "creatorIamPrincipal": string
}
Fields
name

string

Identifier. The Folder's name.

displayName

string

Required. The Folder's user-friendly name.

containingFolder

string

Optional. The containing Folder resource name. This should take the format: projects/{project}/locations/{location}/folders/{folder}, projects/{project}/locations/{location}/teamFolders/{teamFolder}, or just projects/{project}/locations/{location} if this is a root Folder. This field can only be updated through folders.move.

teamFolderName

string

Output only. The resource name of the TeamFolder that this Folder is associated with. This should take the format: projects/{project}/locations/{location}/teamFolders/{teamFolder}. If this is not set, the Folder is not associated with a TeamFolder and is a UserFolder.

createTime

string (Timestamp format)

Output only. The timestamp of when the Folder was created.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

Output only. The timestamp of when the Folder was last updated.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

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.

creatorIamPrincipal

string

Output only. The IAM principal identifier of the creator of the Folder.

Methods

create

Creates a new Folder in a given project and location.

delete

Deletes a single Folder.

get

Fetches a single Folder.

getIamPolicy

Gets the access control policy for a resource.

move

Moves a Folder to a new Folder, TeamFolder, or the root location.

patch

Updates a single Folder.

queryFolderContents

Returns the contents of a given Folder.

setIamPolicy

Sets the access control policy on the specified resource.

testIamPermissions

Returns permissions that a caller has on the specified resource.