Method: googleapis.dataflow.v1b3.projects.locations.flexTemplates.launch

Launch a job with a FlexTemplate.

For more information about the Dataflow Flex Template configuration options, see Configure Flex Templates.

Arguments

Parameters
location

string

Required. The regional endpoint to which to direct the request. E.g., us-central1, us-west1.
projectId

string

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

object (LaunchFlexTemplateRequest)

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 LaunchFlexTemplateResponse.

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.flexTemplates.launch
    args:
        location: ...
        projectId: ...
        body:
            launchParameter:
                containerSpec:
                    defaultEnvironment:
                        additionalExperiments: ...
                        additionalUserLabels: ...
                        autoscalingAlgorithm: ...
                        diskSizeGb: ...
                        dumpHeapOnOom: ...
                        enableStreamingEngine: ...
                        flexrsGoal: ...
                        ipConfiguration: ...
                        kmsKeyName: ...
                        launcherMachineType: ...
                        machineType: ...
                        maxWorkers: ...
                        network: ...
                        numWorkers: ...
                        saveHeapDumpsToGcsPath: ...
                        sdkContainerImage: ...
                        serviceAccountEmail: ...
                        stagingLocation: ...
                        subnetwork: ...
                        tempLocation: ...
                        workerRegion: ...
                        workerZone: ...
                        zone: ...
                    image: ...
                    metadata:
                        description: ...
                        name: ...
                        parameters: ...
                    sdkInfo:
                        language: ...
                        version: ...
                containerSpecGcsPath: ...
                environment: ...
                jobName: ...
                launchOptions: ...
                parameters: ...
                transformNameMappings: ...
                update: ...
            validateOnly: ...
    result: launchResult

JSON

[
  {
    "launch": {
      "call": "googleapis.dataflow.v1b3.projects.locations.flexTemplates.launch",
      "args": {
        "location": "...",
        "projectId": "...",
        "body": {
          "launchParameter": {
            "containerSpec": {
              "defaultEnvironment": {
                "additionalExperiments": "...",
                "additionalUserLabels": "...",
                "autoscalingAlgorithm": "...",
                "diskSizeGb": "...",
                "dumpHeapOnOom": "...",
                "enableStreamingEngine": "...",
                "flexrsGoal": "...",
                "ipConfiguration": "...",
                "kmsKeyName": "...",
                "launcherMachineType": "...",
                "machineType": "...",
                "maxWorkers": "...",
                "network": "...",
                "numWorkers": "...",
                "saveHeapDumpsToGcsPath": "...",
                "sdkContainerImage": "...",
                "serviceAccountEmail": "...",
                "stagingLocation": "...",
                "subnetwork": "...",
                "tempLocation": "...",
                "workerRegion": "...",
                "workerZone": "...",
                "zone": "..."
              },
              "image": "...",
              "metadata": {
                "description": "...",
                "name": "...",
                "parameters": "..."
              },
              "sdkInfo": {
                "language": "...",
                "version": "..."
              }
            },
            "containerSpecGcsPath": "...",
            "environment": "...",
            "jobName": "...",
            "launchOptions": "...",
            "parameters": "...",
            "transformNameMappings": "...",
            "update": "..."
          },
          "validateOnly": "..."
        }
      },
      "result": "launchResult"
    }
  }
]