templates

Creates, updates, deletes, gets or lists a templates resource.

Overview

Name	templates
Type	Resource
Id	google.dataflow.templates

Fields

Name	Datatype	Description
metadata	object	Metadata describing a template.
runtimeMetadata	object	RuntimeMetadata describing a runtime environment.
status	object	The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.
templateType	string	Template Type.

Methods

Name	Accessible by	Required Params	Description
projects_locations_templates_get	SELECT	location, projectId	Get the template associated with a template. To get the template, we recommend using projects.locations.templates.get with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using projects.templates.get is not recommended, because only templates that are running in us-central1 are retrieved.
projects_templates_get	SELECT	projectId	Get the template associated with a template. To get the template, we recommend using projects.locations.templates.get with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using projects.templates.get is not recommended, because only templates that are running in us-central1 are retrieved.
projects_locations_templates_create	INSERT	location, projectId	Creates a Cloud Dataflow job from a template. Do not enter confidential information when you supply string values using the API. To create a job, we recommend using projects.locations.templates.create with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using projects.templates.create is not recommended, because your job will always start in us-central1.
projects_templates_create	INSERT	projectId	Creates a Cloud Dataflow job from a template. Do not enter confidential information when you supply string values using the API. To create a job, we recommend using projects.locations.templates.create with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using projects.templates.create is not recommended, because your job will always start in us-central1.
projects_locations_templates_launch	EXEC	location, projectId	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.
projects_templates_launch	EXEC	projectId	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.

SELECT examples

Get the template associated with a template. To get the template, we recommend using projects.locations.templates.get with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using projects.templates.get is not recommended, because only templates that are running in us-central1 are retrieved.

SELECT
metadata,
runtimeMetadata,
status,
templateType
FROM google.dataflow.templates
WHERE projectId = '{{ projectId }}';

INSERT example

Use the following StackQL query and manifest file to create a new templates resource.

All Properties

/*+ create */
INSERT INTO google.dataflow.templates (
projectId,
jobName,
gcsPath,
parameters,
environment,
location
)
SELECT 
'{{ projectId }}',
'{{ jobName }}',
'{{ gcsPath }}',
'{{ parameters }}',
'{{ environment }}',
'{{ location }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: jobName
      value: string
    - name: gcsPath
      value: string
    - name: parameters
      value: object
    - name: environment
      value:
        - name: numWorkers
          value: integer
        - name: maxWorkers
          value: integer
        - name: zone
          value: string
        - name: serviceAccountEmail
          value: string
        - name: tempLocation
          value: string
        - name: bypassTempDirValidation
          value: boolean
        - name: machineType
          value: string
        - name: additionalExperiments
          value:
            - string
        - name: network
          value: string
        - name: subnetwork
          value: string
        - name: additionalUserLabels
          value: object
        - name: kmsKeyName
          value: string
        - name: ipConfiguration
          value: string
        - name: workerRegion
          value: string
        - name: workerZone
          value: string
        - name: enableStreamingEngine
          value: boolean
        - name: diskSizeGb
          value: integer
        - name: streamingMode
          value: string
    - name: location
      value: string