Google Cloud Dataform V1 Client - Class Repository (0.9.2)

Reference documentation and code samples for the Google Cloud Dataform V1 Client class Repository.

Represents a Dataform Git repository.

Generated from protobuf messagegoogle.cloud.dataform.v1.Repository

Namespace

Google \ Cloud \ Dataform \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
dataarray

Optional. Data for populating the Message object.

↳ namestring

Identifier. The repository's name.

↳ create_timeGoogle\Protobuf\Timestamp

Output only. The timestamp of when the repository was created.

↳ display_namestring

Optional. The repository's user-friendly name.

↳ git_remote_settingsRepository\GitRemoteSettings

Optional. If set, configures this repository to be linked to a Git remote.

↳ npmrc_environment_variables_secret_versionstring

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 formatprojects/*/secrets/*/versions/*. The file itself must be in a JSON format.

↳ workspace_compilation_overridesRepository\WorkspaceCompilationOverrides

Optional. If set, fields ofworkspace_compilation_overrides override the default compilation settings that are specified in dataform.json when creating workspace-scoped compilation results. See documentation forWorkspaceCompilationOverrides for more information.

↳ labelsarray|Google\Protobuf\Internal\MapField

Optional. Repository user labels.

↳ set_authenticated_user_adminbool

Optional. Input only. If set to true, the authenticated user will be granted the roles/dataform.admin role on the created repository.

↳ service_accountstring

Optional. The service account to run workflow invocations under.

↳ kms_key_namestring

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}

↳ data_encryption_stateDataEncryptionState

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

↳ internal_metadatastring

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.

getName

Identifier. The repository's name.

Returns
TypeDescription
string

setName

Identifier. The repository's name.

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

getCreateTime

Output only. The timestamp of when the repository was created.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The timestamp of when the repository was created.

Parameter
NameDescription
varGoogle\Protobuf\Timestamp
Returns
TypeDescription
$this

getDisplayName

Optional. The repository's user-friendly name.

Returns
TypeDescription
string

setDisplayName

Optional. The repository's user-friendly name.

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

getGitRemoteSettings

Optional. If set, configures this repository to be linked to a Git remote.

Returns
TypeDescription
Repository\GitRemoteSettings|null

hasGitRemoteSettings

clearGitRemoteSettings

setGitRemoteSettings

Optional. If set, configures this repository to be linked to a Git remote.

Parameter
NameDescription
varRepository\GitRemoteSettings
Returns
TypeDescription
$this

getNpmrcEnvironmentVariablesSecretVersion

Optional. The name of the Secret Manager secret version to be used tointerpolate variables into the .npmrc file for package installationoperations. Must be in the formatprojects/*/secrets/*/versions/*. Thefile itself must be in a JSON format.

Returns
TypeDescription
string

setNpmrcEnvironmentVariablesSecretVersion

Optional. The name of the Secret Manager secret version to be used tointerpolate variables into the .npmrc file for package installationoperations. Must be in the formatprojects/*/secrets/*/versions/*. Thefile itself must be in a JSON format.

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

getWorkspaceCompilationOverrides

Optional. If set, fields ofworkspace_compilation_overrides override thedefault compilation settings that are specified in dataform.json whencreating workspace-scoped compilation results. See documentation forWorkspaceCompilationOverrides for more information.

Returns
TypeDescription
Repository\WorkspaceCompilationOverrides|null

hasWorkspaceCompilationOverrides

clearWorkspaceCompilationOverrides

setWorkspaceCompilationOverrides

Optional. If set, fields ofworkspace_compilation_overrides override thedefault compilation settings that are specified in dataform.json whencreating workspace-scoped compilation results. See documentation forWorkspaceCompilationOverrides for more information.

Parameter
NameDescription
varRepository\WorkspaceCompilationOverrides
Returns
TypeDescription
$this

getLabels

Optional. Repository user labels.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setLabels

Optional. Repository user labels.

Parameter
NameDescription
vararray|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getSetAuthenticatedUserAdmin

Optional. Input only. If set to true, the authenticated user will begranted the roles/dataform.admin role on the created repository.

Returns
TypeDescription
bool

setSetAuthenticatedUserAdmin

Optional. Input only. If set to true, the authenticated user will begranted the roles/dataform.admin role on the created repository.

Parameter
NameDescription
varbool
Returns
TypeDescription
$this

getServiceAccount

Optional. The service account to run workflow invocations under.

Returns
TypeDescription
string

setServiceAccount

Optional. The service account to run workflow invocations under.

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

getKmsKeyName

Optional. The reference to a KMS encryption key. If provided, it will beused to encrypt user data in the repository and all child resources. It isnot possible to add or update the encryption key after the repository iscreated. Example:projects/{kms_project}/locations/{location}/keyRings/{key_location}/cryptoKeys/{key}

Returns
TypeDescription
string

setKmsKeyName

Optional. The reference to a KMS encryption key. If provided, it will beused to encrypt user data in the repository and all child resources. It isnot possible to add or update the encryption key after the repository iscreated. Example:projects/{kms_project}/locations/{location}/keyRings/{key_location}/cryptoKeys/{key}

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

getDataEncryptionState

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

Returns
TypeDescription
DataEncryptionState|null

hasDataEncryptionState

clearDataEncryptionState

setDataEncryptionState

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

Parameter
NameDescription
varDataEncryptionState
Returns
TypeDescription
$this

getInternalMetadata

Output only. All the metadata information that is used internally to servethe resource. For example: timestamps, flags, status fields, etc. Theformat of this field is a JSON string.

Returns
TypeDescription
string

hasInternalMetadata

clearInternalMetadata

setInternalMetadata

Output only. All the metadata information that is used internally to servethe resource. For example: timestamps, flags, status fields, etc. Theformat of this field is a JSON string.

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-01-09 UTC.