Reference documentation and code samples for the Dataform V1beta1 API class Google::Cloud::Dataform::V1beta1::WorkflowInvocation.
Represents a single invocation of a compilation result.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#compilation_result
defcompilation_result()->::String
Returns
(::String) — Immutable. The name of the compilation result to use for this invocation.
Must be in the format
projects/*/locations/*/repositories/*/compilationResults/*.
Note: The following fields are mutually exclusive: compilation_result, workflow_config. If a field in that set is populated, all other fields in the set will automatically be cleared.
#compilation_result=
defcompilation_result=(value)->::String
Parameter
value (::String) — Immutable. The name of the compilation result to use for this invocation.
Must be in the format
projects/*/locations/*/repositories/*/compilationResults/*.
Note: The following fields are mutually exclusive: compilation_result, workflow_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 compilation result to use for this invocation.
Must be in the format
projects/*/locations/*/repositories/*/compilationResults/*.
Note: The following fields are mutually exclusive: compilation_result, workflow_config. If a field in that set is populated, all other fields in the set will automatically be cleared.
(::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.
(::String) — Output only. The workflow invocation's name.
#resolved_compilation_result
defresolved_compilation_result()->::String
Returns
(::String) — Output only. The resolved compilation result that was used to create this
invocation. Will be in the format
projects/*/locations/*/repositories/*/compilationResults/*.
(::String) — Immutable. The name of the workflow config to invoke. Must be in the
format projects/*/locations/*/repositories/*/workflowConfigs/*.
Note: The following fields are mutually exclusive: workflow_config, compilation_result. If a field in that set is populated, all other fields in the set will automatically be cleared.
#workflow_config=
defworkflow_config=(value)->::String
Parameter
value (::String) — Immutable. The name of the workflow config to invoke. Must be in the
format projects/*/locations/*/repositories/*/workflowConfigs/*.
Note: The following fields are mutually exclusive: workflow_config, compilation_result. 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 workflow config to invoke. Must be in the
format projects/*/locations/*/repositories/*/workflowConfigs/*.
Note: The following fields are mutually exclusive: workflow_config, compilation_result. 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-04 UTC."],[],[],null,["# Dataform V1beta1 API - Class Google::Cloud::Dataform::V1beta1::WorkflowInvocation (v0.13.0)\n\nVersion latestkeyboard_arrow_down\n\n- [0.13.0 (latest)](/ruby/docs/reference/google-cloud-dataform-v1beta1/latest/Google-Cloud-Dataform-V1beta1-WorkflowInvocation)\n- [0.12.0](/ruby/docs/reference/google-cloud-dataform-v1beta1/0.12.0/Google-Cloud-Dataform-V1beta1-WorkflowInvocation)\n- [0.11.1](/ruby/docs/reference/google-cloud-dataform-v1beta1/0.11.1/Google-Cloud-Dataform-V1beta1-WorkflowInvocation)\n- [0.10.0](/ruby/docs/reference/google-cloud-dataform-v1beta1/0.10.0/Google-Cloud-Dataform-V1beta1-WorkflowInvocation)\n- [0.9.0](/ruby/docs/reference/google-cloud-dataform-v1beta1/0.9.0/Google-Cloud-Dataform-V1beta1-WorkflowInvocation)\n- [0.8.0](/ruby/docs/reference/google-cloud-dataform-v1beta1/0.8.0/Google-Cloud-Dataform-V1beta1-WorkflowInvocation)\n- [0.7.1](/ruby/docs/reference/google-cloud-dataform-v1beta1/0.7.1/Google-Cloud-Dataform-V1beta1-WorkflowInvocation)\n- [0.6.2](/ruby/docs/reference/google-cloud-dataform-v1beta1/0.6.2/Google-Cloud-Dataform-V1beta1-WorkflowInvocation)\n- [0.5.0](/ruby/docs/reference/google-cloud-dataform-v1beta1/0.5.0/Google-Cloud-Dataform-V1beta1-WorkflowInvocation)\n- [0.4.0](/ruby/docs/reference/google-cloud-dataform-v1beta1/0.4.0/Google-Cloud-Dataform-V1beta1-WorkflowInvocation)\n- [0.3.0](/ruby/docs/reference/google-cloud-dataform-v1beta1/0.3.0/Google-Cloud-Dataform-V1beta1-WorkflowInvocation)\n- [0.2.0](/ruby/docs/reference/google-cloud-dataform-v1beta1/0.2.0/Google-Cloud-Dataform-V1beta1-WorkflowInvocation)\n- [0.1.0](/ruby/docs/reference/google-cloud-dataform-v1beta1/0.1.0/Google-Cloud-Dataform-V1beta1-WorkflowInvocation) \nReference documentation and code samples for the Dataform V1beta1 API class Google::Cloud::Dataform::V1beta1::WorkflowInvocation.\n\nRepresents a single invocation of a compilation result. \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### #compilation_result\n\n def compilation_result() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Immutable. The name of the compilation result to use for this invocation. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.\n\n\n Note: The following fields are mutually exclusive: `compilation_result`, `workflow_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #compilation_result=\n\n def compilation_result=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Immutable. The name of the compilation result to use for this invocation. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.\n\n\nNote: The following fields are mutually exclusive: `compilation_result`, `workflow_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 compilation result to use for this invocation. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.\n\n\n Note: The following fields are mutually exclusive: `compilation_result`, `workflow_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #data_encryption_state\n\n def data_encryption_state() -\u003e ::Google::Cloud::Dataform::V1beta1::DataEncryptionState\n\n**Returns**\n\n- ([::Google::Cloud::Dataform::V1beta1::DataEncryptionState](./Google-Cloud-Dataform-V1beta1-DataEncryptionState)) --- Output only. Only set if the repository has a KMS Key.\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### #invocation_config\n\n def invocation_config() -\u003e ::Google::Cloud::Dataform::V1beta1::InvocationConfig\n\n**Returns**\n\n- ([::Google::Cloud::Dataform::V1beta1::InvocationConfig](./Google-Cloud-Dataform-V1beta1-InvocationConfig)) --- Immutable. If left unset, a default InvocationConfig will be used.\n\n### #invocation_config=\n\n def invocation_config=(value) -\u003e ::Google::Cloud::Dataform::V1beta1::InvocationConfig\n\n**Parameter**\n\n- **value** ([::Google::Cloud::Dataform::V1beta1::InvocationConfig](./Google-Cloud-Dataform-V1beta1-InvocationConfig)) --- Immutable. If left unset, a default InvocationConfig will be used. \n**Returns**\n\n- ([::Google::Cloud::Dataform::V1beta1::InvocationConfig](./Google-Cloud-Dataform-V1beta1-InvocationConfig)) --- Immutable. If left unset, a default InvocationConfig will be used.\n\n### #invocation_timing\n\n def invocation_timing() -\u003e ::Google::Type::Interval\n\n**Returns**\n\n- ([::Google::Type::Interval](./Google-Type-Interval)) --- Output only. This workflow invocation's timing details.\n\n### #name\n\n def name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Output only. The workflow invocation's name.\n\n### #resolved_compilation_result\n\n def resolved_compilation_result() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Output only. The resolved compilation result that was used to create this invocation. Will be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.\n\n### #state\n\n def state() -\u003e ::Google::Cloud::Dataform::V1beta1::WorkflowInvocation::State\n\n**Returns**\n\n- ([::Google::Cloud::Dataform::V1beta1::WorkflowInvocation::State](./Google-Cloud-Dataform-V1beta1-WorkflowInvocation-State)) --- Output only. This workflow invocation's current state.\n\n### #workflow_config\n\n def workflow_config() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Immutable. The name of the workflow config to invoke. Must be in the format `projects/*/locations/*/repositories/*/workflowConfigs/*`.\n\n\n Note: The following fields are mutually exclusive: `workflow_config`, `compilation_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #workflow_config=\n\n def workflow_config=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Immutable. The name of the workflow config to invoke. Must be in the format `projects/*/locations/*/repositories/*/workflowConfigs/*`.\n\n\nNote: The following fields are mutually exclusive: `workflow_config`, `compilation_result`. 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 workflow config to invoke. Must be in the format `projects/*/locations/*/repositories/*/workflowConfigs/*`.\n\n\n Note: The following fields are mutually exclusive: `workflow_config`, `compilation_result`. If a field in that set is populated, all other fields in the set will automatically be cleared."]]
