Google Cloud Dataproc v1 API - Class InstantiateWorkflowTemplateRequest (5.8.0)

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

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

A request to instantiate a workflow template.

Inheritance

object > InstantiateWorkflowTemplateRequest

Namespace

Google.Cloud.Dataproc.V1

Assembly

Google.Cloud.Dataproc.V1.dll

Constructors

InstantiateWorkflowTemplateRequest()

public InstantiateWorkflowTemplateRequest()

InstantiateWorkflowTemplateRequest(InstantiateWorkflowTemplateRequest)

public InstantiateWorkflowTemplateRequest(InstantiateWorkflowTemplateRequest other)
Parameter
NameDescription
otherInstantiateWorkflowTemplateRequest

Properties

Name

public string Name { get; set; }

Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names.

  • For projects.regions.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id}

  • For projects.locations.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}

Property Value
TypeDescription
string

Parameters

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

Optional. Map from parameter names to values that should be used for those parameters. Values may not exceed 1000 characters.

Property Value
TypeDescription
MapFieldstringstring

RequestId

public string RequestId { get; set; }

Optional. A tag that prevents multiple concurrent workflow instances with the same tag from running. This mitigates risk of concurrent instances started due to retries.

It is recommended to always set this value to a UUID.

The tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.

Property Value
TypeDescription
string

Version

public int Version { get; set; }

Optional. The version of workflow template to instantiate. If specified, the workflow will be instantiated only if the current version of the workflow template has the supplied version.

This option cannot be used to instantiate a previous version of workflow template.

Property Value
TypeDescription
int

WorkflowTemplateName

public WorkflowTemplateName WorkflowTemplateName { get; set; }

WorkflowTemplateName-typed view over the Name resource name property.

Property Value
TypeDescription
WorkflowTemplateName