- Resource: Repository
- GitRemoteSettings
- SshAuthenticationConfig
- TokenStatus
- WorkspaceCompilationOverrides
- Methods
Resource: Repository
Represents a Dataform Git repository.
JSON representation |
---|
{ "name": string, "createTime": string, "displayName": string, "gitRemoteSettings": { object ( |
Fields | |
---|---|
name |
Identifier. The repository's name. |
createTime |
Output only. The timestamp of when the repository was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
displayName |
Optional. The repository's user-friendly name. |
gitRemoteSettings |
Optional. If set, configures this repository to be linked to a Git remote. |
npmrcEnvironmentVariablesSecretVersion |
Optional. The name of the Secret Manager secret version to be used to interpolate variables into the .npmrc file for package installation operations. Must be in the format |
workspaceCompilationOverrides |
Optional. If set, fields of |
labels |
Optional. Repository user labels. An object containing a list of |
setAuthenticatedUserAdmin |
Optional. Input only. If set to true, the authenticated user will be granted the roles/dataform.admin role on the created repository. To modify access to the created repository later apply setIamPolicy from https://cloud.google.com/dataform/reference/rest#rest-resource:-v1beta1.projects.locations.repositories |
serviceAccount |
Optional. The service account to run workflow invocations under. |
kmsKeyName |
Optional. The reference to a KMS encryption key. If provided, it will be used to encrypt user data in the repository and all child resources. It is not possible to add or update the encryption key after the repository is created. Example: |
dataEncryptionState |
Output only. A data encryption state of a Git repository if this Repository is protected by a KMS key. |
GitRemoteSettings
Controls Git remote configuration for a repository.
JSON representation |
---|
{ "url": string, "defaultBranch": string, "authenticationTokenSecretVersion": string, "sshAuthenticationConfig": { object ( |
Fields | |
---|---|
url |
Required. The Git remote's URL. |
defaultBranch |
Required. The Git remote's default branch name. |
authenticationTokenSecretVersion |
Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format |
sshAuthenticationConfig |
Optional. Authentication fields for remote uris using SSH protocol. |
tokenStatus |
Output only. Deprecated: The field does not contain any token status information. Instead use https://cloud.google.com/dataform/reference/rest/v1beta1/projects.locations.repositories/computeAccessTokenStatus |
SshAuthenticationConfig
Configures fields for performing SSH authentication.
JSON representation |
---|
{ "userPrivateKeySecretVersion": string, "hostPublicKey": string } |
Fields | |
---|---|
userPrivateKeySecretVersion |
Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format |
hostPublicKey |
Required. Content of a public SSH key to verify an identity of a remote Git host. |
TokenStatus
Enums | |
---|---|
TOKEN_STATUS_UNSPECIFIED |
Default value. This value is unused. |
NOT_FOUND |
The token could not be found in Secret Manager (or the Dataform Service Account did not have permission to access it). |
INVALID |
The token could not be used to authenticate against the Git remote. |
VALID |
The token was used successfully to authenticate against the Git remote. |
WorkspaceCompilationOverrides
Configures workspace compilation overrides for a repository. Primarily used by the UI (console.cloud.google.com
). schemaSuffix
and tablePrefix
can have a special expression - ${workspaceName}
, which refers to the workspace name from which the compilation results will be created. API callers are expected to resolve the expression in these overrides and provide them explicitly in codeCompilationConfig
(https://cloud.google.com/dataform/reference/rest/v1beta1/projects.locations.repositories.compilationResults#codecompilationconfig) when creating workspace-scoped compilation results.
JSON representation |
---|
{ "defaultDatabase": string, "schemaSuffix": string, "tablePrefix": string } |
Fields | |
---|---|
defaultDatabase |
Optional. The default database (Google Cloud project ID). |
schemaSuffix |
Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names. |
tablePrefix |
Optional. The prefix that should be prepended to all table names. |
Methods |
|
---|---|
|
Applies a Git commit to a Repository. |
|
Computes a Repository's Git access token status. |
|
Creates a new Repository in a given project and location. |
|
Deletes a single Repository. |
|
Fetches a Repository's history of commits. |
|
Fetches a Repository's remote branches. |
|
Fetches a single Repository. |
|
Gets the access control policy for a resource. |
|
Lists Repositories in a given project and location. |
|
Updates a single Repository. |
|
Returns the contents of a given Repository directory. |
|
Returns the contents of a file (inside a Repository). |
|
Sets the access control policy on the specified resource. |
|
Returns permissions that a caller has on the specified resource. |