Method: projects.locations.templates.create

Creates a Cloud Dataflow job from a template.

HTTP request

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

The URL uses Google API HTTP annotation syntax.

Path parameters

Parameters
projectId

string

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

location

string

The location 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.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

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

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 Auth Guide.

Send feedback about...

Cloud Dataflow Documentation