Reference documentation and code samples for the Google Cloud Dataform V1beta1 Client class DataPreparationAction.
Represents a workflow action that will run a Data Preparation.
Generated from protobuf message google.cloud.dataform.v1beta1.WorkflowInvocationAction.DataPreparationAction
Namespace
Google \ Cloud \ Dataform \ V1beta1 \ WorkflowInvocationActionMethods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ contents_yaml |
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. |
↳ contents_sql |
DataPreparationAction\ActionSqlDefinition
SQL definition for a Data Preparation. Contains a SQL query and additional context information. |
↳ generated_sql |
string
Output only. The generated BigQuery SQL script that will be executed. For reference only. |
↳ job_id |
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. |
getContentsYaml
Output only. YAML representing the contents of the data preparation.
Can be used to show the customer what the input was to their workflow.
Returns | |
---|---|
Type | Description |
string |
hasContentsYaml
setContentsYaml
Output only. YAML representing the contents of the data preparation.
Can be used to show the customer what the input was to their workflow.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getContentsSql
SQL definition for a Data Preparation. Contains a SQL query and additional context information.
Returns | |
---|---|
Type | Description |
DataPreparationAction\ActionSqlDefinition|null |
hasContentsSql
setContentsSql
SQL definition for a Data Preparation. Contains a SQL query and additional context information.
Parameter | |
---|---|
Name | Description |
var |
DataPreparationAction\ActionSqlDefinition
|
Returns | |
---|---|
Type | Description |
$this |
getGeneratedSql
Output only. The generated BigQuery SQL script that will be executed. For reference only.
Returns | |
---|---|
Type | Description |
string |
setGeneratedSql
Output only. The generated BigQuery SQL script that will be executed. For reference only.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getJobId
Output only. The ID of the BigQuery job that executed the SQL in sql_script. Only set once the job has started to run.
Returns | |
---|---|
Type | Description |
string |
setJobId
Output only. The ID of the BigQuery job that executed the SQL in sql_script. Only set once the job has started to run.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getDefinition
Returns | |
---|---|
Type | Description |
string |