Join the Apache Beam community on July 18th-20th for the Beam Summit 2022 to learn more about Beam and share your expertise.

Method: projects.locations.templates.create

Creates a Cloud Dataflow job from a template. Do not enter confidential information when you supply string values using the API.

HTTP request

POST https://dataflow.googleapis.com/v1b3/projects/{projectId}/locations/{location}/templates

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
projectId

string

Required. The ID of the Cloud Platform project that the job belongs to.
location

string

The regional endpoint to which to direct the request.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "jobName": string,
  "parameters": {
    string: string,
    ...
  },
  "environment": {
    object (RuntimeEnvironment)
  },
  "gcsPath": string
}
Fields
jobName

string

Required. The job name to use for the created job.
parameters

map (key: string, value: string)

The runtime parameters to pass to the job.
environment

object (RuntimeEnvironment)

The runtime environment for the job.
gcsPath

string

Required. A Cloud Storage path to the template from which to create the job. Must be a valid Cloud Storage URL, beginning with gs://.

Response body

If successful, the response body contains a newly created instance of Job.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/compute.readonly
  • https://www.googleapis.com/auth/compute
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/userinfo.email

For more information, see the Authentication Overview.