The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.
The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.
For projects.regions.workflowTemplates,instantiateinline, the resource name of the region has the following format: projects/{projectId}/regions/{region}
For projects.locations.workflowTemplates.instantiateinline, the resource name of the location has the following format: projects/{projectId}/locations/{location}
Authorization requires the following IAM permission on the specified resource parent:
dataproc.workflowTemplates.instantiateInline
Query parameters
Parameters
requestId
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.
[[["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-06-20 UTC."],[[["\u003cp\u003eThis webpage details how to instantiate a workflow template inline using the Dataproc API, which is equivalent to creating, instantiating, and then deleting a workflow template.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003einstantiateInline\u003c/code\u003e method initiates workflow execution and returns an Operation that can be used to track progress or to cancel the workflow.\u003c/p\u003e\n"],["\u003cp\u003eThe required HTTP request to instantiate a workflow template uses the POST method and includes a parent path parameter that specifies the project and region or location where the template resides.\u003c/p\u003e\n"],["\u003cp\u003eAn optional \u003ccode\u003erequestId\u003c/code\u003e query parameter can be included to prevent the concurrent execution of workflow instances with the same tag.\u003c/p\u003e\n"],["\u003cp\u003eA successful response to the instantiation request will include an Operation that allows you to track the workflow execution and will require \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],[],null,["# Method: projects.regions.workflowTemplates.instantiateInline\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nInstantiates a template and begins execution.\n\nThis method is equivalent to executing the sequence [workflowTemplates.create](/dataproc/docs/reference/rest/v1/projects.locations.workflowTemplates/create#google.cloud.dataproc.v1.WorkflowTemplateService.CreateWorkflowTemplate), [workflowTemplates.instantiate](/dataproc/docs/reference/rest/v1/projects.locations.workflowTemplates/instantiate#google.cloud.dataproc.v1.WorkflowTemplateService.InstantiateWorkflowTemplate), [workflowTemplates.delete](/dataproc/docs/reference/rest/v1/projects.locations.workflowTemplates/delete#google.cloud.dataproc.v1.WorkflowTemplateService.DeleteWorkflowTemplate).\n\nThe returned Operation can be used to track execution of workflow by polling [operations.get](/dataproc/docs/reference/rest/v1/projects.regions.operations/get#google.longrunning.Operations.GetOperation). The Operation will complete when entire workflow is finished.\n\nThe running workflow can be aborted via [operations.cancel](/dataproc/docs/reference/rest/v1/projects.regions.operations/cancel#google.longrunning.Operations.CancelOperation). This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.\n\nThe [Operation.metadata](/dataproc/docs/reference/rest/v1/projects.locations.operations#Operation.FIELDS.metadata) will be [WorkflowMetadata](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see [Using WorkflowMetadata](https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).\n\nOn successful completion, [Operation.response](/dataproc/docs/reference/rest/v1/projects.locations.operations#Operation.FIELDS.response) will be [Empty](https://protobuf.dev/reference/protobuf/google.protobuf/#empty).\n\n### HTTP request\n\n`POST https://dataproc.googleapis.com/v1/{parent=projects/*/regions/*}/workflowTemplates:instantiateInline`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Query parameters\n\n### Request body\n\nThe request body contains an instance of [WorkflowTemplate](/dataproc/docs/reference/rest/v1/projects.locations.workflowTemplates#WorkflowTemplate).\n\n### Response body\n\nIf successful, the response body contains an instance of [Operation](/dataproc/docs/reference/rest/v1/projects.locations.operations#Operation).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp)."]]
