Google Cloud Dataform V1 Client - Class CompilationResult (0.9.2)
Reference documentation and code samples for the Google Cloud Dataform V1 Client class CompilationResult.
Represents the result of compiling a Dataform project.
Generated from protobuf messagegoogle.cloud.dataform.v1.CompilationResult
Namespace
Google \ Cloud \ Dataform \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data | arrayOptional. Data for populating the Message object. |
↳ git_commitish | stringImmutable. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples: - a commit SHA: |
↳ workspace | stringImmutable. The name of the workspace to compile. Must be in the format |
↳ release_config | stringImmutable. The name of the release config to compile. Must be in the format |
↳ name | stringOutput only. The compilation result's name. |
↳ code_compilation_config | CodeCompilationConfigImmutable. If set, fields of |
↳ resolved_git_commit_sha | stringOutput only. The fully resolved Git commit SHA of the code that was compiled. Not set for compilation results whose source is a workspace. |
↳ dataform_core_version | stringOutput only. The version of |
↳ compilation_errors | array<CompilationResult\CompilationError>Output only. Errors encountered during project compilation. |
↳ data_encryption_state | DataEncryptionStateOutput only. Only set if the repository has a KMS Key. |
↳ create_time | Google\Protobuf\TimestampOutput only. The timestamp of when the compilation result was created. |
↳ internal_metadata | stringOutput 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. |
getGitCommitish
Immutable. Git commit/tag/branch name at which the repository should becompiled. Must exist in the remote repository. Examples:
- a commit SHA:
12ade345 - a tag:
tag1 - a branch name:
branch1
| Returns | |
|---|---|
| Type | Description |
string | |
hasGitCommitish
setGitCommitish
Immutable. Git commit/tag/branch name at which the repository should becompiled. Must exist in the remote repository. Examples:
- a commit SHA:
12ade345 - a tag:
tag1 - a branch name:
branch1
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getWorkspace
Immutable. The name of the workspace to compile. Must be in the formatprojects/*/locations/*/repositories/*/workspaces/*.
| Returns | |
|---|---|
| Type | Description |
string | |
hasWorkspace
setWorkspace
Immutable. The name of the workspace to compile. Must be in the formatprojects/*/locations/*/repositories/*/workspaces/*.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getReleaseConfig
Immutable. The name of the release config to compile. Must be in theformatprojects/*/locations/*/repositories/*/releaseConfigs/*.
| Returns | |
|---|---|
| Type | Description |
string | |
hasReleaseConfig
setReleaseConfig
Immutable. The name of the release config to compile. Must be in theformatprojects/*/locations/*/repositories/*/releaseConfigs/*.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getName
Output only. The compilation result's name.
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Output only. The compilation result's name.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getCodeCompilationConfig
Immutable. If set, fields ofcode_compilation_config override the defaultcompilation settings that are specified in dataform.json.
| Returns | |
|---|---|
| Type | Description |
CodeCompilationConfig|null | |
hasCodeCompilationConfig
clearCodeCompilationConfig
setCodeCompilationConfig
Immutable. If set, fields ofcode_compilation_config override the defaultcompilation settings that are specified in dataform.json.
| Parameter | |
|---|---|
| Name | Description |
var | CodeCompilationConfig |
| Returns | |
|---|---|
| Type | Description |
$this | |
getResolvedGitCommitSha
Output only. The fully resolved Git commit SHA of the code that wascompiled. Not set for compilation results whose source is a workspace.
| Returns | |
|---|---|
| Type | Description |
string | |
setResolvedGitCommitSha
Output only. The fully resolved Git commit SHA of the code that wascompiled. Not set for compilation results whose source is a workspace.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getDataformCoreVersion
Output only. The version of@dataform/core that was used for compilation.
| Returns | |
|---|---|
| Type | Description |
string | |
setDataformCoreVersion
Output only. The version of@dataform/core that was used for compilation.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getCompilationErrors
Output only. Errors encountered during project compilation.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setCompilationErrors
Output only. Errors encountered during project compilation.
| Parameter | |
|---|---|
| Name | Description |
var | array<CompilationResult\CompilationError> |
| Returns | |
|---|---|
| Type | Description |
$this | |
getDataEncryptionState
Output only. Only set if the repository has a KMS Key.
| Returns | |
|---|---|
| Type | Description |
DataEncryptionState|null | |
hasDataEncryptionState
clearDataEncryptionState
setDataEncryptionState
Output only. Only set if the repository has a KMS Key.
| Parameter | |
|---|---|
| Name | Description |
var | DataEncryptionState |
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
Output only. The timestamp of when the compilation result was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Output only. The timestamp of when the compilation result was created.
| Parameter | |
|---|---|
| Name | Description |
var | Google\Protobuf\Timestamp |
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getSource
| Returns | |
|---|---|
| Type | Description |
string | |
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.