Send feedback
Class WorkflowTemplate (5.21.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version latestkeyboard_arrow_down
WorkflowTemplate ( mapping = None , * , ignore_unknown_fields = False , ** kwargs )
A Dataproc workflow template resource.
Attributes
Name
Description
name
str
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
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.
create_time
google.protobuf.timestamp_pb2.Timestamp
Output only. The time template was created.
update_time
google.protobuf.timestamp_pb2.Timestamp
Output only. The time template was last
updated.
labels
MutableMapping[str, str]
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
placement
google.cloud.dataproc_v1.types.WorkflowTemplatePlacement
Required. WorkflowTemplate scheduling
information.
jobs
MutableSequence[google.cloud.dataproc_v1.types.OrderedJob ]
Required. The Directed Acyclic Graph of Jobs
to submit.
parameters
MutableSequence[google.cloud.dataproc_v1.types.TemplateParameter ]
Optional. Template parameters whose values
are substituted into the template. Values for
parameters must be provided when the template is
instantiated.
dag_timeout
google.protobuf.duration_pb2.Duration
Optional. Timeout duration for the DAG of jobs, expressed in
seconds (see `JSON representation of
duration
encryption_config
google.cloud.dataproc_v1.types.WorkflowTemplate.EncryptionConfig
Optional. Encryption settings for encrypting
workflow template job arguments.
Classes
EncryptionConfig
EncryptionConfig ( mapping = None , * , ignore_unknown_fields = False , ** kwargs )
Encryption settings for encrypting workflow template job
arguments.
LabelsEntry
LabelsEntry ( mapping = None , * , ignore_unknown_fields = False , ** kwargs )
The abstract base class for a message.
Parameters
Name
Description
kwargs
dict
Keys and values corresponding to the fields of the message.
mapping
Union[dict, .Message
]
A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields
Optional(bool)
If True, do not raise errors for unknown fields. Only applied if mapping
is a mapping type or there are keyword parameters.
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-07 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[],[],null,["# Class WorkflowTemplate (5.21.0)\n\nVersion latestkeyboard_arrow_down\n\n- [5.21.0 (latest)](/python/docs/reference/dataproc/latest/google.cloud.dataproc_v1.types.WorkflowTemplate)\n- [5.20.0](/python/docs/reference/dataproc/5.20.0/google.cloud.dataproc_v1.types.WorkflowTemplate)\n- [5.18.1](/python/docs/reference/dataproc/5.18.1/google.cloud.dataproc_v1.types.WorkflowTemplate)\n- [5.17.1](/python/docs/reference/dataproc/5.17.1/google.cloud.dataproc_v1.types.WorkflowTemplate)\n- [5.16.0](/python/docs/reference/dataproc/5.16.0/google.cloud.dataproc_v1.types.WorkflowTemplate)\n- [5.15.1](/python/docs/reference/dataproc/5.15.1/google.cloud.dataproc_v1.types.WorkflowTemplate)\n- [5.14.0](/python/docs/reference/dataproc/5.14.0/google.cloud.dataproc_v1.types.WorkflowTemplate)\n- [5.13.0](/python/docs/reference/dataproc/5.13.0/google.cloud.dataproc_v1.types.WorkflowTemplate)\n- [5.12.0](/python/docs/reference/dataproc/5.12.0/google.cloud.dataproc_v1.types.WorkflowTemplate)\n- [5.10.2](/python/docs/reference/dataproc/5.10.2/google.cloud.dataproc_v1.types.WorkflowTemplate)\n- [5.9.3](/python/docs/reference/dataproc/5.9.3/google.cloud.dataproc_v1.types.WorkflowTemplate)\n- [5.8.0](/python/docs/reference/dataproc/5.8.0/google.cloud.dataproc_v1.types.WorkflowTemplate)\n- [5.7.0](/python/docs/reference/dataproc/5.7.0/google.cloud.dataproc_v1.types.WorkflowTemplate)\n- [5.6.0](/python/docs/reference/dataproc/5.6.0/google.cloud.dataproc_v1.types.WorkflowTemplate)\n- [5.5.1](/python/docs/reference/dataproc/5.5.1/google.cloud.dataproc_v1.types.WorkflowTemplate)\n- [5.4.3](/python/docs/reference/dataproc/5.4.3/google.cloud.dataproc_v1.types.WorkflowTemplate)\n- [5.3.0](/python/docs/reference/dataproc/5.3.0/google.cloud.dataproc_v1.types.WorkflowTemplate)\n- [5.2.0](/python/docs/reference/dataproc/5.2.0/google.cloud.dataproc_v1.types.WorkflowTemplate)\n- [5.1.0](/python/docs/reference/dataproc/5.1.0/google.cloud.dataproc_v1.types.WorkflowTemplate)\n- [5.0.3](/python/docs/reference/dataproc/5.0.3/google.cloud.dataproc_v1.types.WorkflowTemplate)\n- [4.0.3](/python/docs/reference/dataproc/4.0.3/google.cloud.dataproc_v1.types.WorkflowTemplate)\n- [3.3.2](/python/docs/reference/dataproc/3.3.2/google.cloud.dataproc_v1.types.WorkflowTemplate)\n- [3.2.0](/python/docs/reference/dataproc/3.2.0/google.cloud.dataproc_v1.types.WorkflowTemplate)\n- [3.1.1](/python/docs/reference/dataproc/3.1.1/google.cloud.dataproc_v1.types.WorkflowTemplate)\n- [3.0.0](/python/docs/reference/dataproc/3.0.0/google.cloud.dataproc_v1.types.WorkflowTemplate)\n- [2.6.2](/python/docs/reference/dataproc/2.6.2/google.cloud.dataproc_v1.types.WorkflowTemplate)\n- [2.5.0](/python/docs/reference/dataproc/2.5.0/google.cloud.dataproc_v1.types.WorkflowTemplate)\n- [2.4.0](/python/docs/reference/dataproc/2.4.0/google.cloud.dataproc_v1.types.WorkflowTemplate)\n- [2.3.1](/python/docs/reference/dataproc/2.3.1/google.cloud.dataproc_v1.types.WorkflowTemplate)\n- [2.2.0](/python/docs/reference/dataproc/2.2.0/google.cloud.dataproc_v1.types.WorkflowTemplate)\n- [2.0.2](/python/docs/reference/dataproc/2.0.2/google.cloud.dataproc_v1.types.WorkflowTemplate)\n- [1.1.3](/python/docs/reference/dataproc/1.1.3/google.cloud.dataproc_v1.types.WorkflowTemplate)\n- [1.0.1](/python/docs/reference/dataproc/1.0.1/google.cloud.dataproc_v1.types.WorkflowTemplate)\n- [0.8.2](/python/docs/reference/dataproc/0.8.2/google.cloud.dataproc_v1.types.WorkflowTemplate)\n- [0.7.0](/python/docs/reference/dataproc/0.7.0/google.cloud.dataproc_v1.types.WorkflowTemplate)\n- [0.6.1](/python/docs/reference/dataproc/0.6.1/google.cloud.dataproc_v1.types.WorkflowTemplate)\n- [0.5.0](/python/docs/reference/dataproc/0.5.0/google.cloud.dataproc_v1.types.WorkflowTemplate) \n\n WorkflowTemplate(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nA Dataproc workflow template resource.\n\nClasses\n-------\n\n### EncryptionConfig\n\n EncryptionConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nEncryption settings for encrypting workflow template job\narguments.\n\n### LabelsEntry\n\n LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nThe abstract base class for a message."]]