(::String) — Output only. The version of @dataform/core that was used for compilation.
#git_commitish
defgit_commitish()->::String
Returns
(::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
Note: The following fields are mutually exclusive: git_commitish, workspace, release_config. If a field in that set is populated, all other fields in the set will automatically be cleared.
#git_commitish=
defgit_commitish=(value)->::String
Parameter
value (::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
Note: The following fields are mutually exclusive: git_commitish, workspace, release_config. If a field in that set is populated, all other fields in the set will automatically be cleared.
Returns
(::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
Note: The following fields are mutually exclusive: git_commitish, workspace, release_config. If a field in that set is populated, all other fields in the set will automatically be cleared.
#internal_metadata
definternal_metadata()->::String
Returns
(::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.
#name
defname()->::String
Returns
(::String) — Output only. The compilation result's name.
#release_config
defrelease_config()->::String
Returns
(::String) — Immutable. The name of the release config to compile. Must be in the
format projects/*/locations/*/repositories/*/releaseConfigs/*.
Note: The following fields are mutually exclusive: release_config, git_commitish, workspace. If a field in that set is populated, all other fields in the set will automatically be cleared.
#release_config=
defrelease_config=(value)->::String
Parameter
value (::String) — Immutable. The name of the release config to compile. Must be in the
format projects/*/locations/*/repositories/*/releaseConfigs/*.
Note: The following fields are mutually exclusive: release_config, git_commitish, workspace. If a field in that set is populated, all other fields in the set will automatically be cleared.
Returns
(::String) — Immutable. The name of the release config to compile. Must be in the
format projects/*/locations/*/repositories/*/releaseConfigs/*.
Note: The following fields are mutually exclusive: release_config, git_commitish, workspace. If a field in that set is populated, all other fields in the set will automatically be cleared.
#resolved_git_commit_sha
defresolved_git_commit_sha()->::String
Returns
(::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
defworkspace()->::String
Returns
(::String) — Immutable. The name of the workspace to compile. Must be in the format
projects/*/locations/*/repositories/*/workspaces/*.
Note: The following fields are mutually exclusive: workspace, git_commitish, release_config. If a field in that set is populated, all other fields in the set will automatically be cleared.
#workspace=
defworkspace=(value)->::String
Parameter
value (::String) — Immutable. The name of the workspace to compile. Must be in the format
projects/*/locations/*/repositories/*/workspaces/*.
Note: The following fields are mutually exclusive: workspace, git_commitish, release_config. If a field in that set is populated, all other fields in the set will automatically be cleared.
Returns
(::String) — Immutable. The name of the workspace to compile. Must be in the format
projects/*/locations/*/repositories/*/workspaces/*.
Note: The following fields are mutually exclusive: workspace, git_commitish, release_config. If a field in that set is populated, all other fields in the set will automatically be cleared.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-03 UTC."],[],[],null,["# Dataform V1 API - Class Google::Cloud::Dataform::V1::CompilationResult (v0.1.0)\n\nReference documentation and code samples for the Dataform V1 API class Google::Cloud::Dataform::V1::CompilationResult.\n\nRepresents the result of compiling a Dataform project. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #code_compilation_config\n\n def code_compilation_config() -\u003e ::Google::Cloud::Dataform::V1::CodeCompilationConfig\n\n**Returns**\n\n- ([::Google::Cloud::Dataform::V1::CodeCompilationConfig](./Google-Cloud-Dataform-V1-CodeCompilationConfig)) --- Immutable. If set, fields of `code_compilation_config` override the default compilation settings that are specified in dataform.json.\n\n### #code_compilation_config=\n\n def code_compilation_config=(value) -\u003e ::Google::Cloud::Dataform::V1::CodeCompilationConfig\n\n**Parameter**\n\n- **value** ([::Google::Cloud::Dataform::V1::CodeCompilationConfig](./Google-Cloud-Dataform-V1-CodeCompilationConfig)) --- Immutable. If set, fields of `code_compilation_config` override the default compilation settings that are specified in dataform.json. \n**Returns**\n\n- ([::Google::Cloud::Dataform::V1::CodeCompilationConfig](./Google-Cloud-Dataform-V1-CodeCompilationConfig)) --- Immutable. If set, fields of `code_compilation_config` override the default compilation settings that are specified in dataform.json.\n\n### #compilation_errors\n\n def compilation_errors() -\u003e ::Array\u003c::Google::Cloud::Dataform::V1::CompilationResult::CompilationError\u003e\n\n**Returns**\n\n- (::Array\\\u003c[::Google::Cloud::Dataform::V1::CompilationResult::CompilationError](./Google-Cloud-Dataform-V1-CompilationResult-CompilationError)\\\u003e) --- Output only. Errors encountered during project compilation.\n\n### #create_time\n\n def create_time() -\u003e ::Google::Protobuf::Timestamp\n\n**Returns**\n\n- ([::Google::Protobuf::Timestamp](./Google-Protobuf-Timestamp)) --- Output only. The timestamp of when the compilation result was created.\n\n### #data_encryption_state\n\n def data_encryption_state() -\u003e ::Google::Cloud::Dataform::V1::DataEncryptionState\n\n**Returns**\n\n- ([::Google::Cloud::Dataform::V1::DataEncryptionState](./Google-Cloud-Dataform-V1-DataEncryptionState)) --- Output only. Only set if the repository has a KMS Key.\n\n### #dataform_core_version\n\n def dataform_core_version() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Output only. The version of `@dataform/core` that was used for compilation.\n\n### #git_commitish\n\n def git_commitish() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Immutable. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples:\n\n - a commit SHA: `12ade345`\n - a tag: `tag1`\n - a branch name: `branch1`\n\n Note: The following fields are mutually exclusive: `git_commitish`, `workspace`, `release_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #git_commitish=\n\n def git_commitish=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Immutable. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples:\n\n\n - a commit SHA: `12ade345`\n - a tag: `tag1`\n - a branch name: `branch1`\n\nNote: The following fields are mutually exclusive: `git_commitish`, `workspace`, `release_config`. If a field in that set is populated, all other fields in the set will automatically be cleared. \n**Returns**\n\n- (::String) --- Immutable. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples:\n\n - a commit SHA: `12ade345`\n - a tag: `tag1`\n - a branch name: `branch1`\n\n Note: The following fields are mutually exclusive: `git_commitish`, `workspace`, `release_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #internal_metadata\n\n def internal_metadata() -\u003e ::String\n\n**Returns**\n\n- (::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.\n\n### #name\n\n def name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Output only. The compilation result's name.\n\n### #release_config\n\n def release_config() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Immutable. The name of the release config to compile. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`.\n\n\n Note: The following fields are mutually exclusive: `release_config`, `git_commitish`, `workspace`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #release_config=\n\n def release_config=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Immutable. The name of the release config to compile. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`.\n\n\nNote: The following fields are mutually exclusive: `release_config`, `git_commitish`, `workspace`. If a field in that set is populated, all other fields in the set will automatically be cleared. \n**Returns**\n\n- (::String) --- Immutable. The name of the release config to compile. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`.\n\n\n Note: The following fields are mutually exclusive: `release_config`, `git_commitish`, `workspace`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #resolved_git_commit_sha\n\n def resolved_git_commit_sha() -\u003e ::String\n\n**Returns**\n\n- (::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.\n\n### #workspace\n\n def workspace() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Immutable. The name of the workspace to compile. Must be in the format `projects/*/locations/*/repositories/*/workspaces/*`.\n\n\n Note: The following fields are mutually exclusive: `workspace`, `git_commitish`, `release_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #workspace=\n\n def workspace=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Immutable. The name of the workspace to compile. Must be in the format `projects/*/locations/*/repositories/*/workspaces/*`.\n\n\nNote: The following fields are mutually exclusive: `workspace`, `git_commitish`, `release_config`. If a field in that set is populated, all other fields in the set will automatically be cleared. \n**Returns**\n\n- (::String) --- Immutable. The name of the workspace to compile. Must be in the format `projects/*/locations/*/repositories/*/workspaces/*`.\n\n\n Note: The following fields are mutually exclusive: `workspace`, `git_commitish`, `release_config`. If a field in that set is populated, all other fields in the set will automatically be cleared."]]
