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.
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}
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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[[["\u003cp\u003eThis document provides reference information for the \u003ccode\u003eInstantiateWorkflowTemplateRequest\u003c/code\u003e class within the Google Cloud Dataproc v1 API, including details on its properties, constructors, and inherited members.\u003c/p\u003e\n"],["\u003cp\u003eThe latest version of the \u003ccode\u003eInstantiateWorkflowTemplateRequest\u003c/code\u003e is 5.17.0, and the documentation covers multiple versions down to 3.1.0 for users who might need to utilize an older version.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eInstantiateWorkflowTemplateRequest\u003c/code\u003e is used to send a request to instantiate a workflow template, with options to specify the workflow template's name, parameters, request ID, and version.\u003c/p\u003e\n"],["\u003cp\u003eThe class implements interfaces such as \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable\u003c/code\u003e, \u003ccode\u003eIDeepCloneable\u003c/code\u003e, and \u003ccode\u003eIBufferMessage\u003c/code\u003e, indicating its capabilities for message handling, comparison, deep cloning, and buffering.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eName\u003c/code\u003e property is a required string representing the resource name of the workflow template and can be viewed through the \u003ccode\u003eWorkflowTemplateName\u003c/code\u003e type.\u003c/p\u003e\n"]]],[],null,["# Google Cloud Dataproc v1 API - Class InstantiateWorkflowTemplateRequest (5.20.0)\n\nVersion latestkeyboard_arrow_down\n\n- [5.20.0 (latest)](/dotnet/docs/reference/Google.Cloud.Dataproc.V1/latest/Google.Cloud.Dataproc.V1.InstantiateWorkflowTemplateRequest)\n- [5.19.0](/dotnet/docs/reference/Google.Cloud.Dataproc.V1/5.19.0/Google.Cloud.Dataproc.V1.InstantiateWorkflowTemplateRequest)\n- [5.18.0](/dotnet/docs/reference/Google.Cloud.Dataproc.V1/5.18.0/Google.Cloud.Dataproc.V1.InstantiateWorkflowTemplateRequest)\n- [5.17.0](/dotnet/docs/reference/Google.Cloud.Dataproc.V1/5.17.0/Google.Cloud.Dataproc.V1.InstantiateWorkflowTemplateRequest)\n- [5.16.0](/dotnet/docs/reference/Google.Cloud.Dataproc.V1/5.16.0/Google.Cloud.Dataproc.V1.InstantiateWorkflowTemplateRequest)\n- [5.15.0](/dotnet/docs/reference/Google.Cloud.Dataproc.V1/5.15.0/Google.Cloud.Dataproc.V1.InstantiateWorkflowTemplateRequest)\n- [5.14.0](/dotnet/docs/reference/Google.Cloud.Dataproc.V1/5.14.0/Google.Cloud.Dataproc.V1.InstantiateWorkflowTemplateRequest)\n- [5.13.0](/dotnet/docs/reference/Google.Cloud.Dataproc.V1/5.13.0/Google.Cloud.Dataproc.V1.InstantiateWorkflowTemplateRequest)\n- [5.12.0](/dotnet/docs/reference/Google.Cloud.Dataproc.V1/5.12.0/Google.Cloud.Dataproc.V1.InstantiateWorkflowTemplateRequest)\n- [5.11.0](/dotnet/docs/reference/Google.Cloud.Dataproc.V1/5.11.0/Google.Cloud.Dataproc.V1.InstantiateWorkflowTemplateRequest)\n- [5.10.0](/dotnet/docs/reference/Google.Cloud.Dataproc.V1/5.10.0/Google.Cloud.Dataproc.V1.InstantiateWorkflowTemplateRequest)\n- [5.9.0](/dotnet/docs/reference/Google.Cloud.Dataproc.V1/5.9.0/Google.Cloud.Dataproc.V1.InstantiateWorkflowTemplateRequest)\n- [5.8.0](/dotnet/docs/reference/Google.Cloud.Dataproc.V1/5.8.0/Google.Cloud.Dataproc.V1.InstantiateWorkflowTemplateRequest)\n- [5.7.0](/dotnet/docs/reference/Google.Cloud.Dataproc.V1/5.7.0/Google.Cloud.Dataproc.V1.InstantiateWorkflowTemplateRequest)\n- [5.6.0](/dotnet/docs/reference/Google.Cloud.Dataproc.V1/5.6.0/Google.Cloud.Dataproc.V1.InstantiateWorkflowTemplateRequest)\n- [5.5.0](/dotnet/docs/reference/Google.Cloud.Dataproc.V1/5.5.0/Google.Cloud.Dataproc.V1.InstantiateWorkflowTemplateRequest)\n- [5.4.0](/dotnet/docs/reference/Google.Cloud.Dataproc.V1/5.4.0/Google.Cloud.Dataproc.V1.InstantiateWorkflowTemplateRequest)\n- [5.3.0](/dotnet/docs/reference/Google.Cloud.Dataproc.V1/5.3.0/Google.Cloud.Dataproc.V1.InstantiateWorkflowTemplateRequest)\n- [5.2.0](/dotnet/docs/reference/Google.Cloud.Dataproc.V1/5.2.0/Google.Cloud.Dataproc.V1.InstantiateWorkflowTemplateRequest)\n- [5.1.0](/dotnet/docs/reference/Google.Cloud.Dataproc.V1/5.1.0/Google.Cloud.Dataproc.V1.InstantiateWorkflowTemplateRequest)\n- [5.0.0](/dotnet/docs/reference/Google.Cloud.Dataproc.V1/5.0.0/Google.Cloud.Dataproc.V1.InstantiateWorkflowTemplateRequest)\n- [4.0.0](/dotnet/docs/reference/Google.Cloud.Dataproc.V1/4.0.0/Google.Cloud.Dataproc.V1.InstantiateWorkflowTemplateRequest)\n- [3.4.0](/dotnet/docs/reference/Google.Cloud.Dataproc.V1/3.4.0/Google.Cloud.Dataproc.V1.InstantiateWorkflowTemplateRequest)\n- [3.3.0](/dotnet/docs/reference/Google.Cloud.Dataproc.V1/3.3.0/Google.Cloud.Dataproc.V1.InstantiateWorkflowTemplateRequest)\n- [3.2.0](/dotnet/docs/reference/Google.Cloud.Dataproc.V1/3.2.0/Google.Cloud.Dataproc.V1.InstantiateWorkflowTemplateRequest)\n- [3.1.0](/dotnet/docs/reference/Google.Cloud.Dataproc.V1/3.1.0/Google.Cloud.Dataproc.V1.InstantiateWorkflowTemplateRequest) \n\n public sealed class InstantiateWorkflowTemplateRequest : IMessage\u003cInstantiateWorkflowTemplateRequest\u003e, IEquatable\u003cInstantiateWorkflowTemplateRequest\u003e, IDeepCloneable\u003cInstantiateWorkflowTemplateRequest\u003e, IBufferMessage, IMessage\n\nReference documentation and code samples for the Google Cloud Dataproc v1 API class InstantiateWorkflowTemplateRequest.\n\nA request to instantiate a workflow template. \n\nInheritance\n-----------\n\n[object](https://learn.microsoft.com/dotnet/api/system.object) \\\u003e InstantiateWorkflowTemplateRequest \n\nImplements\n----------\n\n[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[InstantiateWorkflowTemplateRequest](/dotnet/docs/reference/Google.Cloud.Dataproc.V1/latest/Google.Cloud.Dataproc.V1.InstantiateWorkflowTemplateRequest), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[InstantiateWorkflowTemplateRequest](/dotnet/docs/reference/Google.Cloud.Dataproc.V1/latest/Google.Cloud.Dataproc.V1.InstantiateWorkflowTemplateRequest), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[InstantiateWorkflowTemplateRequest](/dotnet/docs/reference/Google.Cloud.Dataproc.V1/latest/Google.Cloud.Dataproc.V1.InstantiateWorkflowTemplateRequest), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html) \n\nInherited Members\n-----------------\n\n[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) \n[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) \n[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)\n\nNamespace\n---------\n\n[Google.Cloud.Dataproc.V1](/dotnet/docs/reference/Google.Cloud.Dataproc.V1/latest/Google.Cloud.Dataproc.V1)\n\nAssembly\n--------\n\nGoogle.Cloud.Dataproc.V1.dll\n\nConstructors\n------------\n\n### InstantiateWorkflowTemplateRequest()\n\n public InstantiateWorkflowTemplateRequest()\n\n### InstantiateWorkflowTemplateRequest(InstantiateWorkflowTemplateRequest)\n\n public InstantiateWorkflowTemplateRequest(InstantiateWorkflowTemplateRequest other)\n\nProperties\n----------\n\n### Name\n\n public string Name { get; set; }\n\nRequired. The resource name of the workflow template, as described\nin \u003chttps://cloud.google.com/apis/design/resource_names\u003e.\n\n- For `projects.regions.workflowTemplates.instantiate`, the resource name\n of the template has the following format:\n `projects/{project_id}/regions/{region}/workflowTemplates/{template_id}`\n\n- For `projects.locations.workflowTemplates.instantiate`, the resource name\n of the template has the following format:\n `projects/{project_id}/locations/{location}/workflowTemplates/{template_id}`\n\n### Parameters\n\n public MapField\u003cstring, string\u003e Parameters { get; }\n\nOptional. Map from parameter names to values that should be used for those\nparameters. Values may not exceed 1000 characters.\n\n### RequestId\n\n public string RequestId { get; set; }\n\nOptional. A tag that prevents multiple concurrent workflow\ninstances with the same tag from running. This mitigates risk of\nconcurrent instances started due to retries.\n\nIt is recommended to always set this value to a\n[UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier).\n\nThe tag must contain only letters (a-z, A-Z), numbers (0-9),\nunderscores (_), and hyphens (-). The maximum length is 40 characters.\n\n### Version\n\n public int Version { get; set; }\n\nOptional. The version of workflow template to instantiate. If specified,\nthe workflow will be instantiated only if the current version of\nthe workflow template has the supplied version.\n\nThis option cannot be used to instantiate a previous version of\nworkflow template.\n\n### WorkflowTemplateName\n\n public WorkflowTemplateName WorkflowTemplateName { get; set; }\n\n[WorkflowTemplateName](/dotnet/docs/reference/Google.Cloud.Dataproc.V1/latest/Google.Cloud.Dataproc.V1.WorkflowTemplateName)-typed view over the [Name](/dotnet/docs/reference/Google.Cloud.Dataproc.V1/latest/Google.Cloud.Dataproc.V1.InstantiateWorkflowTemplateRequest#Google_Cloud_Dataproc_V1_InstantiateWorkflowTemplateRequest_Name) resource name property."]]
