Google Cloud Dataform V1beta1 Client - Class WorkflowInvocationAction (0.9.2)
Beta
This library is covered by thePre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see thelaunch stage descriptions.
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 messagegoogle.cloud.dataform.v1beta1.WorkflowInvocationAction
Namespace
Google \ Cloud \ Dataform \ V1beta1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data | arrayOptional. Data for populating the Message object. |
↳ bigquery_action | WorkflowInvocationAction\BigQueryActionOutput only. The workflow action's bigquery action details. |
↳ notebook_action | WorkflowInvocationAction\NotebookActionOutput only. The workflow action's notebook action details. |
↳ data_preparation_action | WorkflowInvocationAction\DataPreparationActionOutput only. The workflow action's data preparation action details. |
↳ target | TargetOutput only. This action's identifier. Unique within the workflow invocation. |
↳ canonical_target | TargetOutput only. The action's identifier if the project had been compiled without any overrides configured. Unique within the compilation result. |
↳ state | intOutput only. This action's current state. |
↳ failure_reason | stringOutput only. If and only if action's state is FAILED a failure reason is set. |
↳ invocation_timing | Google\Type\IntervalOutput only. This action's timing details. |
↳ internal_metadata | stringOutput 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. |
getBigqueryAction
Output only. The workflow action's bigquery action details.
| Returns | |
|---|---|
| Type | Description |
WorkflowInvocationAction\BigQueryAction|null | |
hasBigqueryAction
setBigqueryAction
Output only. The workflow action's bigquery action details.
| Parameter | |
|---|---|
| Name | Description |
var | WorkflowInvocationAction\BigQueryAction |
| Returns | |
|---|---|
| Type | Description |
$this | |
getNotebookAction
Output only. The workflow action's notebook action details.
| Returns | |
|---|---|
| Type | Description |
WorkflowInvocationAction\NotebookAction|null | |
hasNotebookAction
setNotebookAction
Output only. The workflow action's notebook action details.
| Parameter | |
|---|---|
| Name | Description |
var | WorkflowInvocationAction\NotebookAction |
| Returns | |
|---|---|
| Type | Description |
$this | |
getDataPreparationAction
Output only. The workflow action's data preparation action details.
| Returns | |
|---|---|
| Type | Description |
WorkflowInvocationAction\DataPreparationAction|null | |
hasDataPreparationAction
setDataPreparationAction
Output only. The workflow action's data preparation action details.
| Parameter | |
|---|---|
| Name | Description |
var | WorkflowInvocationAction\DataPreparationAction |
| Returns | |
|---|---|
| Type | Description |
$this | |
getTarget
Output only. This action's identifier. Unique within the workflowinvocation.
| Returns | |
|---|---|
| Type | Description |
Target|null | |
hasTarget
clearTarget
setTarget
Output only. This action's identifier. Unique within the workflowinvocation.
| Parameter | |
|---|---|
| Name | Description |
var | Target |
| Returns | |
|---|---|
| Type | Description |
$this | |
getCanonicalTarget
Output only. The action's identifier if the project had been compiledwithout any overrides configured. Unique within the compilation result.
| Returns | |
|---|---|
| Type | Description |
Target|null | |
hasCanonicalTarget
clearCanonicalTarget
setCanonicalTarget
Output only. The action's identifier if the project had been compiledwithout any overrides configured. Unique within the compilation result.
| Parameter | |
|---|---|
| Name | Description |
var | Target |
| Returns | |
|---|---|
| Type | Description |
$this | |
getState
Output only. This action's current state.
| Returns | |
|---|---|
| Type | Description |
int | Enum of typeState. |
setState
Output only. This action's current state.
| Parameter | |
|---|---|
| Name | Description |
var | intEnum of typeState. |
| Returns | |
|---|---|
| Type | Description |
$this | |
getFailureReason
Output only. If and only if action's state is FAILED a failure reason isset.
| Returns | |
|---|---|
| Type | Description |
string | |
setFailureReason
Output only. If and only if action's state is FAILED a failure reason isset.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var | Google\Type\Interval |
| Returns | |
|---|---|
| Type | Description |
$this | |
getInternalMetadata
Output only. All the metadata information that is used internally to servethe resource. For example: timestamps, flags, status fields, etc. Theformat of this field is a JSON string.
| Returns | |
|---|---|
| Type | Description |
string | |
hasInternalMetadata
clearInternalMetadata
setInternalMetadata
Output only. All the metadata information that is used internally to servethe resource. For example: timestamps, flags, status fields, etc. Theformat of this field is a JSON string.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getAction
| Returns | |
|---|---|
| Type | Description |
string | |
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-01-09 UTC.