Running classic templates

After you create and stage your Dataflow template, run the template with the Google Cloud console, REST API, or gcloud command-line tool. You can deploy Dataflow template jobs from many environments, including App Engine standard environment, Cloud Functions, and other constrained environments.

Note: In addition to the template file, running templated pipeline relies on files that were staged and referenced at the time of template creation. If you move or remove the staged files, your pipeline job will fail.

Using the Cloud console

You can use the Cloud console to run Google-provided and custom Dataflow templates.

Google-provided templates

To run a Google-provided template:

Go to the Dataflow page in the Cloud console.

Go to the Dataflow page

Click CREATE JOB FROM TEMPLATE.

Select the Google-provided template that you want to run from the Dataflow template drop-down menu.

Enter a job name in the Job Name field.
Enter your parameter values in the provided parameter fields. You should not need the Additional Parameters section when you use a Google-provided template.
Click Run Job.

Custom templates

To run a custom template:

Go to the Dataflow page in the Cloud console.

Go to the Dataflow page

Click CREATE JOB FROM TEMPLATE.

Select Custom Template from the Dataflow template drop-down menu.

Enter a job name in the Job Name field.
Enter the Cloud Storage path to your template file in the template Cloud Storage path field.
If your template needs parameters, click on ADD PARAMETER in the Additional parameters section. Enter in the Name and Value of the parameter. Repeat this step for each needed parameter.
Click Run Job.

Using the REST API

To run a template with a REST API request, send an HTTP POST request with your project ID. This request requires authorization.

See the REST API reference for projects.locations.templates.launch to learn more about the available parameters.

In the JSON request body, set runtime environment values in the environment property, not the parameters property. The environment property defines the runtime environment for the job.

Example 1: Creating a custom template batch job

This example projects.locations.templates.launch request creates a batch job from a template that reads a text file and writes an output text file. If the request is successful, the response body contains an instance of LaunchTemplateResponse.

You must modify the following values:

Replace YOUR_PROJECT_ID with your project ID.
Replace LOCATION with the Dataflow regional endpoint of your choice.
Replace JOB_NAME with a job name of your choice.
Replace YOUR_BUCKET_NAME with the name of your Cloud Storage bucket.
Set gcsPath to the Cloud Storage location of the template file.
Set parameters to your list of key/value pairs.
Set tempLocation to a location where you have write permission. This value is required to run Google-provided templates.

    POST https://dataflow.googleapis.com/v1b3/projects/YOUR_PROJECT_ID/locations/LOCATION/templates:launch?gcsPath=gs://YOUR_BUCKET_NAME/templates/TemplateName
    {
        "jobName": "JOB_NAME",
        "parameters": {
            "inputFile" : "gs://YOUR_BUCKET_NAME/input/my_input.txt",
            "outputFile": "gs://YOUR_BUCKET_NAME/output/my_output"
        },
        "environment": {
            "tempLocation": "gs://YOUR_BUCKET_NAME/temp",
            "zone": "us-central1-f"
        }
    }

Example 2: Creating a custom template streaming job

This example projects.locations.templates.launch request creates a streaming job from a template that reads from a Pub/Sub topic and writes to a BigQuery table. The BigQuery table must already exist with the appropriate schema. If successful, the response body contains an instance of LaunchTemplateResponse.

You must modify the following values:

Replace YOUR_PROJECT_ID with your project ID.
Replace LOCATION with the Dataflow regional endpoint of your choice.
Replace JOB_NAME with a job name of your choice.
Replace YOUR_BUCKET_NAME with the name of your Cloud Storage bucket.
Replace YOUR_TOPIC_NAME with your Pub/Sub topic name.
Replace YOUR_DATASET with your BigQuery dataset, and replace YOUR_TABLE_NAME with your BigQuery table name.
Set gcsPath to the Cloud Storage location of the template file.
Set parameters to your list of key/value pairs.
Set tempLocation to a location where you have write permission. This value is required to run Google-provided templates.

    POST https://dataflow.googleapis.com/v1b3/projects/YOUR_PROJECT_ID/locations/LOCATION/templates:launch?gcsPath=gs://YOUR_BUCKET_NAME/templates/TemplateName
    {
        "jobName": "JOB_NAME",
        "parameters": {
            "topic": "projects/YOUR_PROJECT_ID/topics/YOUR_TOPIC_NAME",
            "table": "YOUR_PROJECT_ID:YOUR_DATASET.YOUR_TABLE_NAME"
        },
        "environment": {
            "tempLocation": "gs://YOUR_BUCKET_NAME/temp",
            "zone": "us-central1-f"
        }
    }

Example 3: Updating a custom template streaming job

This example projects.locations.templates.launch request shows you how to update a template streaming job.

Run Example 2: Creating a custom template streaming job to start a streaming template job.
Send the following HTTP POST request, with the following modified values:
- Replace YOUR_PROJECT_ID with your project ID.
- Replace LOCATION with the Dataflow regional endpoint of your choice.
- Replace JOB_NAME with a job name of your choice.
- Replace YOUR_BUCKET_NAME with the name of your Cloud Storage bucket.
- Replace YOUR_TOPIC_NAME with your Pub/Sub topic name.
- Replace YOUR_DATASET with your BigQuery dataset, and replace YOUR_TABLE_NAME with your BigQuery table name.
- Set gcsPath to the Cloud Storage location of the template file.
- Set parameters to your list of key/value pairs.
- Set tempLocation to a location where you have write permission. This value is required to run Google-provided templates.
```
    POST https://dataflow.googleapis.com/v1b3/projects/YOUR_PROJECT_ID/locations/LOCATION/templates:launch?gcsPath=gs://YOUR_BUCKET_NAME/templates/TemplateName
    {
        "jobName": "JOB_NAME",
        "parameters": {
            "topic": "projects/YOUR_PROJECT_ID/topics/YOUR_TOPIC_NAME",
            "table": "YOUR_PROJECT_ID:YOUR_DATASET.YOUR_TABLE_NAME"
        },
        "environment": {
            "tempLocation": "gs://YOUR_BUCKET_NAME/temp",
            "zone": "us-central1-f"
        }
        "update": true
    }
```
Access the Dataflow monitoring interface and verify that a new job with the same name was created. This job has the status Updated.

Using the Google API Client Libraries

Consider using the Google API Client Libraries to easily make calls to the Dataflow REST APIs. This sample script uses the Google API Client Library for Python.

In this example, you must set the following variables:

project: Set to your project ID.
job: Set to a unique job name of your choice.
template: Set to the Cloud Storage location of the template file.
parameters: Set to a dictionary with the template parameters.

dataflow/run_template/main.py

View on GitHub Feedback

from googleapiclient.discovery import build

# project = 'your-gcp-project'
# job = 'unique-job-name'
# template = 'gs://dataflow-templates/latest/Word_Count'
# parameters = {
#     'inputFile': 'gs://dataflow-samples/shakespeare/kinglear.txt',
#     'output': 'gs://<your-gcs-bucket>/wordcount/outputs',
# }

dataflow = build('dataflow', 'v1b3')
request = dataflow.projects().templates().launch(
    projectId=project,
    gcsPath=template,
    body={
        'jobName': job,
        'parameters': parameters,
    }
)

response = request.execute()

For more information about the available options, see the projects.locations.templates.launch method in the Cloud Dataflow REST API reference.

Using gcloud

Note: To use the gcloud command-line tool to run templates, you must have Cloud SDK version 138.0.0 or higher.

The gcloud command-line tool can run either a custom or a Google-provided template using the gcloud dataflow jobs run command. Examples of running Google-provided templates are documented in the Google-provided templates page.

For the following custom template examples, set the following values:

Replace JOB_NAME with a job name of your choice.
Replace YOUR_BUCKET_NAME with the name of your Cloud Storage bucket.
You must include the --gcs-location flag. Set --gcs-location to the Cloud Storage location of the template file.
Set --parameters to the comma-separated list of parameters to pass to the job. Spaces between commas and values are not allowed.

Example 1: Custom template, batch job

This example creates a batch job from a template that reads a text file and writes an output text file.

    gcloud dataflow jobs run JOB_NAME \
        --gcs-location gs://YOUR_BUCKET_NAME/templates/MyTemplate \
        --parameters inputFile=gs://YOUR_BUCKET_NAME/input/my_input.txt,outputFile=gs://YOUR_BUCKET_NAME/output/my_output

The request returns a response with the following format.

    id: 2016-10-11_17_10_59-1234530157620696789
    projectId: YOUR_PROJECT_ID
    type: JOB_TYPE_BATCH

Example 2: Custom template, streaming job

This example creates a streaming job from a template that reads from a Pub/Sub topic and writes to a BigQuery table. The BigQuery table must already exist with the appropriate schema.

    gcloud dataflow jobs run JOB_NAME \
        --gcs-location gs://YOUR_BUCKET_NAME/templates/MyTemplate \
        --parameters topic=projects/project-identifier/topics/resource-name,table=my_project:my_dataset.my_table_name

The request returns a response with the following format.

    id: 2016-10-11_17_10_59-1234530157620696789
    projectId: YOUR_PROJECT_ID
    type: JOB_TYPE_STREAMING

For a complete list of flags for the gcloud dataflow jobs run command, see the gcloud tool reference.

Monitoring and Troubleshooting

The Dataflow Monitoring Interface allows you to monitor your Dataflow jobs. If a job fails, you can find troubleshooting tips, debugging strategies, and a catalog of common errors in the Troubleshooting Your Pipeline guide.