Method: projects.locations.repositories.workspaces.readFile

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

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
workspace

string

Required. The workspace's name.

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

  • dataform.workspaces.readFile

Query parameters

Parameters
path

string

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

revision

string

Optional. The Git revision of the file to return. If left empty, the current contents of path will be returned.

Request body

The request body must be empty.

Response body

workspaces.readFile response message.

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

JSON representation
{
  "fileContents": string
}
Fields
fileContents

string (bytes format)

The file's contents.

A base64-encoded string.

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 workspace resource:

  • dataform.workspaces.readFile

For more information, see the IAM documentation.