Google Cloud Dataform V1beta1 Client - Class CompilationResult (0.3.0)

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

Represents the result of compiling a Dataform project.

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

Namespace

Google \ Cloud \ Dataform \ V1beta1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Output only. The compilation result's name.

↳ git_commitish string

Immutable. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples: - a commit SHA: 12ade345 - a tag: tag1 - a branch name: branch1

↳ workspace string

Immutable. The name of the workspace to compile. Must be in the format projects/*/locations/*/repositories/*/workspaces/*.

↳ release_config string

Immutable. The name of the release config to compile. The release config's 'current_compilation_result' field will be updated to this compilation result. Must be in the format projects/*/locations/*/repositories/*/releaseConfigs/*.

↳ code_compilation_config Google\Cloud\Dataform\V1beta1\CodeCompilationConfig

Immutable. If set, fields of code_compilation_config override the default compilation settings that are specified in dataform.json.

↳ resolved_git_commit_sha string

Output 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 string

Output only. The version of @dataform/core that was used for compilation.

↳ compilation_errors array<Google\Cloud\Dataform\V1beta1\CompilationResult\CompilationError>

Output only. Errors encountered during project compilation.

getName

Output only. The compilation result's name.

Returns
TypeDescription
string

setName

Output only. The compilation result's name.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getGitCommitish

Immutable. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples:

  • a commit SHA: 12ade345
  • a tag: tag1
  • a branch name: branch1
Returns
TypeDescription
string

hasGitCommitish

setGitCommitish

Immutable. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples:

  • a commit SHA: 12ade345
  • a tag: tag1
  • a branch name: branch1
Parameter
NameDescription
var string
Returns
TypeDescription
$this

getWorkspace

Immutable. The name of the workspace to compile. Must be in the format projects/*/locations/*/repositories/*/workspaces/*.

Returns
TypeDescription
string

hasWorkspace

setWorkspace

Immutable. The name of the workspace to compile. Must be in the format projects/*/locations/*/repositories/*/workspaces/*.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getReleaseConfig

Immutable. The name of the release config to compile. The release config's 'current_compilation_result' field will be updated to this compilation result. Must be in the format projects/*/locations/*/repositories/*/releaseConfigs/*.

Returns
TypeDescription
string

hasReleaseConfig

setReleaseConfig

Immutable. The name of the release config to compile. The release config's 'current_compilation_result' field will be updated to this compilation result. Must be in the format projects/*/locations/*/repositories/*/releaseConfigs/*.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCodeCompilationConfig

Immutable. If set, fields of code_compilation_config override the default compilation settings that are specified in dataform.json.

Returns
TypeDescription
Google\Cloud\Dataform\V1beta1\CodeCompilationConfig|null

hasCodeCompilationConfig

clearCodeCompilationConfig

setCodeCompilationConfig

Immutable. If set, fields of code_compilation_config override the default compilation settings that are specified in dataform.json.

Parameter
NameDescription
var Google\Cloud\Dataform\V1beta1\CodeCompilationConfig
Returns
TypeDescription
$this

getResolvedGitCommitSha

Output only. The fully resolved Git commit SHA of the code that was compiled. Not set for compilation results whose source is a workspace.

Returns
TypeDescription
string

setResolvedGitCommitSha

Output only. The fully resolved Git commit SHA of the code that was compiled. Not set for compilation results whose source is a workspace.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDataformCoreVersion

Output only. The version of @dataform/core that was used for compilation.

Returns
TypeDescription
string

setDataformCoreVersion

Output only. The version of @dataform/core that was used for compilation.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCompilationErrors

Output only. Errors encountered during project compilation.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setCompilationErrors

Output only. Errors encountered during project compilation.

Parameter
NameDescription
var array<Google\Cloud\Dataform\V1beta1\CompilationResult\CompilationError>
Returns
TypeDescription
$this

getSource

Returns
TypeDescription
string