Note: The following fields are mutually exclusive: bigquery_action, notebook_action, data_preparation_action. If a field in that set is populated, all other fields in the set will automatically be cleared.
(::Google::Cloud::Dataform::V1::Target) — Output only. The action's identifier if the project had been compiled
without any overrides configured. Unique within the compilation result.
Note: The following fields are mutually exclusive: data_preparation_action, bigquery_action, notebook_action. If a field in that set is populated, all other fields in the set will automatically be cleared.
#failure_reason
deffailure_reason()->::String
Returns
(::String) — Output only. If and only if action's state is FAILED a failure reason is
set.
#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.
#invocation_timing
definvocation_timing()->::Google::Type::Interval
Returns
(::Google::Type::Interval) — Output only. This action's timing details.
start_time will be set if the action is in [RUNNING, SUCCEEDED,
CANCELLED, FAILED] state.
end_time will be set if the action is in [SUCCEEDED, CANCELLED, FAILED]
state.
Note: The following fields are mutually exclusive: notebook_action, bigquery_action, data_preparation_action. 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::WorkflowInvocationAction (v0.1.0)\n\nReference documentation and code samples for the Dataform V1 API class Google::Cloud::Dataform::V1::WorkflowInvocationAction.\n\nRepresents a single action in a workflow invocation. \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### #bigquery_action\n\n def bigquery_action() -\u003e ::Google::Cloud::Dataform::V1::WorkflowInvocationAction::BigQueryAction\n\n**Returns**\n\n- ([::Google::Cloud::Dataform::V1::WorkflowInvocationAction::BigQueryAction](./Google-Cloud-Dataform-V1-WorkflowInvocationAction-BigQueryAction)) --- Output only. The workflow action's bigquery action details.\n\n\n Note: The following fields are mutually exclusive: `bigquery_action`, `notebook_action`, `data_preparation_action`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #canonical_target\n\n def canonical_target() -\u003e ::Google::Cloud::Dataform::V1::Target\n\n**Returns**\n\n- ([::Google::Cloud::Dataform::V1::Target](./Google-Cloud-Dataform-V1-Target)) --- Output only. The action's identifier if the project had been compiled without any overrides configured. Unique within the compilation result.\n\n### #data_preparation_action\n\n def data_preparation_action() -\u003e ::Google::Cloud::Dataform::V1::WorkflowInvocationAction::DataPreparationAction\n\n**Returns**\n\n- ([::Google::Cloud::Dataform::V1::WorkflowInvocationAction::DataPreparationAction](./Google-Cloud-Dataform-V1-WorkflowInvocationAction-DataPreparationAction)) --- Output only. The workflow action's data preparation action details.\n\n\n Note: The following fields are mutually exclusive: `data_preparation_action`, `bigquery_action`, `notebook_action`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #failure_reason\n\n def failure_reason() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Output only. If and only if action's state is FAILED a failure reason is set.\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_timing\n\n def invocation_timing() -\u003e ::Google::Type::Interval\n\n**Returns**\n\n- ([::Google::Type::Interval](./Google-Type-Interval)) --- Output only. This action's timing details. `start_time` will be set if the action is in \\[RUNNING, SUCCEEDED, CANCELLED, FAILED\\] state. `end_time` will be set if the action is in \\[SUCCEEDED, CANCELLED, FAILED\\] state.\n\n### #notebook_action\n\n def notebook_action() -\u003e ::Google::Cloud::Dataform::V1::WorkflowInvocationAction::NotebookAction\n\n**Returns**\n\n- ([::Google::Cloud::Dataform::V1::WorkflowInvocationAction::NotebookAction](./Google-Cloud-Dataform-V1-WorkflowInvocationAction-NotebookAction)) --- Output only. The workflow action's notebook action details.\n\n\n Note: The following fields are mutually exclusive: `notebook_action`, `bigquery_action`, `data_preparation_action`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #state\n\n def state() -\u003e ::Google::Cloud::Dataform::V1::WorkflowInvocationAction::State\n\n**Returns**\n\n- ([::Google::Cloud::Dataform::V1::WorkflowInvocationAction::State](./Google-Cloud-Dataform-V1-WorkflowInvocationAction-State)) --- Output only. This action's current state.\n\n### #target\n\n def target() -\u003e ::Google::Cloud::Dataform::V1::Target\n\n**Returns**\n\n- ([::Google::Cloud::Dataform::V1::Target](./Google-Cloud-Dataform-V1-Target)) --- Output only. This action's identifier. Unique within the workflow invocation."]]
