Class WorkflowTemplate (5.16.0)

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.