workflow_templates
Creates, updates, deletes, gets or lists a workflow_templates
resource.
Overview
Name | workflow_templates |
Type | Resource |
Id | google.dataproc.workflow_templates |
Fields
The following fields are returned by SELECT
queries:
- projects_regions_workflow_templates_get
- projects_locations_workflow_templates_get
- projects_regions_workflow_templates_list
- projects_locations_workflow_templates_list
Successful response
Name | Datatype | Description |
---|---|---|
id | string | |
name | 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} |
createTime | string (google-datetime) | Output only. The time template was created. |
dagTimeout | string (google-duration) | Optional. Timeout duration for the DAG of jobs, expressed in seconds (see JSON representation of duration (https://developers.google.com/protocol-buffers/docs/proto3#json)). The timeout duration must be from 10 minutes ("600s") to 24 hours ("86400s"). The timer begins when the first job is submitted. If the workflow is running at the end of the timeout period, any remaining jobs are cancelled, the workflow is ended, and if the workflow was running on a managed cluster, the cluster is deleted. |
encryptionConfig | object | Optional. Encryption settings for encrypting workflow template job arguments. (id: GoogleCloudDataprocV1WorkflowTemplateEncryptionConfig) |
jobs | array | Required. The Directed Acyclic Graph of Jobs to submit. |
labels | object | Optional. The labels to associate with this template. These labels will be propagated to all jobs and clusters created by the workflow instance.Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).No more than 32 labels can be associated with a template. |
parameters | array | Optional. Template parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated. |
placement | object | Required. WorkflowTemplate scheduling information. (id: WorkflowTemplatePlacement) |
updateTime | string (google-datetime) | Output only. The time template was last updated. |
version | integer (int32) | Optional. Used to perform a consistent read-modify-write.This field should be left blank for a CreateWorkflowTemplate request. It is required for an UpdateWorkflowTemplate request, and must match the current server version. A typical update template flow would fetch the current template with a GetWorkflowTemplate request, which will return the current template with the version field filled in with the current server version. The user updates other fields in the template, then returns it as part of the UpdateWorkflowTemplate request. |
Successful response
Name | Datatype | Description |
---|---|---|
id | string | |
name | 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} |
createTime | string (google-datetime) | Output only. The time template was created. |
dagTimeout | string (google-duration) | Optional. Timeout duration for the DAG of jobs, expressed in seconds (see JSON representation of duration (https://developers.google.com/protocol-buffers/docs/proto3#json)). The timeout duration must be from 10 minutes ("600s") to 24 hours ("86400s"). The timer begins when the first job is submitted. If the workflow is running at the end of the timeout period, any remaining jobs are cancelled, the workflow is ended, and if the workflow was running on a managed cluster, the cluster is deleted. |
encryptionConfig | object | Optional. Encryption settings for encrypting workflow template job arguments. (id: GoogleCloudDataprocV1WorkflowTemplateEncryptionConfig) |
jobs | array | Required. The Directed Acyclic Graph of Jobs to submit. |
labels | object | Optional. The labels to associate with this template. These labels will be propagated to all jobs and clusters created by the workflow instance.Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).No more than 32 labels can be associated with a template. |
parameters | array | Optional. Template parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated. |
placement | object | Required. WorkflowTemplate scheduling information. (id: WorkflowTemplatePlacement) |
updateTime | string (google-datetime) | Output only. The time template was last updated. |
version | integer (int32) | Optional. Used to perform a consistent read-modify-write.This field should be left blank for a CreateWorkflowTemplate request. It is required for an UpdateWorkflowTemplate request, and must match the current server version. A typical update template flow would fetch the current template with a GetWorkflowTemplate request, which will return the current template with the version field filled in with the current server version. The user updates other fields in the template, then returns it as part of the UpdateWorkflowTemplate request. |
Successful response
Name | Datatype | Description |
---|---|---|
id | string | |
name | 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} |
createTime | string (google-datetime) | Output only. The time template was created. |
dagTimeout | string (google-duration) | Optional. Timeout duration for the DAG of jobs, expressed in seconds (see JSON representation of duration (https://developers.google.com/protocol-buffers/docs/proto3#json)). The timeout duration must be from 10 minutes ("600s") to 24 hours ("86400s"). The timer begins when the first job is submitted. If the workflow is running at the end of the timeout period, any remaining jobs are cancelled, the workflow is ended, and if the workflow was running on a managed cluster, the cluster is deleted. |
encryptionConfig | object | Optional. Encryption settings for encrypting workflow template job arguments. (id: GoogleCloudDataprocV1WorkflowTemplateEncryptionConfig) |
jobs | array | Required. The Directed Acyclic Graph of Jobs to submit. |
labels | object | Optional. The labels to associate with this template. These labels will be propagated to all jobs and clusters created by the workflow instance.Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).No more than 32 labels can be associated with a template. |
parameters | array | Optional. Template parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated. |
placement | object | Required. WorkflowTemplate scheduling information. (id: WorkflowTemplatePlacement) |
updateTime | string (google-datetime) | Output only. The time template was last updated. |
version | integer (int32) | Optional. Used to perform a consistent read-modify-write.This field should be left blank for a CreateWorkflowTemplate request. It is required for an UpdateWorkflowTemplate request, and must match the current server version. A typical update template flow would fetch the current template with a GetWorkflowTemplate request, which will return the current template with the version field filled in with the current server version. The user updates other fields in the template, then returns it as part of the UpdateWorkflowTemplate request. |
Successful response
Name | Datatype | Description |
---|---|---|
id | string | |
name | 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} |
createTime | string (google-datetime) | Output only. The time template was created. |
dagTimeout | string (google-duration) | Optional. Timeout duration for the DAG of jobs, expressed in seconds (see JSON representation of duration (https://developers.google.com/protocol-buffers/docs/proto3#json)). The timeout duration must be from 10 minutes ("600s") to 24 hours ("86400s"). The timer begins when the first job is submitted. If the workflow is running at the end of the timeout period, any remaining jobs are cancelled, the workflow is ended, and if the workflow was running on a managed cluster, the cluster is deleted. |
encryptionConfig | object | Optional. Encryption settings for encrypting workflow template job arguments. (id: GoogleCloudDataprocV1WorkflowTemplateEncryptionConfig) |
jobs | array | Required. The Directed Acyclic Graph of Jobs to submit. |
labels | object | Optional. The labels to associate with this template. These labels will be propagated to all jobs and clusters created by the workflow instance.Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).No more than 32 labels can be associated with a template. |
parameters | array | Optional. Template parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated. |
placement | object | Required. WorkflowTemplate scheduling information. (id: WorkflowTemplatePlacement) |
updateTime | string (google-datetime) | Output only. The time template was last updated. |
version | integer (int32) | Optional. Used to perform a consistent read-modify-write.This field should be left blank for a CreateWorkflowTemplate request. It is required for an UpdateWorkflowTemplate request, and must match the current server version. A typical update template flow would fetch the current template with a GetWorkflowTemplate request, which will return the current template with the version field filled in with the current server version. The user updates other fields in the template, then returns it as part of the UpdateWorkflowTemplate request. |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
projects_regions_workflow_templates_get | select | projectsId , regionsId , workflowTemplatesId | version | Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter. |
projects_locations_workflow_templates_get | select | projectsId , locationsId , workflowTemplatesId | version | Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter. |
projects_regions_workflow_templates_list | select | projectsId , regionsId | pageSize , pageToken | Lists workflows that match the specified filter in the request. |
projects_locations_workflow_templates_list | select | projectsId , locationsId | pageSize , pageToken | Lists workflows that match the specified filter in the request. |
projects_regions_workflow_templates_create | insert | projectsId , regionsId | Creates new workflow template. | |
projects_locations_workflow_templates_create | insert | projectsId , locationsId | Creates new workflow template. | |
projects_regions_workflow_templates_update | replace | projectsId , regionsId , workflowTemplatesId | Updates (replaces) workflow template. The updated template must contain version that matches the current server version. | |
projects_locations_workflow_templates_update | replace | projectsId , locationsId , workflowTemplatesId | Updates (replaces) workflow template. The updated template must contain version that matches the current server version. | |
projects_regions_workflow_templates_delete | delete | projectsId , regionsId , workflowTemplatesId | version | Deletes a workflow template. It does not cancel in-progress workflows. |
projects_locations_workflow_templates_delete | delete | projectsId , locationsId , workflowTemplatesId | version | Deletes a workflow template. It does not cancel in-progress workflows. |
projects_regions_workflow_templates_instantiate | exec | projectsId , regionsId , workflowTemplatesId | Instantiates a template and begins execution.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see Using WorkflowMetadata (https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).On successful completion, Operation.response will be Empty. | |
projects_regions_workflow_templates_instantiate_inline | exec | projectsId , regionsId | requestId | Instantiates a template and begins execution.This method is equivalent to executing the sequence CreateWorkflowTemplate, InstantiateWorkflowTemplate, DeleteWorkflowTemplate.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see Using WorkflowMetadata (https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).On successful completion, Operation.response will be Empty. |
projects_locations_workflow_templates_instantiate | exec | projectsId , locationsId , workflowTemplatesId | Instantiates a template and begins execution.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see Using WorkflowMetadata (https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).On successful completion, Operation.response will be Empty. | |
projects_locations_workflow_templates_instantiate_inline | exec | projectsId , locationsId | requestId | Instantiates a template and begins execution.This method is equivalent to executing the sequence CreateWorkflowTemplate, InstantiateWorkflowTemplate, DeleteWorkflowTemplate.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see Using WorkflowMetadata (https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).On successful completion, Operation.response will be Empty. |
Parameters
Parameters can be passed in the WHERE
clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
Name | Datatype | Description |
---|---|---|
locationsId | string | |
projectsId | string | |
regionsId | string | |
workflowTemplatesId | string | |
pageSize | integer (int32) | |
pageToken | string | |
requestId | string | |
version | integer (int32) |
SELECT
examples
- projects_regions_workflow_templates_get
- projects_locations_workflow_templates_get
- projects_regions_workflow_templates_list
- projects_locations_workflow_templates_list
Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter.
SELECT
id,
name,
createTime,
dagTimeout,
encryptionConfig,
jobs,
labels,
parameters,
placement,
updateTime,
version
FROM google.dataproc.workflow_templates
WHERE projectsId = '{{ projectsId }}' -- required
AND regionsId = '{{ regionsId }}' -- required
AND workflowTemplatesId = '{{ workflowTemplatesId }}' -- required
AND version = '{{ version }}';
Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter.
SELECT
id,
name,
createTime,
dagTimeout,
encryptionConfig,
jobs,
labels,
parameters,
placement,
updateTime,
version
FROM google.dataproc.workflow_templates
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND workflowTemplatesId = '{{ workflowTemplatesId }}' -- required
AND version = '{{ version }}';
Lists workflows that match the specified filter in the request.
SELECT
id,
name,
createTime,
dagTimeout,
encryptionConfig,
jobs,
labels,
parameters,
placement,
updateTime,
version
FROM google.dataproc.workflow_templates
WHERE projectsId = '{{ projectsId }}' -- required
AND regionsId = '{{ regionsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';
Lists workflows that match the specified filter in the request.
SELECT
id,
name,
createTime,
dagTimeout,
encryptionConfig,
jobs,
labels,
parameters,
placement,
updateTime,
version
FROM google.dataproc.workflow_templates
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';
INSERT
examples
- projects_regions_workflow_templates_create
- projects_locations_workflow_templates_create
- Manifest
Creates new workflow template.
INSERT INTO google.dataproc.workflow_templates (
data__id,
data__version,
data__labels,
data__placement,
data__jobs,
data__parameters,
data__dagTimeout,
data__encryptionConfig,
projectsId,
regionsId
)
SELECT
'{{ id }}',
{{ version }},
'{{ labels }}',
'{{ placement }}',
'{{ jobs }}',
'{{ parameters }}',
'{{ dagTimeout }}',
'{{ encryptionConfig }}',
'{{ projectsId }}',
'{{ regionsId }}'
RETURNING
id,
name,
createTime,
dagTimeout,
encryptionConfig,
jobs,
labels,
parameters,
placement,
updateTime,
version
;
Creates new workflow template.
INSERT INTO google.dataproc.workflow_templates (
data__id,
data__version,
data__labels,
data__placement,
data__jobs,
data__parameters,
data__dagTimeout,
data__encryptionConfig,
projectsId,
locationsId
)
SELECT
'{{ id }}',
{{ version }},
'{{ labels }}',
'{{ placement }}',
'{{ jobs }}',
'{{ parameters }}',
'{{ dagTimeout }}',
'{{ encryptionConfig }}',
'{{ projectsId }}',
'{{ locationsId }}'
RETURNING
id,
name,
createTime,
dagTimeout,
encryptionConfig,
jobs,
labels,
parameters,
placement,
updateTime,
version
;
# Description fields are for documentation purposes
- name: workflow_templates
props:
- name: projectsId
value: string
description: Required parameter for the workflow_templates resource.
- name: regionsId
value: string
description: Required parameter for the workflow_templates resource.
- name: locationsId
value: string
description: Required parameter for the workflow_templates resource.
- name: id
value: string
- name: version
value: integer
description: >
Optional. Used to perform a consistent read-modify-write.This field should be left blank for a CreateWorkflowTemplate request. It is required for an UpdateWorkflowTemplate request, and must match the current server version. A typical update template flow would fetch the current template with a GetWorkflowTemplate request, which will return the current template with the version field filled in with the current server version. The user updates other fields in the template, then returns it as part of the UpdateWorkflowTemplate request.
- name: labels
value: object
description: >
Optional. The labels to associate with this template. These labels will be propagated to all jobs and clusters created by the workflow instance.Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).No more than 32 labels can be associated with a template.
- name: placement
value: object
description: >
Required. WorkflowTemplate scheduling information.
- name: jobs
value: array
description: >
Required. The Directed Acyclic Graph of Jobs to submit.
- name: parameters
value: array
description: >
Optional. Template parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated.
- name: dagTimeout
value: string
description: >
Optional. Timeout duration for the DAG of jobs, expressed in seconds (see JSON representation of duration (https://developers.google.com/protocol-buffers/docs/proto3#json)). The timeout duration must be from 10 minutes ("600s") to 24 hours ("86400s"). The timer begins when the first job is submitted. If the workflow is running at the end of the timeout period, any remaining jobs are cancelled, the workflow is ended, and if the workflow was running on a managed cluster, the cluster is deleted.
- name: encryptionConfig
value: object
description: >
Optional. Encryption settings for encrypting workflow template job arguments.
REPLACE
examples
- projects_regions_workflow_templates_update
- projects_locations_workflow_templates_update
Updates (replaces) workflow template. The updated template must contain version that matches the current server version.
REPLACE google.dataproc.workflow_templates
SET
data__id = '{{ id }}',
data__version = {{ version }},
data__labels = '{{ labels }}',
data__placement = '{{ placement }}',
data__jobs = '{{ jobs }}',
data__parameters = '{{ parameters }}',
data__dagTimeout = '{{ dagTimeout }}',
data__encryptionConfig = '{{ encryptionConfig }}'
WHERE
projectsId = '{{ projectsId }}' --required
AND regionsId = '{{ regionsId }}' --required
AND workflowTemplatesId = '{{ workflowTemplatesId }}' --required
RETURNING
id,
name,
createTime,
dagTimeout,
encryptionConfig,
jobs,
labels,
parameters,
placement,
updateTime,
version;
Updates (replaces) workflow template. The updated template must contain version that matches the current server version.
REPLACE google.dataproc.workflow_templates
SET
data__id = '{{ id }}',
data__version = {{ version }},
data__labels = '{{ labels }}',
data__placement = '{{ placement }}',
data__jobs = '{{ jobs }}',
data__parameters = '{{ parameters }}',
data__dagTimeout = '{{ dagTimeout }}',
data__encryptionConfig = '{{ encryptionConfig }}'
WHERE
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND workflowTemplatesId = '{{ workflowTemplatesId }}' --required
RETURNING
id,
name,
createTime,
dagTimeout,
encryptionConfig,
jobs,
labels,
parameters,
placement,
updateTime,
version;
DELETE
examples
- projects_regions_workflow_templates_delete
- projects_locations_workflow_templates_delete
Deletes a workflow template. It does not cancel in-progress workflows.
DELETE FROM google.dataproc.workflow_templates
WHERE projectsId = '{{ projectsId }}' --required
AND regionsId = '{{ regionsId }}' --required
AND workflowTemplatesId = '{{ workflowTemplatesId }}' --required
AND version = '{{ version }}';
Deletes a workflow template. It does not cancel in-progress workflows.
DELETE FROM google.dataproc.workflow_templates
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND workflowTemplatesId = '{{ workflowTemplatesId }}' --required
AND version = '{{ version }}';
Lifecycle Methods
- projects_regions_workflow_templates_instantiate
- projects_regions_workflow_templates_instantiate_inline
- projects_locations_workflow_templates_instantiate
- projects_locations_workflow_templates_instantiate_inline
Instantiates a template and begins execution.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see Using WorkflowMetadata (https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).On successful completion, Operation.response will be Empty.
EXEC google.dataproc.workflow_templates.projects_regions_workflow_templates_instantiate
@projectsId='{{ projectsId }}' --required,
@regionsId='{{ regionsId }}' --required,
@workflowTemplatesId='{{ workflowTemplatesId }}' --required
@@json=
'{
"version": {{ version }},
"requestId": "{{ requestId }}",
"parameters": "{{ parameters }}"
}';
Instantiates a template and begins execution.This method is equivalent to executing the sequence CreateWorkflowTemplate, InstantiateWorkflowTemplate, DeleteWorkflowTemplate.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see Using WorkflowMetadata (https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).On successful completion, Operation.response will be Empty.
EXEC google.dataproc.workflow_templates.projects_regions_workflow_templates_instantiate_inline
@projectsId='{{ projectsId }}' --required,
@regionsId='{{ regionsId }}' --required,
@requestId='{{ requestId }}'
@@json=
'{
"id": "{{ id }}",
"version": {{ version }},
"labels": "{{ labels }}",
"placement": "{{ placement }}",
"jobs": "{{ jobs }}",
"parameters": "{{ parameters }}",
"dagTimeout": "{{ dagTimeout }}",
"encryptionConfig": "{{ encryptionConfig }}"
}';
Instantiates a template and begins execution.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see Using WorkflowMetadata (https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).On successful completion, Operation.response will be Empty.
EXEC google.dataproc.workflow_templates.projects_locations_workflow_templates_instantiate
@projectsId='{{ projectsId }}' --required,
@locationsId='{{ locationsId }}' --required,
@workflowTemplatesId='{{ workflowTemplatesId }}' --required
@@json=
'{
"version": {{ version }},
"requestId": "{{ requestId }}",
"parameters": "{{ parameters }}"
}';
Instantiates a template and begins execution.This method is equivalent to executing the sequence CreateWorkflowTemplate, InstantiateWorkflowTemplate, DeleteWorkflowTemplate.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see Using WorkflowMetadata (https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).On successful completion, Operation.response will be Empty.
EXEC google.dataproc.workflow_templates.projects_locations_workflow_templates_instantiate_inline
@projectsId='{{ projectsId }}' --required,
@locationsId='{{ locationsId }}' --required,
@requestId='{{ requestId }}'
@@json=
'{
"id": "{{ id }}",
"version": {{ version }},
"labels": "{{ labels }}",
"placement": "{{ placement }}",
"jobs": "{{ jobs }}",
"parameters": "{{ parameters }}",
"dagTimeout": "{{ dagTimeout }}",
"encryptionConfig": "{{ encryptionConfig }}"
}';