Dataform API . projects . locations . repositories

close()

Close httplib2 connections.

commit(name, body=None, x__xgafv=None)

Applies a Git commit to a Repository. The Repository must not have a value for `git_remote_settings.url`.

Args:
  name: string, Required. The repository's name. (required)
  body: object, The request body.
    The object takes the form of:

{ # `CommitRepositoryChanges` request message.
  "commitMetadata": { # Represents a Dataform Git commit. # Required. The changes to commit to the repository.
    "author": { # Represents the author of a Git commit. # Required. The commit's author.
      "emailAddress": "A String", # Required. The commit author's email address.
      "name": "A String", # Required. The commit author's name.
    },
    "commitMessage": "A String", # Optional. The commit's message.
  },
  "fileOperations": { # Optional. A map to the path of the file to the operation. The path is the full file path including filename, from repository root.
    "a_key": { # Represents a single file operation to the repository.
      "deleteFile": { # Represents the delete file operation. # Represents the delete operation.
      },
      "writeFile": { # Represents the write file operation (for files added or modified). # Represents the write operation.
        "contents": "A String", # The file's contents.
      },
    },
  },
  "requiredHeadCommitSha": "A String", # Optional. The commit SHA which must be the repository's current HEAD before applying this commit; otherwise this request will fail. If unset, no validation on the current HEAD commit SHA is performed.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # `CommitRepositoryChanges` response message.
  "commitSha": "A String", # The commit SHA of the current commit.
}

computeAccessTokenStatus(name, x__xgafv=None)

Computes a Repository's Git access token status.

Args:
  name: string, Required. The repository's name. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # `ComputeRepositoryAccessTokenStatus` response message.
  "tokenStatus": "A String", # Indicates the status of the Git access token.
}

create(parent, body=None, repositoryId=None, x__xgafv=None)

Creates a new Repository in a given project and location.

Args:
  parent: string, Required. The location in which to create the repository. Must be in the format `projects/*/locations/*`. (required)
  body: object, The request body.
    The object takes the form of:

{ # Represents a Dataform Git repository.
  "createTime": "A String", # Output only. The timestamp of when the repository was created.
  "dataEncryptionState": { # Describes encryption state of a resource. # Output only. A data encryption state of a Git repository if this Repository is protected by a KMS key.
    "kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted.
  },
  "displayName": "A String", # Optional. The repository's user-friendly name.
  "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote.
    "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
    "defaultBranch": "A String", # Required. The Git remote's default branch name.
    "sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol.
      "hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host.
      "userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
    },
    "tokenStatus": "A String", # 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
    "url": "A String", # Required. The Git remote's URL.
  },
  "internalMetadata": "A 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.
  "kmsKeyName": "A String", # 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: `projects/{kms_project}/locations/{location}/keyRings/{key_location}/cryptoKeys/{key}`
  "labels": { # Optional. Repository user labels.
    "a_key": "A String",
  },
  "name": "A String", # Identifier. The repository's name.
  "npmrcEnvironmentVariablesSecretVersion": "A String", # 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 `projects/*/secrets/*/versions/*`. The file itself must be in a JSON format.
  "serviceAccount": "A String", # Optional. The service account to run workflow invocations under.
  "setAuthenticatedUserAdmin": True or False, # 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
  "workspaceCompilationOverrides": { # Configures workspace compilation overrides for a repository. Primarily used by the UI (`console.cloud.google.com`). `schema_suffix` and `table_prefix` 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 `code_compilation_config` (https://cloud.google.com/dataform/reference/rest/v1beta1/projects.locations.repositories.compilationResults#codecompilationconfig) when creating workspace-scoped compilation results. # Optional. If set, fields of `workspace_compilation_overrides` override the default compilation settings that are specified in dataform.json when creating workspace-scoped compilation results. See documentation for `WorkspaceCompilationOverrides` for more information.
    "defaultDatabase": "A String", # Optional. The default database (Google Cloud project ID).
    "schemaSuffix": "A String", # Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names.
    "tablePrefix": "A String", # Optional. The prefix that should be prepended to all table names.
  },
}

  repositoryId: string, Required. The ID to use for the repository, which will become the final component of the repository's resource name.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a Dataform Git repository.
  "createTime": "A String", # Output only. The timestamp of when the repository was created.
  "dataEncryptionState": { # Describes encryption state of a resource. # Output only. A data encryption state of a Git repository if this Repository is protected by a KMS key.
    "kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted.
  },
  "displayName": "A String", # Optional. The repository's user-friendly name.
  "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote.
    "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
    "defaultBranch": "A String", # Required. The Git remote's default branch name.
    "sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol.
      "hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host.
      "userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
    },
    "tokenStatus": "A String", # 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
    "url": "A String", # Required. The Git remote's URL.
  },
  "internalMetadata": "A 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.
  "kmsKeyName": "A String", # 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: `projects/{kms_project}/locations/{location}/keyRings/{key_location}/cryptoKeys/{key}`
  "labels": { # Optional. Repository user labels.
    "a_key": "A String",
  },
  "name": "A String", # Identifier. The repository's name.
  "npmrcEnvironmentVariablesSecretVersion": "A String", # 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 `projects/*/secrets/*/versions/*`. The file itself must be in a JSON format.
  "serviceAccount": "A String", # Optional. The service account to run workflow invocations under.
  "setAuthenticatedUserAdmin": True or False, # 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
  "workspaceCompilationOverrides": { # Configures workspace compilation overrides for a repository. Primarily used by the UI (`console.cloud.google.com`). `schema_suffix` and `table_prefix` 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 `code_compilation_config` (https://cloud.google.com/dataform/reference/rest/v1beta1/projects.locations.repositories.compilationResults#codecompilationconfig) when creating workspace-scoped compilation results. # Optional. If set, fields of `workspace_compilation_overrides` override the default compilation settings that are specified in dataform.json when creating workspace-scoped compilation results. See documentation for `WorkspaceCompilationOverrides` for more information.
    "defaultDatabase": "A String", # Optional. The default database (Google Cloud project ID).
    "schemaSuffix": "A String", # Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names.
    "tablePrefix": "A String", # Optional. The prefix that should be prepended to all table names.
  },
}

delete(name, force=None, x__xgafv=None)

Deletes a single Repository.

Args:
  name: string, Required. The repository's name. (required)
  force: boolean, Optional. If set to true, child resources of this repository (compilation results and workflow invocations) will also be deleted. Otherwise, the request will only succeed if the repository has no child resources. **Note:** *This flag doesn't support deletion of workspaces, release configs or workflow configs. If any of such resources exists in the repository, the request will fail.*.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}

fetchHistory(name, pageSize=None, pageToken=None, x__xgafv=None)

Fetches a Repository's history of commits. The Repository must not have a value for `git_remote_settings.url`.

Args:
  name: string, Required. The repository's name. (required)
  pageSize: integer, Optional. Maximum number of commits to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
  pageToken: string, Optional. Page token received from a previous `FetchRepositoryHistory` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchRepositoryHistory`, with the exception of `page_size`, must match the call that provided the page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # `FetchRepositoryHistory` response message.
  "commits": [ # A list of commit logs, ordered by 'git log' default order.
    { # Represents a single commit log.
      "author": { # Represents the author of a Git commit. # The commit author for this commit log entry.
        "emailAddress": "A String", # Required. The commit author's email address.
        "name": "A String", # Required. The commit author's name.
      },
      "commitMessage": "A String", # The commit message for this commit log entry.
      "commitSha": "A String", # The commit SHA for this commit log entry.
      "commitTime": "A String", # Commit timestamp.
    },
  ],
  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
}

fetchHistory_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.
        

fetchRemoteBranches(name, x__xgafv=None)

Fetches a Repository's remote branches.

Args:
  name: string, Required. The repository's name. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # `FetchRemoteBranches` response message.
  "branches": [ # The remote repository's branch names.
    "A String",
  ],
}

get(name, x__xgafv=None)

Fetches a single Repository.

Args:
  name: string, Required. The repository's name. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a Dataform Git repository.
  "createTime": "A String", # Output only. The timestamp of when the repository was created.
  "dataEncryptionState": { # Describes encryption state of a resource. # Output only. A data encryption state of a Git repository if this Repository is protected by a KMS key.
    "kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted.
  },
  "displayName": "A String", # Optional. The repository's user-friendly name.
  "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote.
    "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
    "defaultBranch": "A String", # Required. The Git remote's default branch name.
    "sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol.
      "hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host.
      "userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
    },
    "tokenStatus": "A String", # 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
    "url": "A String", # Required. The Git remote's URL.
  },
  "internalMetadata": "A 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.
  "kmsKeyName": "A String", # 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: `projects/{kms_project}/locations/{location}/keyRings/{key_location}/cryptoKeys/{key}`
  "labels": { # Optional. Repository user labels.
    "a_key": "A String",
  },
  "name": "A String", # Identifier. The repository's name.
  "npmrcEnvironmentVariablesSecretVersion": "A String", # 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 `projects/*/secrets/*/versions/*`. The file itself must be in a JSON format.
  "serviceAccount": "A String", # Optional. The service account to run workflow invocations under.
  "setAuthenticatedUserAdmin": True or False, # 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
  "workspaceCompilationOverrides": { # Configures workspace compilation overrides for a repository. Primarily used by the UI (`console.cloud.google.com`). `schema_suffix` and `table_prefix` 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 `code_compilation_config` (https://cloud.google.com/dataform/reference/rest/v1beta1/projects.locations.repositories.compilationResults#codecompilationconfig) when creating workspace-scoped compilation results. # Optional. If set, fields of `workspace_compilation_overrides` override the default compilation settings that are specified in dataform.json when creating workspace-scoped compilation results. See documentation for `WorkspaceCompilationOverrides` for more information.
    "defaultDatabase": "A String", # Optional. The default database (Google Cloud project ID).
    "schemaSuffix": "A String", # Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names.
    "tablePrefix": "A String", # Optional. The prefix that should be prepended to all table names.
  },
}

list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists Repositories in a given project and location. **Note:** *This method can return repositories not shown in the [Dataform UI](https://console.cloud.google.com/bigquery/dataform)*.

Args:
  parent: string, Required. The location in which to list repositories. Must be in the format `projects/*/locations/*`. (required)
  filter: string, Optional. Filter for the returned list.
  orderBy: string, Optional. This field only supports ordering by `name`. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the `name` field.
  pageSize: integer, Optional. Maximum number of repositories to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
  pageToken: string, Optional. Page token received from a previous `ListRepositories` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRepositories`, with the exception of `page_size`, must match the call that provided the page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # `ListRepositories` response message.
  "nextPageToken": "A String", # A token which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
  "repositories": [ # List of repositories.
    { # Represents a Dataform Git repository.
      "createTime": "A String", # Output only. The timestamp of when the repository was created.
      "dataEncryptionState": { # Describes encryption state of a resource. # Output only. A data encryption state of a Git repository if this Repository is protected by a KMS key.
        "kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted.
      },
      "displayName": "A String", # Optional. The repository's user-friendly name.
      "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote.
        "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
        "defaultBranch": "A String", # Required. The Git remote's default branch name.
        "sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol.
          "hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host.
          "userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
        },
        "tokenStatus": "A String", # 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
        "url": "A String", # Required. The Git remote's URL.
      },
      "internalMetadata": "A 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.
      "kmsKeyName": "A String", # 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: `projects/{kms_project}/locations/{location}/keyRings/{key_location}/cryptoKeys/{key}`
      "labels": { # Optional. Repository user labels.
        "a_key": "A String",
      },
      "name": "A String", # Identifier. The repository's name.
      "npmrcEnvironmentVariablesSecretVersion": "A String", # 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 `projects/*/secrets/*/versions/*`. The file itself must be in a JSON format.
      "serviceAccount": "A String", # Optional. The service account to run workflow invocations under.
      "setAuthenticatedUserAdmin": True or False, # 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
      "workspaceCompilationOverrides": { # Configures workspace compilation overrides for a repository. Primarily used by the UI (`console.cloud.google.com`). `schema_suffix` and `table_prefix` 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 `code_compilation_config` (https://cloud.google.com/dataform/reference/rest/v1beta1/projects.locations.repositories.compilationResults#codecompilationconfig) when creating workspace-scoped compilation results. # Optional. If set, fields of `workspace_compilation_overrides` override the default compilation settings that are specified in dataform.json when creating workspace-scoped compilation results. See documentation for `WorkspaceCompilationOverrides` for more information.
        "defaultDatabase": "A String", # Optional. The default database (Google Cloud project ID).
        "schemaSuffix": "A String", # Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names.
        "tablePrefix": "A String", # Optional. The prefix that should be prepended to all table names.
      },
    },
  ],
  "unreachable": [ # Locations which could not be reached.
    "A String",
  ],
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.
        

patch(name, body=None, updateMask=None, x__xgafv=None)

Updates a single Repository. **Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.*

Args:
  name: string, Identifier. The repository's name. (required)
  body: object, The request body.
    The object takes the form of:

{ # Represents a Dataform Git repository.
  "createTime": "A String", # Output only. The timestamp of when the repository was created.
  "dataEncryptionState": { # Describes encryption state of a resource. # Output only. A data encryption state of a Git repository if this Repository is protected by a KMS key.
    "kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted.
  },
  "displayName": "A String", # Optional. The repository's user-friendly name.
  "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote.
    "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
    "defaultBranch": "A String", # Required. The Git remote's default branch name.
    "sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol.
      "hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host.
      "userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
    },
    "tokenStatus": "A String", # 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
    "url": "A String", # Required. The Git remote's URL.
  },
  "internalMetadata": "A 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.
  "kmsKeyName": "A String", # 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: `projects/{kms_project}/locations/{location}/keyRings/{key_location}/cryptoKeys/{key}`
  "labels": { # Optional. Repository user labels.
    "a_key": "A String",
  },
  "name": "A String", # Identifier. The repository's name.
  "npmrcEnvironmentVariablesSecretVersion": "A String", # 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 `projects/*/secrets/*/versions/*`. The file itself must be in a JSON format.
  "serviceAccount": "A String", # Optional. The service account to run workflow invocations under.
  "setAuthenticatedUserAdmin": True or False, # 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
  "workspaceCompilationOverrides": { # Configures workspace compilation overrides for a repository. Primarily used by the UI (`console.cloud.google.com`). `schema_suffix` and `table_prefix` 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 `code_compilation_config` (https://cloud.google.com/dataform/reference/rest/v1beta1/projects.locations.repositories.compilationResults#codecompilationconfig) when creating workspace-scoped compilation results. # Optional. If set, fields of `workspace_compilation_overrides` override the default compilation settings that are specified in dataform.json when creating workspace-scoped compilation results. See documentation for `WorkspaceCompilationOverrides` for more information.
    "defaultDatabase": "A String", # Optional. The default database (Google Cloud project ID).
    "schemaSuffix": "A String", # Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names.
    "tablePrefix": "A String", # Optional. The prefix that should be prepended to all table names.
  },
}

  updateMask: string, Optional. Specifies the fields to be updated in the repository. If left unset, all fields will be updated.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a Dataform Git repository.
  "createTime": "A String", # Output only. The timestamp of when the repository was created.
  "dataEncryptionState": { # Describes encryption state of a resource. # Output only. A data encryption state of a Git repository if this Repository is protected by a KMS key.
    "kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted.
  },
  "displayName": "A String", # Optional. The repository's user-friendly name.
  "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote.
    "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
    "defaultBranch": "A String", # Required. The Git remote's default branch name.
    "sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol.
      "hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host.
      "userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
    },
    "tokenStatus": "A String", # 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
    "url": "A String", # Required. The Git remote's URL.
  },
  "internalMetadata": "A 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.
  "kmsKeyName": "A String", # 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: `projects/{kms_project}/locations/{location}/keyRings/{key_location}/cryptoKeys/{key}`
  "labels": { # Optional. Repository user labels.
    "a_key": "A String",
  },
  "name": "A String", # Identifier. The repository's name.
  "npmrcEnvironmentVariablesSecretVersion": "A String", # 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 `projects/*/secrets/*/versions/*`. The file itself must be in a JSON format.
  "serviceAccount": "A String", # Optional. The service account to run workflow invocations under.
  "setAuthenticatedUserAdmin": True or False, # 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
  "workspaceCompilationOverrides": { # Configures workspace compilation overrides for a repository. Primarily used by the UI (`console.cloud.google.com`). `schema_suffix` and `table_prefix` 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 `code_compilation_config` (https://cloud.google.com/dataform/reference/rest/v1beta1/projects.locations.repositories.compilationResults#codecompilationconfig) when creating workspace-scoped compilation results. # Optional. If set, fields of `workspace_compilation_overrides` override the default compilation settings that are specified in dataform.json when creating workspace-scoped compilation results. See documentation for `WorkspaceCompilationOverrides` for more information.
    "defaultDatabase": "A String", # Optional. The default database (Google Cloud project ID).
    "schemaSuffix": "A String", # Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names.
    "tablePrefix": "A String", # Optional. The prefix that should be prepended to all table names.
  },
}

queryDirectoryContents(name, commitSha=None, pageSize=None, pageToken=None, path=None, x__xgafv=None)

Returns the contents of a given Repository directory. The Repository must not have a value for `git_remote_settings.url`.

Args:
  name: string, Required. The repository's name. (required)
  commitSha: string, Optional. The Commit SHA for the commit to query from. If unset, the directory will be queried from HEAD.
  pageSize: integer, Optional. Maximum number of paths to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
  pageToken: string, Optional. Page token received from a previous `QueryRepositoryDirectoryContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryRepositoryDirectoryContents`, with the exception of `page_size`, must match the call that provided the page token.
  path: string, Optional. The directory's full path including directory name, relative to root. If left unset, the root is used.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # `QueryRepositoryDirectoryContents` response message.
  "directoryEntries": [ # List of entries in the directory.
    { # Represents a single entry in a directory.
      "directory": "A String", # A child directory in the directory.
      "file": "A String", # A file in the directory.
    },
  ],
  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
}

queryDirectoryContents_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.
        

readFile(name, commitSha=None, path=None, x__xgafv=None)

Returns the contents of a file (inside a Repository). The Repository must not have a value for `git_remote_settings.url`.

Args:
  name: string, Required. The repository's name. (required)
  commitSha: string, Optional. The commit SHA for the commit to read from. If unset, the file will be read from HEAD.
  path: string, Required. Full file path to read including filename, from repository root.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # `ReadRepositoryFile` response message.
  "contents": "A String", # The file's contents.
}