REST Resource: projects.locations.repositories.workspaces

Resource: Workspace

Represents a Dataform Git workspace.

JSON representation 
{
  "name": string,
  "createTime": string,
  "dataEncryptionState": {
    object (DataEncryptionState)
  },
  "privateResourceMetadata": {
    object (PrivateResourceMetadata)
  },
  "depth": integer,
  "internalMetadata": string,
  "disableMoves": boolean,
  "originalBranch": string,
  "enableBranchManagement": boolean,
  "shallow": boolean
}
Fields
name

string

Identifier. The workspace's name.
createTime

string (Timestamp format)

Output only. The timestamp of when the workspace 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".
dataEncryptionState

object (DataEncryptionState)

Output only. A data encryption state of a Git repository if this Workspace is protected by a KMS key.
privateResourceMetadata

object (PrivateResourceMetadata)

Output only. Metadata indicating whether this resource is user-scoped. For Workspace resources, the userScoped field is always true.
depth

integer

Optional. Input only. Immutable. The maximum depth of the Git repository to checkout for this workspace. If defined and greater than 0, the Git repository is created as a shallow clone with the given depth. Otherwise, a full clone is performed. This field is available only for GitHub, Gitlab and 1p repositories with enabled branch management.
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.
disableMoves

boolean

Optional. If set to true, workspaces will not be moved if its linked Repository is moved. Instead, it will be deleted.
originalBranch

string

Optional. Input only. Immutable. The name of the default upstream branch for all pull/push operations in the remote repository for this workspace. If empty, the HEAD branch from the repository is used.
enableBranchManagement

boolean

Immutable. Controls the enablement of branch checkout for the workspace.

When set to true, the workspace is allowed to checkout branches.
shallow

boolean

Output only. If set to true, the workspace is created as a shallow clone. It is automatically set to true if the depth field is set to a value greater than 0. Otherwise, it is set to false.

Methods

checkout

 Checkout a branch in a workspace.

commit

 Applies a Git commit for uncommitted files in a Workspace.

create

 Creates a new Workspace in a given Repository.

delete

 Deletes a single Workspace.

deleteBranch

 Deletes a branch in a workspace.

fetchBranches

 Fetches branches in a workspace.

fetchCurrentBranch

 Fetches the current branch of a workspace.

fetchFileDiff

 Fetches Git diff for an uncommitted file in a Workspace.

fetchFileGitStatuses

 Fetches Git statuses for the files in a Workspace.

fetchGitAheadBehind

 Fetches Git ahead/behind against a remote branch.

get

 Fetches a single Workspace.

getIamPolicy

 Gets the access control policy for a resource.

installNpmPackages

 Installs dependency NPM packages (inside a Workspace).

list

 Lists Workspaces in a given Repository.

makeDirectory

 Creates a directory inside a Workspace.

moveDirectory

 Moves a directory (inside a Workspace), and all of its contents, to a new location.

moveFile

 Moves a file (inside a Workspace) to a new location.

pull

 Pulls Git commits from the Repository's remote into a Workspace.

push

 Pushes Git commits from a Workspace to the Repository's remote.

queryDirectoryContents

 Returns the contents of a given Workspace directory.

readFile

 Returns the contents of a file (inside a Workspace).

removeDirectory

 Deletes a directory (inside a Workspace) and all of its contents.

removeFile

 Deletes a file (inside a Workspace).

reset

 Performs a Git reset for uncommitted files in a Workspace.

searchFiles

 Finds the contents of a given Workspace directory by filter.

setIamPolicy

 Sets the access control policy on the specified resource.

syncWorkspaceRefs

 Syncs the refs of a workspace.

testIamPermissions

 Returns permissions that a caller has on the specified resource.

writeFile

 Writes to a file (inside a Workspace).