Reference documentation and code samples for the Dataform V1beta1 API class Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction.
Represents a workflow action that will run a Data Preparation.
Note: The following fields are mutually exclusive: contents_sql, contents_yaml. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: contents_sql, contents_yaml. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: contents_sql, contents_yaml. If a field in that set is populated, all other fields in the set will automatically be cleared.
#contents_yaml
defcontents_yaml()->::String
Returns
(::String) — Output only. YAML representing the contents of the data preparation.
Can be used to show the customer what the input was to their workflow.
Note: The following fields are mutually exclusive: contents_yaml, contents_sql. If a field in that set is populated, all other fields in the set will automatically be cleared.
#generated_sql
defgenerated_sql()->::String
Returns
(::String) — Output only. The generated BigQuery SQL script that will be executed. For
reference only.
#job_id
defjob_id()->::String
Returns
(::String) — Output only. The ID of the BigQuery job that executed the SQL in
sql_script. Only set once the job has started to run.
[[["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::WorkflowInvocationAction::DataPreparationAction (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-WorkflowInvocationAction-DataPreparationAction)\n- [0.12.0](/ruby/docs/reference/google-cloud-dataform-v1beta1/0.12.0/Google-Cloud-Dataform-V1beta1-WorkflowInvocationAction-DataPreparationAction)\n- [0.11.1](/ruby/docs/reference/google-cloud-dataform-v1beta1/0.11.1/Google-Cloud-Dataform-V1beta1-WorkflowInvocationAction-DataPreparationAction)\n- [0.10.0](/ruby/docs/reference/google-cloud-dataform-v1beta1/0.10.0/Google-Cloud-Dataform-V1beta1-WorkflowInvocationAction-DataPreparationAction)\n- [0.9.0](/ruby/docs/reference/google-cloud-dataform-v1beta1/0.9.0/Google-Cloud-Dataform-V1beta1-WorkflowInvocationAction-DataPreparationAction)\n- [0.8.0](/ruby/docs/reference/google-cloud-dataform-v1beta1/0.8.0/Google-Cloud-Dataform-V1beta1-WorkflowInvocationAction-DataPreparationAction)\n- [0.7.1](/ruby/docs/reference/google-cloud-dataform-v1beta1/0.7.1/Google-Cloud-Dataform-V1beta1-WorkflowInvocationAction-DataPreparationAction)\n- [0.6.2](/ruby/docs/reference/google-cloud-dataform-v1beta1/0.6.2/Google-Cloud-Dataform-V1beta1-WorkflowInvocationAction-DataPreparationAction)\n- [0.5.0](/ruby/docs/reference/google-cloud-dataform-v1beta1/0.5.0/Google-Cloud-Dataform-V1beta1-WorkflowInvocationAction-DataPreparationAction)\n- [0.4.0](/ruby/docs/reference/google-cloud-dataform-v1beta1/0.4.0/Google-Cloud-Dataform-V1beta1-WorkflowInvocationAction-DataPreparationAction)\n- [0.3.0](/ruby/docs/reference/google-cloud-dataform-v1beta1/0.3.0/Google-Cloud-Dataform-V1beta1-WorkflowInvocationAction-DataPreparationAction)\n- [0.2.0](/ruby/docs/reference/google-cloud-dataform-v1beta1/0.2.0/Google-Cloud-Dataform-V1beta1-WorkflowInvocationAction-DataPreparationAction)\n- [0.1.0](/ruby/docs/reference/google-cloud-dataform-v1beta1/0.1.0/Google-Cloud-Dataform-V1beta1-WorkflowInvocationAction-DataPreparationAction) \nReference documentation and code samples for the Dataform V1beta1 API class Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction.\n\nRepresents a workflow action that will run a Data Preparation. \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### #contents_sql\n\n def contents_sql() -\u003e ::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionSqlDefinition\n\n**Returns**\n\n- ([::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionSqlDefinition](./Google-Cloud-Dataform-V1beta1-WorkflowInvocationAction-DataPreparationAction-ActionSqlDefinition)) --- SQL definition for a Data Preparation. Contains a SQL query and additional context information.\n\n\n Note: The following fields are mutually exclusive: `contents_sql`, `contents_yaml`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #contents_sql=\n\n def contents_sql=(value) -\u003e ::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionSqlDefinition\n\n**Parameter**\n\n- **value** ([::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionSqlDefinition](./Google-Cloud-Dataform-V1beta1-WorkflowInvocationAction-DataPreparationAction-ActionSqlDefinition)) --- SQL definition for a Data Preparation. Contains a SQL query and additional context information.\n\n\nNote: The following fields are mutually exclusive: `contents_sql`, `contents_yaml`. If a field in that set is populated, all other fields in the set will automatically be cleared. \n**Returns**\n\n- ([::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionSqlDefinition](./Google-Cloud-Dataform-V1beta1-WorkflowInvocationAction-DataPreparationAction-ActionSqlDefinition)) --- SQL definition for a Data Preparation. Contains a SQL query and additional context information.\n\n\n Note: The following fields are mutually exclusive: `contents_sql`, `contents_yaml`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #contents_yaml\n\n def contents_yaml() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Output only. YAML representing the contents of the data preparation. Can be used to show the customer what the input was to their workflow.\n\n Note: The following fields are mutually exclusive: `contents_yaml`, `contents_sql`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #generated_sql\n\n def generated_sql() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Output only. The generated BigQuery SQL script that will be executed. For reference only.\n\n### #job_id\n\n def job_id() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Output only. The ID of the BigQuery job that executed the SQL in sql_script. Only set once the job has started to run."]]
