Google Cloud Dataform V1beta1 Client - Class CompilationResult (0.6.0)

Version latest

• 0.6.0 (latest)
• 0.5.1
• 0.4.7
• 0.3.0
• 0.2.3
• 0.1.6

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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
Name	Description
data	array Optional. Data for populating the Message object.
↳ 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. Must be in the format projects/*/locations/*/repositories/*/releaseConfigs/*.
↳ name	string Output only. The compilation result's name.
↳ code_compilation_config	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<CompilationResult\CompilationError> Output only. Errors encountered during project compilation.
↳ data_encryption_state	DataEncryptionState Output only. Only set if the repository has a KMS Key.
↳ create_time	Google\Protobuf\Timestamp Output only. The timestamp of when the compilation result was created.
↳ 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.

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
Type	Description
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
Name	Description
var	string

Returns
Type	Description
$this

getWorkspace

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

Returns
Type	Description
string

hasWorkspace

setWorkspace

Immutable. The name of the workspace to compile. Must be in the format projects/*/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 the format projects/*/locations/*/repositories/*/releaseConfigs/*.

Returns
Type	Description
string

hasReleaseConfig

setReleaseConfig

Immutable. The name of the release config to compile. Must be in the format projects/*/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 of code_compilation_config override the default compilation settings that are specified in dataform.json.

Returns
Type	Description
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
Name	Description
var	CodeCompilationConfig

Returns
Type	Description
$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
Type	Description
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
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 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

getSource

Returns
Type	Description
string