Google Cloud Dataform V1beta1 Client - Class DataPreparation (0.8.0)

Reference documentation and code samples for the Google Cloud Dataform V1beta1 Client class DataPreparation.

Defines a compiled Data Preparation entity

Generated from protobuf message google.cloud.dataform.v1beta1.CompilationResultAction.DataPreparation

Namespace

Google \ Cloud \ Dataform \ V1beta1 \ CompilationResultAction

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ contents_yaml string

The data preparation definition, stored as a YAML string.

↳ contents_sql DataPreparation\SqlDefinition

SQL definition for a Data Preparation. Contains a SQL query and additional context information.

↳ dependency_targets array<Google\Cloud\Dataform\V1beta1\Target>

A list of actions that this action depends on.

↳ disabled bool

Whether this action is disabled (i.e. should not be run).

↳ tags array

Arbitrary, user-defined tags on this action.

getContentsYaml

The data preparation definition, stored as a YAML string.

Returns
Type Description
string

hasContentsYaml

setContentsYaml

The data preparation definition, stored as a YAML string.

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
DataPreparation\SqlDefinition|null

hasContentsSql

setContentsSql

SQL definition for a Data Preparation. Contains a SQL query and additional context information.

Parameter
Name Description
var DataPreparation\SqlDefinition
Returns
Type Description
$this

getDependencyTargets

A list of actions that this action depends on.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setDependencyTargets

A list of actions that this action depends on.

Parameter
Name Description
var array<Google\Cloud\Dataform\V1beta1\Target>
Returns
Type Description
$this

getDisabled

Whether this action is disabled (i.e. should not be run).

Returns
Type Description
bool

setDisabled

Whether this action is disabled (i.e. should not be run).

Parameter
Name Description
var bool
Returns
Type Description
$this

getTags

Arbitrary, user-defined tags on this action.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setTags

Arbitrary, user-defined tags on this action.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getDefinition

Returns
Type Description
string