compilation_results

Creates, updates, deletes, gets or lists a compilation_results resource.

Overview

Name	compilation_results
Type	Resource
Id	google.dataform.compilation_results

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Output only. The compilation result's name.
codeCompilationConfig	object	Immutable. If set, fields of code_compilation_config override the default compilation settings that are specified in dataform.json. (id: CodeCompilationConfig)
compilationErrors	array	Output only. Errors encountered during project compilation.
createTime	string (google-datetime)	Output only. The timestamp of when the compilation result was created.
dataEncryptionState	object	Output only. Only set if the repository has a KMS Key. (id: DataEncryptionState)
dataformCoreVersion	string	Output only. The version of @dataform/core that was used for compilation.
gitCommitish	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
internalMetadata	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.
releaseConfig	string	Immutable. The name of the release config to compile. Must be in the format projects/*/locations/*/repositories/*/releaseConfigs/*.
resolvedGitCommitSha	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.
workspace	string	Immutable. The name of the workspace to compile. Must be in the format projects/*/locations/*/repositories/*/workspaces/*.

query

Successful response

Name	Datatype	Description
compilationResultActions	array	List of compilation result actions.
nextPageToken	string	A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

list

Successful response

Name	Datatype	Description
name	string	Output only. The compilation result's name.
codeCompilationConfig	object	Immutable. If set, fields of code_compilation_config override the default compilation settings that are specified in dataform.json. (id: CodeCompilationConfig)
compilationErrors	array	Output only. Errors encountered during project compilation.
createTime	string (google-datetime)	Output only. The timestamp of when the compilation result was created.
dataEncryptionState	object	Output only. Only set if the repository has a KMS Key. (id: DataEncryptionState)
dataformCoreVersion	string	Output only. The version of @dataform/core that was used for compilation.
gitCommitish	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
internalMetadata	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.
releaseConfig	string	Immutable. The name of the release config to compile. Must be in the format projects/*/locations/*/repositories/*/releaseConfigs/*.
resolvedGitCommitSha	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.
workspace	string	Immutable. The name of the workspace to compile. Must be in the format projects/*/locations/*/repositories/*/workspaces/*.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, repositoriesId, compilationResultsId		Fetches a single CompilationResult.
query	select	projectsId, locationsId, repositoriesId, compilationResultsId	pageSize, pageToken, filter	Returns CompilationResultActions in a given CompilationResult.
list	select	projectsId, locationsId, repositoriesId	pageSize, pageToken, orderBy, filter	Lists CompilationResults in a given Repository.
create	insert	projectsId, locationsId, repositoriesId		Creates a new CompilationResult in a given project and location.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
compilationResultsId	string
locationsId	string
projectsId	string
repositoriesId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string

SELECT examples

get

Fetches a single CompilationResult.

SELECT
name,
codeCompilationConfig,
compilationErrors,
createTime,
dataEncryptionState,
dataformCoreVersion,
gitCommitish,
internalMetadata,
releaseConfig,
resolvedGitCommitSha,
workspace
FROM google.dataform.compilation_results
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND repositoriesId = '{{ repositoriesId }}' -- required
AND compilationResultsId = '{{ compilationResultsId }}' -- required;

query

Returns CompilationResultActions in a given CompilationResult.

SELECT
compilationResultActions,
nextPageToken
FROM google.dataform.compilation_results
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND repositoriesId = '{{ repositoriesId }}' -- required
AND compilationResultsId = '{{ compilationResultsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}';

list

Lists CompilationResults in a given Repository.

SELECT
name,
codeCompilationConfig,
compilationErrors,
createTime,
dataEncryptionState,
dataformCoreVersion,
gitCommitish,
internalMetadata,
releaseConfig,
resolvedGitCommitSha,
workspace
FROM google.dataform.compilation_results
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND repositoriesId = '{{ repositoriesId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND orderBy = '{{ orderBy }}'
AND filter = '{{ filter }}';

INSERT examples

create

Creates a new CompilationResult in a given project and location.

INSERT INTO google.dataform.compilation_results (
data__gitCommitish,
data__workspace,
data__releaseConfig,
data__codeCompilationConfig,
projectsId,
locationsId,
repositoriesId
)
SELECT 
'{{ gitCommitish }}',
'{{ workspace }}',
'{{ releaseConfig }}',
'{{ codeCompilationConfig }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ repositoriesId }}'
RETURNING
name,
codeCompilationConfig,
compilationErrors,
createTime,
dataEncryptionState,
dataformCoreVersion,
gitCommitish,
internalMetadata,
releaseConfig,
resolvedGitCommitSha,
workspace
;

Manifest

# Description fields are for documentation purposes
- name: compilation_results
  props:
    - name: projectsId
      value: string
      description: Required parameter for the compilation_results resource.
    - name: locationsId
      value: string
      description: Required parameter for the compilation_results resource.
    - name: repositoriesId
      value: string
      description: Required parameter for the compilation_results resource.
    - name: gitCommitish
      value: string
      description: >
        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`
        
    - name: workspace
      value: string
      description: >
        Immutable. The name of the workspace to compile. Must be in the format `projects/*/locations/*/repositories/*/workspaces/*`.
        
    - name: releaseConfig
      value: string
      description: >
        Immutable. The name of the release config to compile. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`.
        
    - name: codeCompilationConfig
      value: object
      description: >
        Immutable. If set, fields of `code_compilation_config` override the default compilation settings that are specified in dataform.json.