Method: projects.locations.workflowTemplates.instantiateInline

Instantiates a template and begins execution.

This method is equivalent to executing the sequence workflowTemplates.create, workflowTemplates.instantiate, workflowTemplates.delete.

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.

The Operation.metadata will be WorkflowMetadata. Also see Using WorkflowMetadata.

On successful completion, Operation.response will be Empty.

HTTP request

POST https://dataproc.googleapis.com/v1/{parent=projects/*/locations/*}/workflowTemplates:instantiateInline

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

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

  • 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.

Request body

The request body contains an instance of WorkflowTemplate.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.