# Google Cloud Dataproc V1 Client - Class WorkflowMetadata (3.14.0)

3.14.0 (latest) 3.13.4 3.12.0 3.11.0 3.10.1 3.9.0 3.8.1 3.7.1 3.6.1 3.5.1 3.4.0 3.3.0 3.2.2 2.12.0 2.11.0 2.10.0 2.9.1 2.8.2 2.7.0 2.6.1 2.5.0 2.3.0 2.2.3 2.1.0 2.0.0 Reference documentation and code samples for the Google Cloud Dataproc V1 Client class WorkflowMetadata.

A Dataproc workflow template resource.

Generated from protobuf message `google.cloud.dataproc.v1.WorkflowMetadata`

## Namespace

Google \\ Cloud \\ Dataproc \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ template` | `string` Output only. The resource name of the workflow template as described in <https://cloud.google.com/apis/design/resource_names>. \* For `projects.regions.workflowTemplates`, the resource name of the template has the following format: `projects/{project_id}/regions/{region}/workflowTemplates/{template_id}` \* For `projects.locations.workflowTemplates`, the resource name of the template has the following format: `projects/{project_id}/locations/{location}/workflowTemplates/{template_id}` |
| `↳ version` | `int` Output only. The version of template at the time of workflow instantiation. |
| `↳ create_cluster` | `https://docs.cloud.google.com/php/docs/reference/cloud-dataproc/latest/V1.ClusterOperation` Output only. The create cluster operation metadata. |
| `↳ graph` | `https://docs.cloud.google.com/php/docs/reference/cloud-dataproc/latest/V1.WorkflowGraph` Output only. The workflow graph. |
| `↳ delete_cluster` | `https://docs.cloud.google.com/php/docs/reference/cloud-dataproc/latest/V1.ClusterOperation` Output only. The delete cluster operation metadata. |
| `↳ state` | `int` Output only. The workflow state. |
| `↳ cluster_name` | `string` Output only. The name of the target cluster. |
| `↳ parameters` | `array|https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Internal/MapField` Map from parameter names to values that were used for those parameters. |
| `↳ start_time` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` Output only. Workflow start time. |
| `↳ end_time` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` Output only. Workflow end time. |
| `↳ cluster_uuid` | `string` Output only. The UUID of target cluster. |
| `↳ dag_timeout` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Duration` Output only. The timeout duration for the DAG of jobs, expressed in seconds (see [JSON representation of duration](https://developers.google.com/protocol-buffers/docs/proto3#json)). |
| `↳ dag_start_time` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` Output only. DAG start time, only set for workflows with [dag_timeout](https://docs.cloud.google.com/php/docs/reference/cloud-dataproc/latest/V1.WorkflowMetadata#_Google_Cloud_Dataproc_V1_WorkflowMetadata__getDagTimeout__) when DAG begins. |
| `↳ dag_end_time` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` Output only. DAG end time, only set for workflows with [dag_timeout](https://docs.cloud.google.com/php/docs/reference/cloud-dataproc/latest/V1.WorkflowMetadata#_Google_Cloud_Dataproc_V1_WorkflowMetadata__getDagTimeout__) when DAG ends. |

### getTemplate

Output only. The resource name of the workflow template as described
in <https://cloud.google.com/apis/design/resource_names>.

- For `projects.regions.workflowTemplates`, the resource name of the template has the following format: `projects/{project_id}/regions/{region}/workflowTemplates/{template_id}`
- For `projects.locations.workflowTemplates`, the resource name of the template has the following format: `projects/{project_id}/locations/{location}/workflowTemplates/{template_id}`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setTemplate

Output only. The resource name of the workflow template as described
in <https://cloud.google.com/apis/design/resource_names>.

- For `projects.regions.workflowTemplates`, the resource name of the template has the following format: `projects/{project_id}/regions/{region}/workflowTemplates/{template_id}`
- For `projects.locations.workflowTemplates`, the resource name of the template has the following format: `projects/{project_id}/locations/{location}/workflowTemplates/{template_id}`

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getVersion

Output only. The version of template at the time of
workflow instantiation.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` |   |

### setVersion

Output only. The version of template at the time of
workflow instantiation.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getCreateCluster

Output only. The create cluster operation metadata.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-dataproc/latest/V1.ClusterOperation|null` |   |

### hasCreateCluster

### clearCreateCluster

### setCreateCluster

Output only. The create cluster operation metadata.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-dataproc/latest/V1.ClusterOperation` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getGraph

Output only. The workflow graph.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-dataproc/latest/V1.WorkflowGraph|null` |   |

### hasGraph

### clearGraph

### setGraph

Output only. The workflow graph.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-dataproc/latest/V1.WorkflowGraph` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getDeleteCluster

Output only. The delete cluster operation metadata.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-dataproc/latest/V1.ClusterOperation|null` |   |

### hasDeleteCluster

### clearDeleteCluster

### setDeleteCluster

Output only. The delete cluster operation metadata.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-dataproc/latest/V1.ClusterOperation` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getState

Output only. The workflow state.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` |   |

### setState

Output only. The workflow state.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getClusterName

Output only. The name of the target cluster.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setClusterName

Output only. The name of the target cluster.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getParameters

Map from parameter names to values that were used for those parameters.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Internal/MapField` |   |

### setParameters

Map from parameter names to values that were used for those parameters.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `array|https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Internal/MapField` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getStartTime

Output only. Workflow start time.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp|null` |   |

### hasStartTime

### clearStartTime

### setStartTime

Output only. Workflow start time.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getEndTime

Output only. Workflow end time.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp|null` |   |

### hasEndTime

### clearEndTime

### setEndTime

Output only. Workflow end time.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getClusterUuid

Output only. The UUID of target cluster.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setClusterUuid

Output only. The UUID of target cluster.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getDagTimeout

Output only. The timeout duration for the DAG of jobs, expressed in seconds
(see [JSON representation of
duration](https://developers.google.com/protocol-buffers/docs/proto3#json)).

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Duration|null` |   |

### hasDagTimeout

### clearDagTimeout

### setDagTimeout

Output only. The timeout duration for the DAG of jobs, expressed in seconds
(see [JSON representation of
duration](https://developers.google.com/protocol-buffers/docs/proto3#json)).

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Duration` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getDagStartTime

Output only. DAG start time, only set for workflows with
[dag_timeout](https://docs.cloud.google.com/php/docs/reference/cloud-dataproc/latest/V1.WorkflowMetadata#_Google_Cloud_Dataproc_V1_WorkflowMetadata__getDagTimeout__) when
DAG begins.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp|null` |   |

### hasDagStartTime

### clearDagStartTime

### setDagStartTime

Output only. DAG start time, only set for workflows with
[dag_timeout](https://docs.cloud.google.com/php/docs/reference/cloud-dataproc/latest/V1.WorkflowMetadata#_Google_Cloud_Dataproc_V1_WorkflowMetadata__getDagTimeout__) when
DAG begins.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getDagEndTime

Output only. DAG end time, only set for workflows with
[dag_timeout](https://docs.cloud.google.com/php/docs/reference/cloud-dataproc/latest/V1.WorkflowMetadata#_Google_Cloud_Dataproc_V1_WorkflowMetadata__getDagTimeout__) when
DAG ends.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp|null` |   |

### hasDagEndTime

### clearDagEndTime

### setDagEndTime

Output only. DAG end time, only set for workflows with
[dag_timeout](https://docs.cloud.google.com/php/docs/reference/cloud-dataproc/latest/V1.WorkflowMetadata#_Google_Cloud_Dataproc_V1_WorkflowMetadata__getDagTimeout__) when
DAG ends.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |