Google Cloud Dataproc V1 Client - Class WorkflowMetadata (3.2.2)

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

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`	`Google\Cloud\Dataproc\V1\ClusterOperation` Output only. The create cluster operation metadata.
`↳ graph`	`Google\Cloud\Dataproc\V1\WorkflowGraph` Output only. The workflow graph.
`↳ delete_cluster`	`Google\Cloud\Dataproc\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\|Google\Protobuf\Internal\MapField` Map from parameter names to values that were used for those parameters.
`↳ start_time`	`Google\Protobuf\Timestamp` Output only. Workflow start time.
`↳ end_time`	`Google\Protobuf\Timestamp` Output only. Workflow end time.
`↳ cluster_uuid`	`string` Output only. The UUID of target cluster.
`↳ dag_timeout`	`Google\Protobuf\Duration` Output only. The timeout duration for the DAG of jobs, expressed in seconds (see JSON representation of duration).
`↳ dag_start_time`	`Google\Protobuf\Timestamp` Output only. DAG start time, only set for workflows with dag_timeout when DAG begins.
`↳ dag_end_time`	`Google\Protobuf\Timestamp` Output only. DAG end time, only set for workflows with dag_timeout 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}

Generated from protobuf field string template = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

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}

Generated from protobuf field string template = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getVersion

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

Generated from protobuf field int32 version = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`int`

setVersion

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

Generated from protobuf field int32 version = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getCreateCluster

Output only. The create cluster operation metadata.

Generated from protobuf field .google.cloud.dataproc.v1.ClusterOperation create_cluster = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Google\Cloud\Dataproc\V1\ClusterOperation\|null`

hasCreateCluster

clearCreateCluster

setCreateCluster

Output only. The create cluster operation metadata.

Generated from protobuf field .google.cloud.dataproc.v1.ClusterOperation create_cluster = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`var`	`Google\Cloud\Dataproc\V1\ClusterOperation`

Returns
Type	Description
`$this`

getGraph

Output only. The workflow graph.

Generated from protobuf field .google.cloud.dataproc.v1.WorkflowGraph graph = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Google\Cloud\Dataproc\V1\WorkflowGraph\|null`

hasGraph

clearGraph

setGraph

Output only. The workflow graph.

Generated from protobuf field .google.cloud.dataproc.v1.WorkflowGraph graph = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`var`	`Google\Cloud\Dataproc\V1\WorkflowGraph`

Returns
Type	Description
`$this`

getDeleteCluster

Output only. The delete cluster operation metadata.

Generated from protobuf field .google.cloud.dataproc.v1.ClusterOperation delete_cluster = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Google\Cloud\Dataproc\V1\ClusterOperation\|null`

hasDeleteCluster

clearDeleteCluster

setDeleteCluster

Output only. The delete cluster operation metadata.

Generated from protobuf field .google.cloud.dataproc.v1.ClusterOperation delete_cluster = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`var`	`Google\Cloud\Dataproc\V1\ClusterOperation`

Returns
Type	Description
`$this`

getState

Output only. The workflow state.

Generated from protobuf field .google.cloud.dataproc.v1.WorkflowMetadata.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`int`

setState

Output only. The workflow state.

Generated from protobuf field .google.cloud.dataproc.v1.WorkflowMetadata.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getClusterName

Output only. The name of the target cluster.

Generated from protobuf field string cluster_name = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`string`

setClusterName

Output only. The name of the target cluster.

Generated from protobuf field string cluster_name = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getParameters

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

Generated from protobuf field map<string, string> parameters = 8;

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setParameters

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

Generated from protobuf field map<string, string> parameters = 8;

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getStartTime

Output only. Workflow start time.

Generated from protobuf field .google.protobuf.Timestamp start_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasStartTime

clearStartTime

setStartTime

Output only. Workflow start time.

Generated from protobuf field .google.protobuf.Timestamp start_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getEndTime

Output only. Workflow end time.

Generated from protobuf field .google.protobuf.Timestamp end_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasEndTime

clearEndTime

setEndTime

Output only. Workflow end time.

Generated from protobuf field .google.protobuf.Timestamp end_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getClusterUuid

Output only. The UUID of target cluster.

Generated from protobuf field string cluster_uuid = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`string`

setClusterUuid

Output only. The UUID of target cluster.

Generated from protobuf field string cluster_uuid = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

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).

Generated from protobuf field .google.protobuf.Duration dag_timeout = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`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).

Generated from protobuf field .google.protobuf.Duration dag_timeout = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`var`	`Google\Protobuf\Duration`

Returns
Type	Description
`$this`

getDagStartTime

Output only. DAG start time, only set for workflows with dag_timeout when DAG begins.

Generated from protobuf field .google.protobuf.Timestamp dag_start_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasDagStartTime

clearDagStartTime

setDagStartTime

Output only. DAG start time, only set for workflows with dag_timeout when DAG begins.

Generated from protobuf field .google.protobuf.Timestamp dag_start_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getDagEndTime

Output only. DAG end time, only set for workflows with dag_timeout when DAG ends.

Generated from protobuf field .google.protobuf.Timestamp dag_end_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasDagEndTime

clearDagEndTime

setDagEndTime

Output only. DAG end time, only set for workflows with dag_timeout when DAG ends.

Generated from protobuf field .google.protobuf.Timestamp dag_end_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`