Resource: WorkflowTemplate
A Dataproc workflow template resource.
| JSON representation |
|---|
{ "id" : string , "name" : string , "version" : integer , "createTime" : string , "updateTime" : string , "labels" : { string : string , ... } , "placement" : { object ( |
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/{projectId}/regions/{region}/workflowTemplates/{template_id} -
For
projects.locations.workflowTemplates, the resource name of the template has the following format:projects/{projectId}/locations/{location}/workflowTemplates/{template_id}
version
integer
Optional. Used to perform a consistent read-modify-write.
This field should be left blank for a workflowTemplates.create
request. It is required for an workflowTemplates.update
request, and must match the current server version. A typical update template flow would fetch the current template with a workflowTemplates.get
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 workflowTemplates.update
request.
createTime
string (
Timestamp
format)
Output only. The time template was created.
Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z"
, "2014-10-02T15:01:23.045123456Z"
or "2014-10-02T15:01:23+05:30"
.
updateTime
string (
Timestamp
format)
Output only. The time template was last updated.
Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z"
, "2014-10-02T15:01:23.045123456Z"
or "2014-10-02T15:01:23+05:30"
.
labels
map (key: string, value: string)
Optional. The labels to associate with this template. These labels will be propagated to all jobs and clusters created by the workflow instance.
Label keysmust contain 1 to 63 characters, and must conform to RFC 1035 .
Label valuesmay be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 .
No more than 32 labels can be associated with a template.
An object containing a list of "key": value
pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }
.
placement
object (
WorkflowTemplatePlacement
)
Required. WorkflowTemplate scheduling information.
jobs[]
object (
OrderedJob
)
Required. The Directed Acyclic Graph of Jobs to submit.
parameters[]
object (
TemplateParameter
)
Optional. Template parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated.
dagTimeout
string (
Duration
format)
Optional. Timeout duration for the DAG of jobs, expressed in seconds (see JSON representation of duration ). 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 (
EncryptionConfig
)
Optional. Encryption settings for encrypting workflow template job arguments.
Methods |
|
|---|---|
|
Creates new workflow template. |
|
Deletes a workflow template. |
|
Retrieves the latest workflow template. |
|
Gets the access control policy for a resource. |
|
Instantiates a template and begins execution. |
|
Instantiates a template and begins execution. |
|
Lists workflows that match the specified filter in the request. |
|
Sets the access control policy on the specified resource. |
|
Returns permissions that a caller has on the specified resource. |
|
Updates (replaces) workflow template. |
