Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1342194234.5 KB
projects

Launches a template. To launch a template, we recommend using projects.locations.templates.launch with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using projects.templates.launch is not recommended, because jobs launched from the template will always start in us-central1.

post/v1b3/projects/{projectId}/locations/{location}/templates:launch

Path parameters

projectIdstring required

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

locationstring required

The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request.

Query parameters

dynamicTemplate.gcsPathstring

Path to the dynamic template specification file on Cloud Storage. The file must be a JSON serialized DynamicTemplateFileSpec object.

dynamicTemplate.stagingLocationstring

Cloud Storage path for staging dependencies. Must be a valid Cloud Storage URL, beginning with gs://.

gcsPathstring

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

validateOnlyboolean

If true, the request is validated but not actually executed. Defaults to false.

Request body

parametersobject

The runtime parameters to pass to the job.

updateboolean

If set, replace the existing pipeline with the name specified by jobName with this pipeline, preserving state.

transformNameMappingobject

Only applicable when updating a pipeline. Map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.

jobNamestring

Required. The job name to use for the created job. The name must match the regular expression [a-z]([-a-z0-9]{0,1022}[a-z0-9])?

Response

Successful response