Google Cloud Dataform V1beta1 Client - Class WorkflowInvocationAction (0.2.3)

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

Represents a single action in a workflow invocation.

Generated from protobuf message google.cloud.dataform.v1beta1.WorkflowInvocationAction

Namespace

Google \ Cloud \ Dataform \ V1beta1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ target Google\Cloud\Dataform\V1beta1\Target

Output only. This action's identifier. Unique within the workflow invocation.

↳ canonical_target Google\Cloud\Dataform\V1beta1\Target

Output only. The action's identifier if the project had been compiled without any overrides configured. Unique within the compilation result.

↳ state int

Output only. This action's current state.

↳ failure_reason string

Output only. If and only if action's state is FAILED a failure reason is set.

↳ invocation_timing 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.

↳ bigquery_action Google\Cloud\Dataform\V1beta1\WorkflowInvocationAction\BigQueryAction

Output only. The workflow action's bigquery action details.

getTarget

Output only. This action's identifier. Unique within the workflow invocation.

Returns
TypeDescription
Google\Cloud\Dataform\V1beta1\Target|null

hasTarget

clearTarget

setTarget

Output only. This action's identifier. Unique within the workflow invocation.

Parameter
NameDescription
var Google\Cloud\Dataform\V1beta1\Target
Returns
TypeDescription
$this

getCanonicalTarget

Output only. The action's identifier if the project had been compiled without any overrides configured. Unique within the compilation result.

Returns
TypeDescription
Google\Cloud\Dataform\V1beta1\Target|null

hasCanonicalTarget

clearCanonicalTarget

setCanonicalTarget

Output only. The action's identifier if the project had been compiled without any overrides configured. Unique within the compilation result.

Parameter
NameDescription
var Google\Cloud\Dataform\V1beta1\Target
Returns
TypeDescription
$this

getState

Output only. This action's current state.

Returns
TypeDescription
int

setState

Output only. This action's current state.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getFailureReason

Output only. If and only if action's state is FAILED a failure reason is set.

Returns
TypeDescription
string

setFailureReason

Output only. If and only if action's state is FAILED a failure reason is set.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getInvocationTiming

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.

Returns
TypeDescription
Google\Type\Interval|null

hasInvocationTiming

clearInvocationTiming

setInvocationTiming

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.

Parameter
NameDescription
var Google\Type\Interval
Returns
TypeDescription
$this

getBigqueryAction

Output only. The workflow action's bigquery action details.

Returns
TypeDescription
Google\Cloud\Dataform\V1beta1\WorkflowInvocationAction\BigQueryAction|null

hasBigqueryAction

clearBigqueryAction

setBigqueryAction

Output only. The workflow action's bigquery action details.

Parameter
NameDescription
var Google\Cloud\Dataform\V1beta1\WorkflowInvocationAction\BigQueryAction
Returns
TypeDescription
$this