Google Cloud Dataproc v1 API - Class WorkflowTemplate (5.4.0)

public sealed class WorkflowTemplate : IMessage<WorkflowTemplate>, IEquatable<WorkflowTemplate>, IDeepCloneable<WorkflowTemplate>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud Dataproc v1 API class WorkflowTemplate.

A Dataproc workflow template resource.

Inheritance

Object > WorkflowTemplate

Implements

IMessage<WorkflowTemplate>, IEquatable<WorkflowTemplate>, IDeepCloneable<WorkflowTemplate>, IBufferMessage, IMessage

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Dataproc.V1

Assembly

Google.Cloud.Dataproc.V1.dll

Constructors

WorkflowTemplate()

public WorkflowTemplate()

WorkflowTemplate(WorkflowTemplate)

public WorkflowTemplate(WorkflowTemplate other)

Parameter
Name	Description
`other`	`WorkflowTemplate`

Properties

CreateTime

public Timestamp CreateTime { get; set; }

Output only. The time template was created.

Property Value
Type	Description
`Timestamp`

DagTimeout

public Duration DagTimeout { get; set; }

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.

Property Value
Type	Description
`Duration`

Id

public string Id { get; set; }

Property Value
Type	Description
`String`

Jobs

public RepeatedField<OrderedJob> Jobs { get; }

Required. The Directed Acyclic Graph of Jobs to submit.

Property Value
Type	Description
`RepeatedField<OrderedJob>`

Labels

public MapField<string, string> Labels { get; }

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.

Label values may 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.

Property Value
Type	Description
`MapField<String, String>`

Name

public string Name { get; set; }

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}

Property Value
Type	Description
`String`

Parameters

public RepeatedField<TemplateParameter> Parameters { get; }

Optional. Template parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated.

Property Value
Type	Description
`RepeatedField<TemplateParameter>`

Placement

public WorkflowTemplatePlacement Placement { get; set; }

Required. WorkflowTemplate scheduling information.

Property Value
Type	Description
`WorkflowTemplatePlacement`

UpdateTime

public Timestamp UpdateTime { get; set; }

Output only. The time template was last updated.

Property Value
Type	Description
`Timestamp`

Version

public int Version { get; set; }

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.

Property Value
Type	Description
`Int32`

WorkflowTemplateName

public WorkflowTemplateName WorkflowTemplateName { get; set; }

WorkflowTemplateName-typed view over the Name resource name property.

Property Value
Type	Description
`WorkflowTemplateName`