Launch a template.
Arguments
Parameters | |
---|---|
location |
Required. The regional endpoint to which to direct the request.
|
projectId |
Required. The ID of the Cloud Platform project that the job belongs to.
|
dynamicTemplate.gcsPath |
Path to dynamic template spec file on Cloud Storage. The file must be a Json serialized DynamicTemplateFieSpec object.
|
dynamicTemplate.stagingLocation |
Cloud Storage path for staging dependencies. Must be a valid Cloud Storage URL, beginning with
|
gcsPath |
A Cloud Storage path to the template from which to create the job. Must be valid Cloud Storage URL, beginning with 'gs://'.
|
validateOnly |
If true, the request is validated but not actually executed. Defaults to false.
|
body |
Required.
|
Raised exceptions
Exceptions | |
---|---|
ConnectionError |
In case of a network problem (such as DNS failure or refused connection). |
HttpError |
If the response status is >= 400 (excluding 429 and 503). |
TimeoutError |
If a long-running operation takes longer to finish than the specified timeout limit. |
TypeError |
If an operation or function receives an argument of the wrong type. |
ValueError |
If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout. |
Response
If successful, the response contains an instance of LaunchTemplateResponse
.
Subworkflow snippet
Some fields might be optional or required. To identify required fields, refer to the API documentation.
YAML
- launch: call: googleapis.dataflow.v1b3.projects.locations.templates.launch args: location: ... projectId: ... dynamicTemplate: gcsPath: ... stagingLocation: ... gcsPath: ... validateOnly: ... body: environment: additionalExperiments: ... additionalUserLabels: ... bypassTempDirValidation: ... enableStreamingEngine: ... ipConfiguration: ... kmsKeyName: ... machineType: ... maxWorkers: ... network: ... numWorkers: ... serviceAccountEmail: ... subnetwork: ... tempLocation: ... workerRegion: ... workerZone: ... zone: ... jobName: ... parameters: ... transformNameMapping: ... update: ... result: launchResult
JSON
[ { "launch": { "call": "googleapis.dataflow.v1b3.projects.locations.templates.launch", "args": { "location": "...", "projectId": "...", "dynamicTemplate": { "gcsPath": "...", "stagingLocation": "..." }, "gcsPath": "...", "validateOnly": "...", "body": { "environment": { "additionalExperiments": "...", "additionalUserLabels": "...", "bypassTempDirValidation": "...", "enableStreamingEngine": "...", "ipConfiguration": "...", "kmsKeyName": "...", "machineType": "...", "maxWorkers": "...", "network": "...", "numWorkers": "...", "serviceAccountEmail": "...", "subnetwork": "...", "tempLocation": "...", "workerRegion": "...", "workerZone": "...", "zone": "..." }, "jobName": "...", "parameters": "...", "transformNameMapping": "...", "update": "..." } }, "result": "launchResult" } } ]