- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Try it!
Launches a template.
To launch a template, we recommend using projects.locations.templates.launch
with a regional endpoint
. Using projects.templates.launch
is not recommended, because jobs launched from the template will always start in us-central1
.
HTTP request
POST https://dataflow.googleapis.com/v1b3/projects/{projectId}/templates:launch
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters | |
|---|---|
projectId
|
Required. The ID of the Cloud Platform project that the job belongs to. |
Query parameters
validateOnly
boolean
If true, the request is validated but not actually executed. Defaults to false.
location
string
The regional endpoint to which to direct the request.
template
. The template to use to create the job. template
can be only one of the following:gcsPath
string
A Cloud Storage path to the template to use to create the job. Must be valid Cloud Storage URL, beginning with gs://
.
dynamicTemplate
object (
DynamicTemplateLaunchParams
)
Parameters for launching a dynamic template.
Request body
The request body contains an instance of LaunchTemplateParameters
.
Response body
If successful, the response body contains an instance of LaunchTemplateResponse
.
Authorization scopes
Requires one of the following OAuth scopes:
-
https://www.googleapis.com/auth/compute -
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview .
