WorkflowTemplate (Cloud Dataproc API v1beta2-rev20210825-1.32.1)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.dataproc.v1beta2.model.WorkflowTemplate

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class WorkflowTemplate
extends GenericJson
```
A Dataproc workflow template resource.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Dataproc API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

WorkflowTemplate()

Constructors
Constructor and Description
`WorkflowTemplate()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WorkflowTemplate`	`clone()`
`String`	`getCreateTime()` Output only.
`String`	`getDagTimeout()` Optional.
`String`	`getId()` Required.
`List<OrderedJob>`	`getJobs()` Required.
`Map<String,String>`	`getLabels()` Optional.
`String`	`getName()` Output only.
`List<TemplateParameter>`	`getParameters()` Optional.
`WorkflowTemplatePlacement`	`getPlacement()` Required.
`String`	`getUpdateTime()` Output only.
`Integer`	`getVersion()` Optional.
`WorkflowTemplate`	`set(String fieldName, Object value)`
`WorkflowTemplate`	`setCreateTime(String createTime)` Output only.
`WorkflowTemplate`	`setDagTimeout(String dagTimeout)` Optional.
`WorkflowTemplate`	`setId(String id)` Required.
`WorkflowTemplate`	`setJobs(List<OrderedJob> jobs)` Required.
`WorkflowTemplate`	`setLabels(Map<String,String> labels)` Optional.
`WorkflowTemplate`	`setName(String name)` Output only.
`WorkflowTemplate`	`setParameters(List<TemplateParameter> parameters)` Optional.
`WorkflowTemplate`	`setPlacement(WorkflowTemplatePlacement placement)` Required.
`WorkflowTemplate`	`setUpdateTime(String updateTime)` Output only.
`WorkflowTemplate`	`setVersion(Integer version)` Optional.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - WorkflowTemplate
```
public WorkflowTemplate()
```
- Method Detail
  - getCreateTime
```
public String getCreateTime()
```
    Output only. The time template was created.
    
    Returns:
    
    value or null for none
  - setCreateTime
```
public WorkflowTemplate setCreateTime(String createTime)
```
    Output only. The time template was created.
    
    Parameters:
    
    createTime - createTime or null for none
  - getDagTimeout
```
public String getDagTimeout()
```
    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.
    
    Returns:
    
    value or null for none
  - setDagTimeout
```
public WorkflowTemplate setDagTimeout(String dagTimeout)
```
    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.
    
    Parameters:
    
    dagTimeout - dagTimeout or null for none
  - getId
```
public String getId()
```
    Required. The template id.The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of between 3 and 50 characters..
    
    Returns:
    
    value or null for none
  - setId
```
public WorkflowTemplate setId(String id)
```
    Required. The template id.The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of between 3 and 50 characters..
    
    Parameters:
    
    id - id or null for none
  - getJobs
```
public List<OrderedJob> getJobs()
```
    Required. The Directed Acyclic Graph of Jobs to submit.
    
    Returns:
    
    value or null for none
  - setJobs
```
public WorkflowTemplate setJobs(List<OrderedJob> jobs)
```
    Required. The Directed Acyclic Graph of Jobs to submit.
    
    Parameters:
    
    jobs - jobs or null for none
  - getLabels
```
public Map<String,String> getLabels()
```
    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.
    
    Returns:
    
    value or null for none
  - setLabels
```
public WorkflowTemplate setLabels(Map<String,String> labels)
```
    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:
    
    labels - labels or null for none
  - getName
```
public String getName()
```
    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}
    
    Returns:
    
    value or null for none
  - setName
```
public WorkflowTemplate setName(String name)
```
    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}
    
    Parameters:
    
    name - name or null for none
  - getParameters
```
public List<TemplateParameter> getParameters()
```
    Optional. Template parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated.
    
    Returns:
    
    value or null for none
  - setParameters
```
public WorkflowTemplate setParameters(List<TemplateParameter> parameters)
```
    Optional. Template parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated.
    
    Parameters:
    
    parameters - parameters or null for none
  - getPlacement
```
public WorkflowTemplatePlacement getPlacement()
```
    Required. WorkflowTemplate scheduling information.
    
    Returns:
    
    value or null for none
  - setPlacement
```
public WorkflowTemplate setPlacement(WorkflowTemplatePlacement placement)
```
    Required. WorkflowTemplate scheduling information.
    
    Parameters:
    
    placement - placement or null for none
  - getUpdateTime
```
public String getUpdateTime()
```
    Output only. The time template was last updated.
    
    Returns:
    
    value or null for none
  - setUpdateTime
```
public WorkflowTemplate setUpdateTime(String updateTime)
```
    Output only. The time template was last updated.
    
    Parameters:
    
    updateTime - updateTime or null for none
  - getVersion
```
public Integer getVersion()
```
    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.
    
    Returns:
    
    value or null for none
  - setVersion
```
public WorkflowTemplate setVersion(Integer version)
```
    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.
    
    Parameters:
    
    version - version or null for none
  - set
```
public WorkflowTemplate set(String fieldName,
                            Object value)
```
    Overrides:
    
    set in class GenericJson
  - clone
```
public WorkflowTemplate clone()
```
    Overrides:
    
    clone in class GenericJson

Class WorkflowTemplate

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

WorkflowTemplate

Method Detail

getCreateTime

setCreateTime

getDagTimeout

setDagTimeout

getId

setId

getJobs

setJobs

getLabels

setLabels

getName

setName

getParameters

setParameters

getPlacement

setPlacement

getUpdateTime

setUpdateTime

getVersion

setVersion

set

clone