Method: projects.locations.repositories.workspaces.fetchFileGitStatuses

Fetches Git statuses for the files in a Workspace.

HTTP request

GET https://dataform.googleapis.com/v1beta1/{name=projects/*/locations/*/repositories/*/workspaces/*}:fetchFileGitStatuses

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The workspace's name.

Authorization requires the following IAM permission on the specified resource name:

  • dataform.workspaces.fetchFileGitStatuses

Request body

The request body must be empty.

Response body

workspaces.fetchFileGitStatuses response message.

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

JSON representation 
{
  "uncommittedFileChanges": [
    {
      object (UncommittedFileChange)
    }
  ]
}
Fields
uncommittedFileChanges[]

object (UncommittedFileChange)

A list of all files which have uncommitted Git changes. There will only be a single entry for any given file.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • dataform.workspaces.fetchFileGitStatuses

For more information, see the IAM documentation.

UncommittedFileChange

Represents the Git state of a file with uncommitted changes.

JSON representation 
{
  "path": string,
  "state": enum (State)
}
Fields
path

string

The file's full path including filename, relative to the workspace root.
state

enum (State)

Indicates the status of the file.

State

Indicates the status of an uncommitted file change.

Enums
STATE_UNSPECIFIED Default value. This value is unused.
ADDED The file has been newly added.
DELETED The file has been deleted.
MODIFIED The file has been modified.
HAS_CONFLICTS The file contains merge conflicts.