Google Cloud Dataform V1beta1 Client - Class Repository (0.10.0)

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

Represents a Dataform Git repository.

Generated from protobuf message google.cloud.dataform.v1beta1.Repository

Namespace

Google \ Cloud \ Dataform \ V1beta1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Identifier. The repository's name.
↳ containing_folder string

Optional. The name of the containing folder of the repository. The field is immutable and it can be modified via a MoveRepository operation. Format: projects/*/locations/*/folders/*. or projects/*/locations/*/teamFolders/*.
↳ team_folder_name string

Output only. The resource name of the TeamFolder that this Repository is associated with. This should take the format: projects/{project}/locations/{location}/teamFolders/{teamFolder}. If this is not set, the Repository is not associated with a TeamFolder.
↳ create_time Google\Protobuf\Timestamp

Output only. The timestamp of when the repository was created.
↳ display_name string

Optional. The repository's user-friendly name.
↳ git_remote_settings Repository\GitRemoteSettings

Optional. If set, configures this repository to be linked to a Git remote.
↳ npmrc_environment_variables_secret_version 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.
↳ workspace_compilation_overrides Repository\WorkspaceCompilationOverrides

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.
↳ labels array|Google\Protobuf\Internal\MapField

Optional. Repository user labels.
↳ set_authenticated_user_admin bool

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
↳ service_account string

Optional. The service account to run workflow invocations under.
↳ kms_key_name 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}
↳ data_encryption_state DataEncryptionState

Output only. A data encryption state of a Git repository if this Repository is protected by a KMS key.
↳ internal_metadata 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.

getName

Identifier. The repository's name.

Returns
Type Description
string

setName

Identifier. The repository's name.

Parameter
Name Description
var string
Returns
Type Description
$this

getContainingFolder

Optional. The name of the containing folder of the repository.

The field is immutable and it can be modified via a MoveRepository operation. Format: projects/*/locations/*/folders/*. or projects/*/locations/*/teamFolders/*.

Returns
Type Description
string

hasContainingFolder

clearContainingFolder

setContainingFolder

Optional. The name of the containing folder of the repository.

The field is immutable and it can be modified via a MoveRepository operation. Format: projects/*/locations/*/folders/*. or projects/*/locations/*/teamFolders/*.

Parameter
Name Description
var string
Returns
Type Description
$this

getTeamFolderName

Output only. The resource name of the TeamFolder that this Repository is associated with. This should take the format: projects/{project}/locations/{location}/teamFolders/{teamFolder}. If this is not set, the Repository is not associated with a TeamFolder.

Returns
Type Description
string

hasTeamFolderName

clearTeamFolderName

setTeamFolderName

Output only. The resource name of the TeamFolder that this Repository is associated with. This should take the format: projects/{project}/locations/{location}/teamFolders/{teamFolder}. If this is not set, the Repository is not associated with a TeamFolder.

Parameter
Name Description
var string
Returns
Type Description
$this

getCreateTime

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

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

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

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getDisplayName

Optional. The repository's user-friendly name.

Returns
Type Description
string

setDisplayName

Optional. The repository's user-friendly name.

Parameter
Name Description
var string
Returns
Type Description
$this

getGitRemoteSettings

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

Returns
Type Description
Repository\GitRemoteSettings|null

hasGitRemoteSettings

clearGitRemoteSettings

setGitRemoteSettings

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

Parameter
Name Description
var Repository\GitRemoteSettings
Returns
Type Description
$this

getNpmrcEnvironmentVariablesSecretVersion

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.

Returns
Type Description
string

setNpmrcEnvironmentVariablesSecretVersion

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getWorkspaceCompilationOverrides

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.

Returns
Type Description
Repository\WorkspaceCompilationOverrides|null

hasWorkspaceCompilationOverrides

clearWorkspaceCompilationOverrides

setWorkspaceCompilationOverrides

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.

Parameter
Name Description
var Repository\WorkspaceCompilationOverrides
Returns
Type Description
$this

getLabels

Optional. Repository user labels.

Returns
Type Description
Google\Protobuf\Internal\MapField

setLabels

Optional. Repository user labels.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getSetAuthenticatedUserAdmin

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

Returns
Type Description
bool

setSetAuthenticatedUserAdmin

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

Parameter
Name Description
var bool
Returns
Type Description
$this

getServiceAccount

Optional. The service account to run workflow invocations under.

Returns
Type Description
string

setServiceAccount

Optional. The service account to run workflow invocations under.

Parameter
Name Description
var string
Returns
Type Description
$this

getKmsKeyName

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}

Returns
Type Description
string

setKmsKeyName

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}

Parameter
Name Description
var string
Returns
Type Description
$this

getDataEncryptionState

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

Returns
Type Description
DataEncryptionState|null

hasDataEncryptionState

clearDataEncryptionState

setDataEncryptionState

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

Parameter
Name Description
var DataEncryptionState
Returns
Type Description
$this

getInternalMetadata

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.

Returns
Type Description
string

hasInternalMetadata

clearInternalMetadata

setInternalMetadata

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.

Parameter
Name Description
var string
Returns
Type Description
$this