Reference documentation and code samples for the Google Cloud Dataproc V1 Client class InstantiateWorkflowTemplateRequest.
A request to instantiate a workflow template.
Generated from protobuf message google.cloud.dataproc.v1.InstantiateWorkflowTemplateRequest
Namespace
Google \ Cloud \ Dataproc \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
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}
↳ version
int
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.
↳ request_id
string
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.
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}
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}
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getVersion
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.
Returns
Type
Description
int
setVersion
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.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getRequestId
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.
Returns
Type
Description
string
setRequestId
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.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getParameters
Optional. Map from parameter names to values that should be used for those
parameters. Values may not exceed 1000 characters.
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}
Please see Google\Cloud\Dataproc\V1\WorkflowTemplateServiceClient::workflowTemplateName() for help formatting this field.
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}
Please see Google\Cloud\Dataproc\V1\WorkflowTemplateServiceClient::workflowTemplateName() for help formatting this field.
parameters
array
Optional. Map from parameter names to values that should be used for those
parameters. Values may not exceed 1000 characters.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Dataproc V1 Client - Class InstantiateWorkflowTemplateRequest (3.14.0)\n\nVersion latestkeyboard_arrow_down\n\n- [3.14.0 (latest)](/php/docs/reference/cloud-dataproc/latest/V1.InstantiateWorkflowTemplateRequest)\n- [3.13.4](/php/docs/reference/cloud-dataproc/3.13.4/V1.InstantiateWorkflowTemplateRequest)\n- [3.12.0](/php/docs/reference/cloud-dataproc/3.12.0/V1.InstantiateWorkflowTemplateRequest)\n- [3.11.0](/php/docs/reference/cloud-dataproc/3.11.0/V1.InstantiateWorkflowTemplateRequest)\n- [3.10.1](/php/docs/reference/cloud-dataproc/3.10.1/V1.InstantiateWorkflowTemplateRequest)\n- [3.9.0](/php/docs/reference/cloud-dataproc/3.9.0/V1.InstantiateWorkflowTemplateRequest)\n- [3.8.1](/php/docs/reference/cloud-dataproc/3.8.1/V1.InstantiateWorkflowTemplateRequest)\n- [3.7.1](/php/docs/reference/cloud-dataproc/3.7.1/V1.InstantiateWorkflowTemplateRequest)\n- [3.6.1](/php/docs/reference/cloud-dataproc/3.6.1/V1.InstantiateWorkflowTemplateRequest)\n- [3.5.1](/php/docs/reference/cloud-dataproc/3.5.1/V1.InstantiateWorkflowTemplateRequest)\n- [3.4.0](/php/docs/reference/cloud-dataproc/3.4.0/V1.InstantiateWorkflowTemplateRequest)\n- [3.3.0](/php/docs/reference/cloud-dataproc/3.3.0/V1.InstantiateWorkflowTemplateRequest)\n- [3.2.2](/php/docs/reference/cloud-dataproc/3.2.2/V1.InstantiateWorkflowTemplateRequest)\n- [2.6.1](/php/docs/reference/cloud-dataproc/2.6.1/V1.InstantiateWorkflowTemplateRequest)\n- [2.5.0](/php/docs/reference/cloud-dataproc/2.5.0/V1.InstantiateWorkflowTemplateRequest)\n- [2.3.0](/php/docs/reference/cloud-dataproc/2.3.0/V1.InstantiateWorkflowTemplateRequest)\n- [2.2.3](/php/docs/reference/cloud-dataproc/2.2.3/V1.InstantiateWorkflowTemplateRequest)\n- [2.1.0](/php/docs/reference/cloud-dataproc/2.1.0/V1.InstantiateWorkflowTemplateRequest)\n- [2.0.0](/php/docs/reference/cloud-dataproc/2.0.0/V1.InstantiateWorkflowTemplateRequest) \nReference documentation and code samples for the Google Cloud Dataproc V1 Client class InstantiateWorkflowTemplateRequest.\n\nA request to instantiate a workflow template.\n\nGenerated from protobuf message `google.cloud.dataproc.v1.InstantiateWorkflowTemplateRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Dataproc \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\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 of the template has the following format: `projects/{project_id}/regions/{region}/workflowTemplates/{template_id}`\n- For `projects.locations.workflowTemplates.instantiate`, the resource name of the template has the following format: `projects/{project_id}/locations/{location}/workflowTemplates/{template_id}`\n\n### setName\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 of the template has the following format: `projects/{project_id}/regions/{region}/workflowTemplates/{template_id}`\n- For `projects.locations.workflowTemplates.instantiate`, the resource name of the template has the following format: `projects/{project_id}/locations/{location}/workflowTemplates/{template_id}`\n\n### getVersion\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### setVersion\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### getRequestId\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).\nThe tag must contain only letters (a-z, A-Z), numbers (0-9),\nunderscores (_), and hyphens (-). The maximum length is 40 characters.\n\n### setRequestId\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).\nThe tag must contain only letters (a-z, A-Z), numbers (0-9),\nunderscores (_), and hyphens (-). The maximum length is 40 characters.\n\n### getParameters\n\nOptional. Map from parameter names to values that should be used for those\nparameters. Values may not exceed 1000 characters.\n\n### setParameters\n\nOptional. Map from parameter names to values that should be used for those\nparameters. Values may not exceed 1000 characters.\n\n### static::build\n\n### static::buildFromNameParameters"]]
