Google Cloud Dataform V1 Client - Class CompilationResult (0.18.0)

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 message google.cloud.dataform.v1.CompilationResult

Namespace

Google \ Cloud \ Dataform \ V1

Methods

__construct

Constructor.

Parameter
Name Description
data mixed

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\RepeatedField<CompilationResult\CompilationError>

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

getPrivateResourceMetadata

Output only. Metadata indicating whether this resource is user-scoped.

CompilationResult resource is user_scoped only if it is sourced from a workspace.

Returns
Type Description
PrivateResourceMetadata|null

hasPrivateResourceMetadata

clearPrivateResourceMetadata

setPrivateResourceMetadata

Output only. Metadata indicating whether this resource is user-scoped.

CompilationResult resource is user_scoped only if it is sourced from a workspace.

Parameter
Name Description
var PrivateResourceMetadata
Returns
Type Description
$this

getGcsRepositorySnapshotMetadata

Output only. Metadata about the repository snapshot used by scheduled notebooks.

Returns
Type Description
GcsRepositorySnapshotMetadata|null

hasGcsRepositorySnapshotMetadata

clearGcsRepositorySnapshotMetadata

setGcsRepositorySnapshotMetadata

Output only. Metadata about the repository snapshot used by scheduled notebooks.

Parameter
Name Description
var GcsRepositorySnapshotMetadata
Returns
Type Description
$this

getSource

Returns
Type Description
string