Show / Hide Table of Contents

Class WorkflowTemplate

A Dataproc workflow template resource.

Inheritance
object
WorkflowTemplate
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Dataproc.v1.Data
Assembly: Google.Apis.Dataproc.v1.dll
Syntax
public class WorkflowTemplate : IDirectResponseSchema

Properties

CreateTime

object representation of CreateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }
Property Value
Type Description
object

CreateTimeDateTimeOffset

DateTimeOffset representation of CreateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

CreateTimeRaw

Output only. The time template was created.

Declaration
[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }
Property Value
Type Description
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.

Declaration
[JsonProperty("dagTimeout")]
public virtual object DagTimeout { get; set; }
Property Value
Type Description
object

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

EncryptionConfig

Optional. Encryption settings for encrypting workflow template job arguments.

Declaration
[JsonProperty("encryptionConfig")]
public virtual GoogleCloudDataprocV1WorkflowTemplateEncryptionConfig EncryptionConfig { get; set; }
Property Value
Type Description
GoogleCloudDataprocV1WorkflowTemplateEncryptionConfig

Id

Declaration
[JsonProperty("id")]
public virtual string Id { get; set; }
Property Value
Type Description
string

Jobs

Required. The Directed Acyclic Graph of Jobs to submit.

Declaration
[JsonProperty("jobs")]
public virtual IList<OrderedJob> Jobs { get; set; }
Property Value
Type Description
IList<OrderedJob>

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.

Declaration
[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }
Property Value
Type Description
IDictionary<string, 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}

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

Parameters

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

Declaration
[JsonProperty("parameters")]
public virtual IList<TemplateParameter> Parameters { get; set; }
Property Value
Type Description
IList<TemplateParameter>

Placement

Required. WorkflowTemplate scheduling information.

Declaration
[JsonProperty("placement")]
public virtual WorkflowTemplatePlacement Placement { get; set; }
Property Value
Type Description
WorkflowTemplatePlacement

UpdateTime

object representation of UpdateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use UpdateTimeDateTimeOffset instead.")]
public virtual object UpdateTime { get; set; }
Property Value
Type Description
object

UpdateTimeDateTimeOffset

DateTimeOffset representation of UpdateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? UpdateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

UpdateTimeRaw

Output only. The time template was last updated.

Declaration
[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }
Property Value
Type Description
string

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.

Declaration
[JsonProperty("version")]
public virtual int? Version { get; set; }
Property Value
Type Description
int?

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX