| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="dataflow_v1b3.html">Dataflow API</a> . <a href="dataflow_v1b3.projects.html">projects</a> . <a href="dataflow_v1b3.projects.templates.html">templates</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#create">create(projectId, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Creates a Cloud Dataflow job from a template.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(projectId, gcsPath=None, location=None, view=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Get the template associated with a template.</p> |
| <p class="toc_element"> |
| <code><a href="#launch">launch(projectId, body=None, dynamicTemplate_gcsPath=None, dynamicTemplate_stagingLocation=None, gcsPath=None, location=None, validateOnly=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Launch a template.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="create">create(projectId, body=None, x__xgafv=None)</code> |
| <pre>Creates a Cloud Dataflow job from a template. |
| |
| Args: |
| projectId: string, Required. The ID of the Cloud Platform project that the job belongs to. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # A request to create a Cloud Dataflow job from a template. |
| "environment": { # The environment values to set at runtime. # The runtime environment for the job. |
| "additionalExperiments": [ # Additional experiment flags for the job, specified with the `--experiments` option. |
| "A String", |
| ], |
| "additionalUserLabels": { # Additional user labels to be specified for the job. Keys and values should follow the restrictions specified in the [labeling restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) page. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1kg", "count": "3" }. |
| "a_key": "A String", |
| }, |
| "bypassTempDirValidation": True or False, # Whether to bypass the safety checks for the job's temporary directory. Use with caution. |
| "enableStreamingEngine": True or False, # Whether to enable Streaming Engine for the job. |
| "ipConfiguration": "A String", # Configuration for VM IPs. |
| "kmsKeyName": "A String", # Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/ |
| "machineType": "A String", # The machine type to use for the job. Defaults to the value from the template if not specified. |
| "maxWorkers": 42, # The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000. |
| "network": "A String", # Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default". |
| "numWorkers": 42, # The initial number of Google Compute Engine instnaces for the job. |
| "serviceAccountEmail": "A String", # The email address of the service account to run the job as. |
| "subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. You can specify a subnetwork using either a complete URL or an abbreviated path. Expected to be of the form "https://www.googleapis.com/compute/v1/projects/HOST_PROJECT_ID/regions/REGION/subnetworks/SUBNETWORK" or "regions/REGION/subnetworks/SUBNETWORK". If the subnetwork is located in a Shared VPC network, you must use the complete URL. |
| "tempLocation": "A String", # The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`. |
| "workerRegion": "A String", # The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1". Mutually exclusive with worker_zone. If neither worker_region nor worker_zone is specified, default to the control plane's region. |
| "workerZone": "A String", # The Compute Engine zone (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1-a". Mutually exclusive with worker_region. If neither worker_region nor worker_zone is specified, a zone in the control plane's region is chosen based on available capacity. If both `worker_zone` and `zone` are set, `worker_zone` takes precedence. |
| "zone": "A String", # The Compute Engine [availability zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones) for launching worker instances to run your pipeline. In the future, worker_zone will take precedence. |
| }, |
| "gcsPath": "A String", # Required. A Cloud Storage path to the template from which to create the job. Must be a valid Cloud Storage URL, beginning with `gs://`. |
| "jobName": "A String", # Required. The job name to use for the created job. |
| "location": "A String", # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request. |
| "parameters": { # The runtime parameters to pass to the job. |
| "a_key": "A String", |
| }, |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Defines a job to be run by the Cloud Dataflow service. nextID: 26 |
| "clientRequestId": "A String", # The client's unique identifier of the job, re-used across retried attempts. If this field is set, the service will ensure its uniqueness. The request to create a job will fail if the service has knowledge of a previously submitted job with the same client's ID and job name. The caller may use this field to ensure idempotence of job creation across retried attempts to create a job. By default, the field is empty and, in that case, the service ignores it. |
| "createTime": "A String", # The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service. |
| "createdFromSnapshotId": "A String", # If this is specified, the job's initial state is populated from the given snapshot. |
| "currentState": "A String", # The current state of the job. Jobs are created in the `JOB_STATE_STOPPED` state unless otherwise specified. A job in the `JOB_STATE_RUNNING` state may asynchronously enter a terminal state. After a job has reached a terminal state, no further state updates may be made. This field may be mutated by the Cloud Dataflow service; callers cannot mutate it. |
| "currentStateTime": "A String", # The timestamp associated with the current state. |
| "environment": { # Describes the environment in which a Dataflow Job runs. # The environment for the job. |
| "clusterManagerApiService": "A String", # The type of cluster manager API to use. If unknown or unspecified, the service will attempt to choose a reasonable default. This should be in the form of the API service name, e.g. "compute.googleapis.com". |
| "dataset": "A String", # The dataset for the current project where various workflow related tables are stored. The supported resource type is: Google BigQuery: bigquery.googleapis.com/{dataset} |
| "debugOptions": { # Describes any options that have an effect on the debugging of pipelines. # Any debugging options to be supplied to the job. |
| "enableHotKeyLogging": True or False, # When true, enables the logging of the literal hot key to the user's Cloud Logging. |
| }, |
| "experiments": [ # The list of experiments to enable. This field should be used for SDK related experiments and not for service related experiments. The proper field for service related experiments is service_options. |
| "A String", |
| ], |
| "flexResourceSchedulingGoal": "A String", # Which Flexible Resource Scheduling mode to run in. |
| "internalExperiments": { # Experimental settings. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| "sdkPipelineOptions": { # The Cloud Dataflow SDK pipeline options specified by the user. These options are passed through the service and are used to recreate the SDK pipeline options on the worker in a language agnostic and platform independent way. |
| "a_key": "", # Properties of the object. |
| }, |
| "serviceAccountEmail": "A String", # Identity to run virtual machines as. Defaults to the default account. |
| "serviceKmsKeyName": "A String", # If set, contains the Cloud KMS key identifier used to encrypt data at rest, AKA a Customer Managed Encryption Key (CMEK). Format: projects/PROJECT_ID/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/KEY |
| "serviceOptions": [ # The list of service options to enable. This field should be used for service related experiments only. These experiments, when graduating to GA, should be replaced by dedicated fields or become default (i.e. always on). |
| "A String", |
| ], |
| "shuffleMode": "A String", # Output only. The shuffle mode used for the job. |
| "tempStoragePrefix": "A String", # The prefix of the resources the system should use for temporary storage. The system will append the suffix "/temp-{JOBNAME} to this resource prefix, where {JOBNAME} is the value of the job_name field. The resulting bucket and object prefix is used as the prefix of the resources used to store temporary data needed during the job execution. NOTE: This will override the value in taskrunner_settings. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object} |
| "userAgent": { # A description of the process that generated the request. |
| "a_key": "", # Properties of the object. |
| }, |
| "version": { # A structure describing which components and their versions of the service are required in order to run the job. |
| "a_key": "", # Properties of the object. |
| }, |
| "workerPools": [ # The worker pools. At least one "harness" worker pool must be specified in order for the job to have workers. |
| { # Describes one particular pool of Cloud Dataflow workers to be instantiated by the Cloud Dataflow service in order to perform the computations required by a job. Note that a workflow job may use multiple pools, in order to match the various computational requirements of the various stages of the job. |
| "autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool. |
| "algorithm": "A String", # The algorithm to use for autoscaling. |
| "maxNumWorkers": 42, # The maximum number of workers to cap scaling at. |
| }, |
| "dataDisks": [ # Data disks that are used by a VM in this workflow. |
| { # Describes the data disk used by a workflow job. |
| "diskType": "A String", # Disk storage type, as defined by Google Compute Engine. This must be a disk type appropriate to the project and zone in which the workers will run. If unknown or unspecified, the service will attempt to choose a reasonable default. For example, the standard persistent disk type is a resource name typically ending in "pd-standard". If SSD persistent disks are available, the resource name typically ends with "pd-ssd". The actual valid values are defined the Google Compute Engine API, not by the Cloud Dataflow API; consult the Google Compute Engine documentation for more information about determining the set of available disk types for a particular project and zone. Google Compute Engine Disk types are local to a particular project in a particular zone, and so the resource name will typically look something like this: compute.googleapis.com/projects/project-id/zones/zone/diskTypes/pd-standard |
| "mountPoint": "A String", # Directory in a VM where disk is mounted. |
| "sizeGb": 42, # Size of disk in GB. If zero or unspecified, the service will attempt to choose a reasonable default. |
| }, |
| ], |
| "defaultPackageSet": "A String", # The default package set to install. This allows the service to select a default set of packages which are useful to worker harnesses written in a particular language. |
| "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default. |
| "diskSourceImage": "A String", # Fully qualified source image for disks. |
| "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default. |
| "ipConfiguration": "A String", # Configuration for VM IPs. |
| "kind": "A String", # The kind of the worker pool; currently only `harness` and `shuffle` are supported. |
| "machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the service will attempt to choose a reasonable default. |
| "metadata": { # Metadata to set on the Google Compute Engine VMs. |
| "a_key": "A String", |
| }, |
| "network": "A String", # Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default". |
| "numThreadsPerWorker": 42, # The number of threads per worker harness. If empty or unspecified, the service will choose a number of threads (according to the number of cores on the selected machine type for batch, or 1 by convention for streaming). |
| "numWorkers": 42, # Number of Google Compute Engine workers in this pool needed to execute the job. If zero or unspecified, the service will attempt to choose a reasonable default. |
| "onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google Compute Engine API. |
| "packages": [ # Packages to be installed on workers. |
| { # The packages that must be installed in order for a worker to run the steps of the Cloud Dataflow job that will be assigned to its worker pool. This is the mechanism by which the Cloud Dataflow SDK causes code to be loaded onto the workers. For example, the Cloud Dataflow Java SDK might use this to install jars containing the user's code and all of the various dependencies (libraries, data files, etc.) required in order for that code to run. |
| "location": "A String", # The resource to read the package from. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket} bucket.storage.googleapis.com/ |
| "name": "A String", # The name of the package. |
| }, |
| ], |
| "poolArgs": { # Extra arguments for this worker pool. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| "sdkHarnessContainerImages": [ # Set of SDK harness containers needed to execute this pipeline. This will only be set in the Fn API path. For non-cross-language pipelines this should have only one entry. Cross-language pipelines will have two or more entries. |
| { # Defines a SDK harness container for executing Dataflow pipelines. |
| "containerImage": "A String", # A docker container image that resides in Google Container Registry. |
| "environmentId": "A String", # Environment ID for the Beam runner API proto Environment that corresponds to the current SDK Harness. |
| "useSingleCorePerContainer": True or False, # If true, recommends the Dataflow service to use only one core per SDK container instance with this image. If false (or unset) recommends using more than one core per SDK container instance with this image for efficiency. Note that Dataflow service may choose to override this property if needed. |
| }, |
| ], |
| "subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of the form "regions/REGION/subnetworks/SUBNETWORK". |
| "taskrunnerSettings": { # Taskrunner configuration settings. # Settings passed through to Google Compute Engine workers when using the standard Dataflow task runner. Users should ignore this field. |
| "alsologtostderr": True or False, # Whether to also send taskrunner log info to stderr. |
| "baseTaskDir": "A String", # The location on the worker for task-specific subdirectories. |
| "baseUrl": "A String", # The base URL for the taskrunner to use when accessing Google Cloud APIs. When workers access Google Cloud APIs, they logically do so via relative URLs. If this field is specified, it supplies the base URL to use for resolving these relative URLs. The normative algorithm used is defined by RFC 1808, "Relative Uniform Resource Locators". If not specified, the default value is "http://www.googleapis.com/" |
| "commandlinesFileName": "A String", # The file to store preprocessing commands in. |
| "continueOnException": True or False, # Whether to continue taskrunner if an exception is hit. |
| "dataflowApiVersion": "A String", # The API version of endpoint, e.g. "v1b3" |
| "harnessCommand": "A String", # The command to launch the worker harness. |
| "languageHint": "A String", # The suggested backend language. |
| "logDir": "A String", # The directory on the VM to store logs. |
| "logToSerialconsole": True or False, # Whether to send taskrunner log info to Google Compute Engine VM serial console. |
| "logUploadLocation": "A String", # Indicates where to put logs. If this is not specified, the logs will not be uploaded. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object} |
| "oauthScopes": [ # The OAuth2 scopes to be requested by the taskrunner in order to access the Cloud Dataflow API. |
| "A String", |
| ], |
| "parallelWorkerSettings": { # Provides data to pass through to the worker harness. # The settings to pass to the parallel worker harness. |
| "baseUrl": "A String", # The base URL for accessing Google Cloud APIs. When workers access Google Cloud APIs, they logically do so via relative URLs. If this field is specified, it supplies the base URL to use for resolving these relative URLs. The normative algorithm used is defined by RFC 1808, "Relative Uniform Resource Locators". If not specified, the default value is "http://www.googleapis.com/" |
| "reportingEnabled": True or False, # Whether to send work progress updates to the service. |
| "servicePath": "A String", # The Cloud Dataflow service path relative to the root URL, for example, "dataflow/v1b3/projects". |
| "shuffleServicePath": "A String", # The Shuffle service path relative to the root URL, for example, "shuffle/v1beta1". |
| "tempStoragePrefix": "A String", # The prefix of the resources the system should use for temporary storage. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object} |
| "workerId": "A String", # The ID of the worker running this pipeline. |
| }, |
| "streamingWorkerMainClass": "A String", # The streaming worker main class name. |
| "taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by taskrunner; e.g. "wheel". |
| "taskUser": "A String", # The UNIX user ID on the worker VM to use for tasks launched by taskrunner; e.g. "root". |
| "tempStoragePrefix": "A String", # The prefix of the resources the taskrunner should use for temporary storage. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object} |
| "vmId": "A String", # The ID string of the VM. |
| "workflowFileName": "A String", # The file to store the workflow in. |
| }, |
| "teardownPolicy": "A String", # Sets the policy for determining when to turndown worker pool. Allowed values are: `TEARDOWN_ALWAYS`, `TEARDOWN_ON_SUCCESS`, and `TEARDOWN_NEVER`. `TEARDOWN_ALWAYS` means workers are always torn down regardless of whether the job succeeds. `TEARDOWN_ON_SUCCESS` means workers are torn down if the job succeeds. `TEARDOWN_NEVER` means the workers are never torn down. If the workers are not torn down by the service, they will continue to run and use Google Compute Engine VM resources in the user's project until they are explicitly terminated by the user. Because of this, Google recommends using the `TEARDOWN_ALWAYS` policy except for small, manually supervised test jobs. If unknown or unspecified, the service will attempt to choose a reasonable default. |
| "workerHarnessContainerImage": "A String", # Required. Docker container image that executes the Cloud Dataflow worker harness, residing in Google Container Registry. Deprecated for the Fn API path. Use sdk_harness_container_images instead. |
| "zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service will attempt to choose a reasonable default. |
| }, |
| ], |
| "workerRegion": "A String", # The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1". Mutually exclusive with worker_zone. If neither worker_region nor worker_zone is specified, default to the control plane's region. |
| "workerZone": "A String", # The Compute Engine zone (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1-a". Mutually exclusive with worker_region. If neither worker_region nor worker_zone is specified, a zone in the control plane's region is chosen based on available capacity. |
| }, |
| "executionInfo": { # Additional information about how a Cloud Dataflow job will be executed that isn't contained in the submitted job. # Deprecated. |
| "stages": { # A mapping from each stage to the information about that stage. |
| "a_key": { # Contains information about how a particular google.dataflow.v1beta3.Step will be executed. |
| "stepName": [ # The steps associated with the execution stage. Note that stages may have several steps, and that a given step might be run by more than one stage. |
| "A String", |
| ], |
| }, |
| }, |
| }, |
| "id": "A String", # The unique ID of this job. This field is set by the Cloud Dataflow service when the Job is created, and is immutable for the life of the job. |
| "jobMetadata": { # Metadata available primarily for filtering jobs. Will be included in the ListJob response and Job SUMMARY view. # This field is populated by the Dataflow service to support filtering jobs by the metadata values provided here. Populated for ListJobs and all GetJob views SUMMARY and higher. |
| "bigTableDetails": [ # Identification of a Cloud Bigtable source used in the Dataflow job. |
| { # Metadata for a Cloud Bigtable connector used by the job. |
| "instanceId": "A String", # InstanceId accessed in the connection. |
| "projectId": "A String", # ProjectId accessed in the connection. |
| "tableId": "A String", # TableId accessed in the connection. |
| }, |
| ], |
| "bigqueryDetails": [ # Identification of a BigQuery source used in the Dataflow job. |
| { # Metadata for a BigQuery connector used by the job. |
| "dataset": "A String", # Dataset accessed in the connection. |
| "projectId": "A String", # Project accessed in the connection. |
| "query": "A String", # Query used to access data in the connection. |
| "table": "A String", # Table accessed in the connection. |
| }, |
| ], |
| "datastoreDetails": [ # Identification of a Datastore source used in the Dataflow job. |
| { # Metadata for a Datastore connector used by the job. |
| "namespace": "A String", # Namespace used in the connection. |
| "projectId": "A String", # ProjectId accessed in the connection. |
| }, |
| ], |
| "fileDetails": [ # Identification of a File source used in the Dataflow job. |
| { # Metadata for a File connector used by the job. |
| "filePattern": "A String", # File Pattern used to access files by the connector. |
| }, |
| ], |
| "pubsubDetails": [ # Identification of a Pub/Sub source used in the Dataflow job. |
| { # Metadata for a Pub/Sub connector used by the job. |
| "subscription": "A String", # Subscription used in the connection. |
| "topic": "A String", # Topic accessed in the connection. |
| }, |
| ], |
| "sdkVersion": { # The version of the SDK used to run the job. # The SDK version used to run the job. |
| "sdkSupportStatus": "A String", # The support status for this SDK version. |
| "version": "A String", # The version of the SDK used to run the job. |
| "versionDisplayName": "A String", # A readable string describing the version of the SDK. |
| }, |
| "spannerDetails": [ # Identification of a Spanner source used in the Dataflow job. |
| { # Metadata for a Spanner connector used by the job. |
| "databaseId": "A String", # DatabaseId accessed in the connection. |
| "instanceId": "A String", # InstanceId accessed in the connection. |
| "projectId": "A String", # ProjectId accessed in the connection. |
| }, |
| ], |
| }, |
| "labels": { # User-defined labels for this job. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: * Keys must conform to regexp: \p{Ll}\p{Lo}{0,62} * Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63} * Both keys and values are additionally constrained to be <= 128 bytes in size. |
| "a_key": "A String", |
| }, |
| "location": "A String", # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job. |
| "name": "A String", # The user-specified Cloud Dataflow job name. Only one Job with a given name may exist in a project at any given time. If a caller attempts to create a Job with the same name as an already-existing Job, the attempt returns the existing Job. The name must match the regular expression `[a-z]([-a-z0-9]{0,38}[a-z0-9])?` |
| "pipelineDescription": { # A descriptive representation of submitted pipeline as well as the executed form. This data is provided by the Dataflow service for ease of visualizing the pipeline and interpreting Dataflow provided metrics. # Preliminary field: The format of this data may change at any time. A description of the user pipeline and stages through which it is executed. Created by Cloud Dataflow service. Only retrieved with JOB_VIEW_DESCRIPTION or JOB_VIEW_ALL. |
| "displayData": [ # Pipeline level display data. |
| { # Data provided with a pipeline or transform to provide descriptive info. |
| "boolValue": True or False, # Contains value if the data is of a boolean type. |
| "durationValue": "A String", # Contains value if the data is of duration type. |
| "floatValue": 3.14, # Contains value if the data is of float type. |
| "int64Value": "A String", # Contains value if the data is of int64 type. |
| "javaClassValue": "A String", # Contains value if the data is of java class type. |
| "key": "A String", # The key identifying the display data. This is intended to be used as a label for the display data when viewed in a dax monitoring system. |
| "label": "A String", # An optional label to display in a dax UI for the element. |
| "namespace": "A String", # The namespace for the key. This is usually a class name or programming language namespace (i.e. python module) which defines the display data. This allows a dax monitoring system to specially handle the data and perform custom rendering. |
| "shortStrValue": "A String", # A possible additional shorter value to display. For example a java_class_name_value of com.mypackage.MyDoFn will be stored with MyDoFn as the short_str_value and com.mypackage.MyDoFn as the java_class_name value. short_str_value can be displayed and java_class_name_value will be displayed as a tooltip. |
| "strValue": "A String", # Contains value if the data is of string type. |
| "timestampValue": "A String", # Contains value if the data is of timestamp type. |
| "url": "A String", # An optional full URL. |
| }, |
| ], |
| "executionPipelineStage": [ # Description of each stage of execution of the pipeline. |
| { # Description of the composing transforms, names/ids, and input/outputs of a stage of execution. Some composing transforms and sources may have been generated by the Dataflow service during execution planning. |
| "componentSource": [ # Collections produced and consumed by component transforms of this stage. |
| { # Description of an interstitial value between transforms in an execution stage. |
| "name": "A String", # Dataflow service generated name for this source. |
| "originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated. |
| "userName": "A String", # Human-readable name for this transform; may be user or system generated. |
| }, |
| ], |
| "componentTransform": [ # Transforms that comprise this execution stage. |
| { # Description of a transform executed as part of an execution stage. |
| "name": "A String", # Dataflow service generated name for this source. |
| "originalTransform": "A String", # User name for the original user transform with which this transform is most closely associated. |
| "userName": "A String", # Human-readable name for this transform; may be user or system generated. |
| }, |
| ], |
| "id": "A String", # Dataflow service generated id for this stage. |
| "inputSource": [ # Input sources for this stage. |
| { # Description of an input or output of an execution stage. |
| "name": "A String", # Dataflow service generated name for this source. |
| "originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated. |
| "sizeBytes": "A String", # Size of the source, if measurable. |
| "userName": "A String", # Human-readable name for this source; may be user or system generated. |
| }, |
| ], |
| "kind": "A String", # Type of transform this stage is executing. |
| "name": "A String", # Dataflow service generated name for this stage. |
| "outputSource": [ # Output sources for this stage. |
| { # Description of an input or output of an execution stage. |
| "name": "A String", # Dataflow service generated name for this source. |
| "originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated. |
| "sizeBytes": "A String", # Size of the source, if measurable. |
| "userName": "A String", # Human-readable name for this source; may be user or system generated. |
| }, |
| ], |
| "prerequisiteStage": [ # Other stages that must complete before this stage can run. |
| "A String", |
| ], |
| }, |
| ], |
| "originalPipelineTransform": [ # Description of each transform in the pipeline and collections between them. |
| { # Description of the type, names/ids, and input/outputs for a transform. |
| "displayData": [ # Transform-specific display data. |
| { # Data provided with a pipeline or transform to provide descriptive info. |
| "boolValue": True or False, # Contains value if the data is of a boolean type. |
| "durationValue": "A String", # Contains value if the data is of duration type. |
| "floatValue": 3.14, # Contains value if the data is of float type. |
| "int64Value": "A String", # Contains value if the data is of int64 type. |
| "javaClassValue": "A String", # Contains value if the data is of java class type. |
| "key": "A String", # The key identifying the display data. This is intended to be used as a label for the display data when viewed in a dax monitoring system. |
| "label": "A String", # An optional label to display in a dax UI for the element. |
| "namespace": "A String", # The namespace for the key. This is usually a class name or programming language namespace (i.e. python module) which defines the display data. This allows a dax monitoring system to specially handle the data and perform custom rendering. |
| "shortStrValue": "A String", # A possible additional shorter value to display. For example a java_class_name_value of com.mypackage.MyDoFn will be stored with MyDoFn as the short_str_value and com.mypackage.MyDoFn as the java_class_name value. short_str_value can be displayed and java_class_name_value will be displayed as a tooltip. |
| "strValue": "A String", # Contains value if the data is of string type. |
| "timestampValue": "A String", # Contains value if the data is of timestamp type. |
| "url": "A String", # An optional full URL. |
| }, |
| ], |
| "id": "A String", # SDK generated id of this transform instance. |
| "inputCollectionName": [ # User names for all collection inputs to this transform. |
| "A String", |
| ], |
| "kind": "A String", # Type of transform. |
| "name": "A String", # User provided name for this transform instance. |
| "outputCollectionName": [ # User names for all collection outputs to this transform. |
| "A String", |
| ], |
| }, |
| ], |
| }, |
| "projectId": "A String", # The ID of the Cloud Platform project that the job belongs to. |
| "replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID of the job it replaced. When sending a `CreateJobRequest`, you can update a job by specifying it here. The job named here is stopped, and its intermediate state is transferred to this job. |
| "replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job. |
| "requestedState": "A String", # The job's requested state. `UpdateJob` may be used to switch between the `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING` states, by setting requested_state. `UpdateJob` may also be used to directly set a job's requested state to `JOB_STATE_CANCELLED` or `JOB_STATE_DONE`, irrevocably terminating the job if it has not already reached a terminal state. |
| "satisfiesPzs": True or False, # Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests. |
| "stageStates": [ # This field may be mutated by the Cloud Dataflow service; callers cannot mutate it. |
| { # A message describing the state of a particular execution stage. |
| "currentStateTime": "A String", # The time at which the stage transitioned to this state. |
| "executionStageName": "A String", # The name of the execution stage. |
| "executionStageState": "A String", # Executions stage states allow the same set of values as JobState. |
| }, |
| ], |
| "startTime": "A String", # The timestamp when the job was started (transitioned to JOB_STATE_PENDING). Flexible resource scheduling jobs are started with some delay after job creation, so start_time is unset before start and is updated when the job is started by the Cloud Dataflow service. For other jobs, start_time always equals to create_time and is immutable and set by the Cloud Dataflow service. |
| "steps": [ # Exactly one of step or steps_location should be specified. The top-level steps that constitute the entire job. Only retrieved with JOB_VIEW_ALL. |
| { # Defines a particular step within a Cloud Dataflow job. A job consists of multiple steps, each of which performs some specific operation as part of the overall job. Data is typically passed from one step to another as part of the job. Here's an example of a sequence of steps which together implement a Map-Reduce job: * Read a collection of data from some source, parsing the collection's elements. * Validate the elements. * Apply a user-defined function to map each element to some value and extract an element-specific key value. * Group elements with the same key into a single element with that key, transforming a multiply-keyed collection into a uniquely-keyed collection. * Write the elements out to some data sink. Note that the Cloud Dataflow service may be used to run many different types of jobs, not just Map-Reduce. |
| "kind": "A String", # The kind of step in the Cloud Dataflow job. |
| "name": "A String", # The name that identifies the step. This must be unique for each step with respect to all other steps in the Cloud Dataflow job. |
| "properties": { # Named properties associated with the step. Each kind of predefined step has its own required set of properties. Must be provided on Create. Only retrieved with JOB_VIEW_ALL. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| ], |
| "stepsLocation": "A String", # The Cloud Storage location where the steps are stored. |
| "tempFiles": [ # A set of files the system should be aware of that are used for temporary storage. These temporary files will be removed on job completion. No duplicates are allowed. No file patterns are supported. The supported files are: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object} |
| "A String", |
| ], |
| "transformNameMapping": { # The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job. |
| "a_key": "A String", |
| }, |
| "type": "A String", # The type of Cloud Dataflow job. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(projectId, gcsPath=None, location=None, view=None, x__xgafv=None)</code> |
| <pre>Get the template associated with a template. |
| |
| Args: |
| projectId: string, Required. The ID of the Cloud Platform project that the job belongs to. (required) |
| gcsPath: string, Required. A Cloud Storage path to the template from which to create the job. Must be valid Cloud Storage URL, beginning with 'gs://'. |
| location: string, The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request. |
| view: string, The view to retrieve. Defaults to METADATA_ONLY. |
| Allowed values |
| METADATA_ONLY - Template view that retrieves only the metadata associated with the template. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # The response to a GetTemplate request. |
| "metadata": { # Metadata describing a template. # The template metadata describing the template name, available parameters, etc. |
| "description": "A String", # Optional. A description of the template. |
| "name": "A String", # Required. The name of the template. |
| "parameters": [ # The parameters for the template. |
| { # Metadata for a specific parameter. |
| "customMetadata": { # Optional. Additional metadata for describing this parameter. |
| "a_key": "A String", |
| }, |
| "helpText": "A String", # Required. The help text to display for the parameter. |
| "isOptional": True or False, # Optional. Whether the parameter is optional. Defaults to false. |
| "label": "A String", # Required. The label to display for the parameter. |
| "name": "A String", # Required. The name of the parameter. |
| "paramType": "A String", # Optional. The type of the parameter. Used for selecting input picker. |
| "regexes": [ # Optional. Regexes that the parameter must match. |
| "A String", |
| ], |
| }, |
| ], |
| }, |
| "runtimeMetadata": { # RuntimeMetadata describing a runtime environment. # Describes the runtime metadata with SDKInfo and available parameters. |
| "parameters": [ # The parameters for the template. |
| { # Metadata for a specific parameter. |
| "customMetadata": { # Optional. Additional metadata for describing this parameter. |
| "a_key": "A String", |
| }, |
| "helpText": "A String", # Required. The help text to display for the parameter. |
| "isOptional": True or False, # Optional. Whether the parameter is optional. Defaults to false. |
| "label": "A String", # Required. The label to display for the parameter. |
| "name": "A String", # Required. The name of the parameter. |
| "paramType": "A String", # Optional. The type of the parameter. Used for selecting input picker. |
| "regexes": [ # Optional. Regexes that the parameter must match. |
| "A String", |
| ], |
| }, |
| ], |
| "sdkInfo": { # SDK Information. # SDK Info for the template. |
| "language": "A String", # Required. The SDK Language. |
| "version": "A String", # Optional. The SDK version. |
| }, |
| }, |
| "status": { # 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](https://github.com/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](https://cloud.google.com/apis/design/errors). # The status of the get template request. Any problems with the request will be indicated in the error_details. |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. |
| }, |
| "templateType": "A String", # Template Type. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="launch">launch(projectId, body=None, dynamicTemplate_gcsPath=None, dynamicTemplate_stagingLocation=None, gcsPath=None, location=None, validateOnly=None, x__xgafv=None)</code> |
| <pre>Launch a template. |
| |
| Args: |
| projectId: string, Required. The ID of the Cloud Platform project that the job belongs to. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Parameters to provide to the template being launched. |
| "environment": { # The environment values to set at runtime. # The runtime environment for the job. |
| "additionalExperiments": [ # Additional experiment flags for the job, specified with the `--experiments` option. |
| "A String", |
| ], |
| "additionalUserLabels": { # Additional user labels to be specified for the job. Keys and values should follow the restrictions specified in the [labeling restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) page. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1kg", "count": "3" }. |
| "a_key": "A String", |
| }, |
| "bypassTempDirValidation": True or False, # Whether to bypass the safety checks for the job's temporary directory. Use with caution. |
| "enableStreamingEngine": True or False, # Whether to enable Streaming Engine for the job. |
| "ipConfiguration": "A String", # Configuration for VM IPs. |
| "kmsKeyName": "A String", # Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/ |
| "machineType": "A String", # The machine type to use for the job. Defaults to the value from the template if not specified. |
| "maxWorkers": 42, # The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000. |
| "network": "A String", # Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default". |
| "numWorkers": 42, # The initial number of Google Compute Engine instnaces for the job. |
| "serviceAccountEmail": "A String", # The email address of the service account to run the job as. |
| "subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. You can specify a subnetwork using either a complete URL or an abbreviated path. Expected to be of the form "https://www.googleapis.com/compute/v1/projects/HOST_PROJECT_ID/regions/REGION/subnetworks/SUBNETWORK" or "regions/REGION/subnetworks/SUBNETWORK". If the subnetwork is located in a Shared VPC network, you must use the complete URL. |
| "tempLocation": "A String", # The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`. |
| "workerRegion": "A String", # The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1". Mutually exclusive with worker_zone. If neither worker_region nor worker_zone is specified, default to the control plane's region. |
| "workerZone": "A String", # The Compute Engine zone (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1-a". Mutually exclusive with worker_region. If neither worker_region nor worker_zone is specified, a zone in the control plane's region is chosen based on available capacity. If both `worker_zone` and `zone` are set, `worker_zone` takes precedence. |
| "zone": "A String", # The Compute Engine [availability zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones) for launching worker instances to run your pipeline. In the future, worker_zone will take precedence. |
| }, |
| "jobName": "A String", # Required. The job name to use for the created job. |
| "parameters": { # The runtime parameters to pass to the job. |
| "a_key": "A String", |
| }, |
| "transformNameMapping": { # Only applicable when updating a pipeline. Map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job. |
| "a_key": "A String", |
| }, |
| "update": True or False, # If set, replace the existing pipeline with the name specified by jobName with this pipeline, preserving state. |
| } |
| |
| dynamicTemplate_gcsPath: string, Path to dynamic template spec file on Cloud Storage. The file must be a Json serialized DynamicTemplateFieSpec object. |
| dynamicTemplate_stagingLocation: string, Cloud Storage path for staging dependencies. Must be a valid Cloud Storage URL, beginning with `gs://`. |
| gcsPath: string, A Cloud Storage path to the template from which to create the job. Must be valid Cloud Storage URL, beginning with 'gs://'. |
| location: string, The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request. |
| validateOnly: boolean, If true, the request is validated but not actually executed. Defaults to false. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response to the request to launch a template. |
| "job": { # Defines a job to be run by the Cloud Dataflow service. nextID: 26 # The job that was launched, if the request was not a dry run and the job was successfully launched. |
| "clientRequestId": "A String", # The client's unique identifier of the job, re-used across retried attempts. If this field is set, the service will ensure its uniqueness. The request to create a job will fail if the service has knowledge of a previously submitted job with the same client's ID and job name. The caller may use this field to ensure idempotence of job creation across retried attempts to create a job. By default, the field is empty and, in that case, the service ignores it. |
| "createTime": "A String", # The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service. |
| "createdFromSnapshotId": "A String", # If this is specified, the job's initial state is populated from the given snapshot. |
| "currentState": "A String", # The current state of the job. Jobs are created in the `JOB_STATE_STOPPED` state unless otherwise specified. A job in the `JOB_STATE_RUNNING` state may asynchronously enter a terminal state. After a job has reached a terminal state, no further state updates may be made. This field may be mutated by the Cloud Dataflow service; callers cannot mutate it. |
| "currentStateTime": "A String", # The timestamp associated with the current state. |
| "environment": { # Describes the environment in which a Dataflow Job runs. # The environment for the job. |
| "clusterManagerApiService": "A String", # The type of cluster manager API to use. If unknown or unspecified, the service will attempt to choose a reasonable default. This should be in the form of the API service name, e.g. "compute.googleapis.com". |
| "dataset": "A String", # The dataset for the current project where various workflow related tables are stored. The supported resource type is: Google BigQuery: bigquery.googleapis.com/{dataset} |
| "debugOptions": { # Describes any options that have an effect on the debugging of pipelines. # Any debugging options to be supplied to the job. |
| "enableHotKeyLogging": True or False, # When true, enables the logging of the literal hot key to the user's Cloud Logging. |
| }, |
| "experiments": [ # The list of experiments to enable. This field should be used for SDK related experiments and not for service related experiments. The proper field for service related experiments is service_options. |
| "A String", |
| ], |
| "flexResourceSchedulingGoal": "A String", # Which Flexible Resource Scheduling mode to run in. |
| "internalExperiments": { # Experimental settings. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| "sdkPipelineOptions": { # The Cloud Dataflow SDK pipeline options specified by the user. These options are passed through the service and are used to recreate the SDK pipeline options on the worker in a language agnostic and platform independent way. |
| "a_key": "", # Properties of the object. |
| }, |
| "serviceAccountEmail": "A String", # Identity to run virtual machines as. Defaults to the default account. |
| "serviceKmsKeyName": "A String", # If set, contains the Cloud KMS key identifier used to encrypt data at rest, AKA a Customer Managed Encryption Key (CMEK). Format: projects/PROJECT_ID/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/KEY |
| "serviceOptions": [ # The list of service options to enable. This field should be used for service related experiments only. These experiments, when graduating to GA, should be replaced by dedicated fields or become default (i.e. always on). |
| "A String", |
| ], |
| "shuffleMode": "A String", # Output only. The shuffle mode used for the job. |
| "tempStoragePrefix": "A String", # The prefix of the resources the system should use for temporary storage. The system will append the suffix "/temp-{JOBNAME} to this resource prefix, where {JOBNAME} is the value of the job_name field. The resulting bucket and object prefix is used as the prefix of the resources used to store temporary data needed during the job execution. NOTE: This will override the value in taskrunner_settings. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object} |
| "userAgent": { # A description of the process that generated the request. |
| "a_key": "", # Properties of the object. |
| }, |
| "version": { # A structure describing which components and their versions of the service are required in order to run the job. |
| "a_key": "", # Properties of the object. |
| }, |
| "workerPools": [ # The worker pools. At least one "harness" worker pool must be specified in order for the job to have workers. |
| { # Describes one particular pool of Cloud Dataflow workers to be instantiated by the Cloud Dataflow service in order to perform the computations required by a job. Note that a workflow job may use multiple pools, in order to match the various computational requirements of the various stages of the job. |
| "autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool. |
| "algorithm": "A String", # The algorithm to use for autoscaling. |
| "maxNumWorkers": 42, # The maximum number of workers to cap scaling at. |
| }, |
| "dataDisks": [ # Data disks that are used by a VM in this workflow. |
| { # Describes the data disk used by a workflow job. |
| "diskType": "A String", # Disk storage type, as defined by Google Compute Engine. This must be a disk type appropriate to the project and zone in which the workers will run. If unknown or unspecified, the service will attempt to choose a reasonable default. For example, the standard persistent disk type is a resource name typically ending in "pd-standard". If SSD persistent disks are available, the resource name typically ends with "pd-ssd". The actual valid values are defined the Google Compute Engine API, not by the Cloud Dataflow API; consult the Google Compute Engine documentation for more information about determining the set of available disk types for a particular project and zone. Google Compute Engine Disk types are local to a particular project in a particular zone, and so the resource name will typically look something like this: compute.googleapis.com/projects/project-id/zones/zone/diskTypes/pd-standard |
| "mountPoint": "A String", # Directory in a VM where disk is mounted. |
| "sizeGb": 42, # Size of disk in GB. If zero or unspecified, the service will attempt to choose a reasonable default. |
| }, |
| ], |
| "defaultPackageSet": "A String", # The default package set to install. This allows the service to select a default set of packages which are useful to worker harnesses written in a particular language. |
| "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default. |
| "diskSourceImage": "A String", # Fully qualified source image for disks. |
| "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default. |
| "ipConfiguration": "A String", # Configuration for VM IPs. |
| "kind": "A String", # The kind of the worker pool; currently only `harness` and `shuffle` are supported. |
| "machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the service will attempt to choose a reasonable default. |
| "metadata": { # Metadata to set on the Google Compute Engine VMs. |
| "a_key": "A String", |
| }, |
| "network": "A String", # Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default". |
| "numThreadsPerWorker": 42, # The number of threads per worker harness. If empty or unspecified, the service will choose a number of threads (according to the number of cores on the selected machine type for batch, or 1 by convention for streaming). |
| "numWorkers": 42, # Number of Google Compute Engine workers in this pool needed to execute the job. If zero or unspecified, the service will attempt to choose a reasonable default. |
| "onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google Compute Engine API. |
| "packages": [ # Packages to be installed on workers. |
| { # The packages that must be installed in order for a worker to run the steps of the Cloud Dataflow job that will be assigned to its worker pool. This is the mechanism by which the Cloud Dataflow SDK causes code to be loaded onto the workers. For example, the Cloud Dataflow Java SDK might use this to install jars containing the user's code and all of the various dependencies (libraries, data files, etc.) required in order for that code to run. |
| "location": "A String", # The resource to read the package from. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket} bucket.storage.googleapis.com/ |
| "name": "A String", # The name of the package. |
| }, |
| ], |
| "poolArgs": { # Extra arguments for this worker pool. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| "sdkHarnessContainerImages": [ # Set of SDK harness containers needed to execute this pipeline. This will only be set in the Fn API path. For non-cross-language pipelines this should have only one entry. Cross-language pipelines will have two or more entries. |
| { # Defines a SDK harness container for executing Dataflow pipelines. |
| "containerImage": "A String", # A docker container image that resides in Google Container Registry. |
| "environmentId": "A String", # Environment ID for the Beam runner API proto Environment that corresponds to the current SDK Harness. |
| "useSingleCorePerContainer": True or False, # If true, recommends the Dataflow service to use only one core per SDK container instance with this image. If false (or unset) recommends using more than one core per SDK container instance with this image for efficiency. Note that Dataflow service may choose to override this property if needed. |
| }, |
| ], |
| "subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of the form "regions/REGION/subnetworks/SUBNETWORK". |
| "taskrunnerSettings": { # Taskrunner configuration settings. # Settings passed through to Google Compute Engine workers when using the standard Dataflow task runner. Users should ignore this field. |
| "alsologtostderr": True or False, # Whether to also send taskrunner log info to stderr. |
| "baseTaskDir": "A String", # The location on the worker for task-specific subdirectories. |
| "baseUrl": "A String", # The base URL for the taskrunner to use when accessing Google Cloud APIs. When workers access Google Cloud APIs, they logically do so via relative URLs. If this field is specified, it supplies the base URL to use for resolving these relative URLs. The normative algorithm used is defined by RFC 1808, "Relative Uniform Resource Locators". If not specified, the default value is "http://www.googleapis.com/" |
| "commandlinesFileName": "A String", # The file to store preprocessing commands in. |
| "continueOnException": True or False, # Whether to continue taskrunner if an exception is hit. |
| "dataflowApiVersion": "A String", # The API version of endpoint, e.g. "v1b3" |
| "harnessCommand": "A String", # The command to launch the worker harness. |
| "languageHint": "A String", # The suggested backend language. |
| "logDir": "A String", # The directory on the VM to store logs. |
| "logToSerialconsole": True or False, # Whether to send taskrunner log info to Google Compute Engine VM serial console. |
| "logUploadLocation": "A String", # Indicates where to put logs. If this is not specified, the logs will not be uploaded. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object} |
| "oauthScopes": [ # The OAuth2 scopes to be requested by the taskrunner in order to access the Cloud Dataflow API. |
| "A String", |
| ], |
| "parallelWorkerSettings": { # Provides data to pass through to the worker harness. # The settings to pass to the parallel worker harness. |
| "baseUrl": "A String", # The base URL for accessing Google Cloud APIs. When workers access Google Cloud APIs, they logically do so via relative URLs. If this field is specified, it supplies the base URL to use for resolving these relative URLs. The normative algorithm used is defined by RFC 1808, "Relative Uniform Resource Locators". If not specified, the default value is "http://www.googleapis.com/" |
| "reportingEnabled": True or False, # Whether to send work progress updates to the service. |
| "servicePath": "A String", # The Cloud Dataflow service path relative to the root URL, for example, "dataflow/v1b3/projects". |
| "shuffleServicePath": "A String", # The Shuffle service path relative to the root URL, for example, "shuffle/v1beta1". |
| "tempStoragePrefix": "A String", # The prefix of the resources the system should use for temporary storage. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object} |
| "workerId": "A String", # The ID of the worker running this pipeline. |
| }, |
| "streamingWorkerMainClass": "A String", # The streaming worker main class name. |
| "taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by taskrunner; e.g. "wheel". |
| "taskUser": "A String", # The UNIX user ID on the worker VM to use for tasks launched by taskrunner; e.g. "root". |
| "tempStoragePrefix": "A String", # The prefix of the resources the taskrunner should use for temporary storage. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object} |
| "vmId": "A String", # The ID string of the VM. |
| "workflowFileName": "A String", # The file to store the workflow in. |
| }, |
| "teardownPolicy": "A String", # Sets the policy for determining when to turndown worker pool. Allowed values are: `TEARDOWN_ALWAYS`, `TEARDOWN_ON_SUCCESS`, and `TEARDOWN_NEVER`. `TEARDOWN_ALWAYS` means workers are always torn down regardless of whether the job succeeds. `TEARDOWN_ON_SUCCESS` means workers are torn down if the job succeeds. `TEARDOWN_NEVER` means the workers are never torn down. If the workers are not torn down by the service, they will continue to run and use Google Compute Engine VM resources in the user's project until they are explicitly terminated by the user. Because of this, Google recommends using the `TEARDOWN_ALWAYS` policy except for small, manually supervised test jobs. If unknown or unspecified, the service will attempt to choose a reasonable default. |
| "workerHarnessContainerImage": "A String", # Required. Docker container image that executes the Cloud Dataflow worker harness, residing in Google Container Registry. Deprecated for the Fn API path. Use sdk_harness_container_images instead. |
| "zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service will attempt to choose a reasonable default. |
| }, |
| ], |
| "workerRegion": "A String", # The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1". Mutually exclusive with worker_zone. If neither worker_region nor worker_zone is specified, default to the control plane's region. |
| "workerZone": "A String", # The Compute Engine zone (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1-a". Mutually exclusive with worker_region. If neither worker_region nor worker_zone is specified, a zone in the control plane's region is chosen based on available capacity. |
| }, |
| "executionInfo": { # Additional information about how a Cloud Dataflow job will be executed that isn't contained in the submitted job. # Deprecated. |
| "stages": { # A mapping from each stage to the information about that stage. |
| "a_key": { # Contains information about how a particular google.dataflow.v1beta3.Step will be executed. |
| "stepName": [ # The steps associated with the execution stage. Note that stages may have several steps, and that a given step might be run by more than one stage. |
| "A String", |
| ], |
| }, |
| }, |
| }, |
| "id": "A String", # The unique ID of this job. This field is set by the Cloud Dataflow service when the Job is created, and is immutable for the life of the job. |
| "jobMetadata": { # Metadata available primarily for filtering jobs. Will be included in the ListJob response and Job SUMMARY view. # This field is populated by the Dataflow service to support filtering jobs by the metadata values provided here. Populated for ListJobs and all GetJob views SUMMARY and higher. |
| "bigTableDetails": [ # Identification of a Cloud Bigtable source used in the Dataflow job. |
| { # Metadata for a Cloud Bigtable connector used by the job. |
| "instanceId": "A String", # InstanceId accessed in the connection. |
| "projectId": "A String", # ProjectId accessed in the connection. |
| "tableId": "A String", # TableId accessed in the connection. |
| }, |
| ], |
| "bigqueryDetails": [ # Identification of a BigQuery source used in the Dataflow job. |
| { # Metadata for a BigQuery connector used by the job. |
| "dataset": "A String", # Dataset accessed in the connection. |
| "projectId": "A String", # Project accessed in the connection. |
| "query": "A String", # Query used to access data in the connection. |
| "table": "A String", # Table accessed in the connection. |
| }, |
| ], |
| "datastoreDetails": [ # Identification of a Datastore source used in the Dataflow job. |
| { # Metadata for a Datastore connector used by the job. |
| "namespace": "A String", # Namespace used in the connection. |
| "projectId": "A String", # ProjectId accessed in the connection. |
| }, |
| ], |
| "fileDetails": [ # Identification of a File source used in the Dataflow job. |
| { # Metadata for a File connector used by the job. |
| "filePattern": "A String", # File Pattern used to access files by the connector. |
| }, |
| ], |
| "pubsubDetails": [ # Identification of a Pub/Sub source used in the Dataflow job. |
| { # Metadata for a Pub/Sub connector used by the job. |
| "subscription": "A String", # Subscription used in the connection. |
| "topic": "A String", # Topic accessed in the connection. |
| }, |
| ], |
| "sdkVersion": { # The version of the SDK used to run the job. # The SDK version used to run the job. |
| "sdkSupportStatus": "A String", # The support status for this SDK version. |
| "version": "A String", # The version of the SDK used to run the job. |
| "versionDisplayName": "A String", # A readable string describing the version of the SDK. |
| }, |
| "spannerDetails": [ # Identification of a Spanner source used in the Dataflow job. |
| { # Metadata for a Spanner connector used by the job. |
| "databaseId": "A String", # DatabaseId accessed in the connection. |
| "instanceId": "A String", # InstanceId accessed in the connection. |
| "projectId": "A String", # ProjectId accessed in the connection. |
| }, |
| ], |
| }, |
| "labels": { # User-defined labels for this job. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: * Keys must conform to regexp: \p{Ll}\p{Lo}{0,62} * Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63} * Both keys and values are additionally constrained to be <= 128 bytes in size. |
| "a_key": "A String", |
| }, |
| "location": "A String", # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job. |
| "name": "A String", # The user-specified Cloud Dataflow job name. Only one Job with a given name may exist in a project at any given time. If a caller attempts to create a Job with the same name as an already-existing Job, the attempt returns the existing Job. The name must match the regular expression `[a-z]([-a-z0-9]{0,38}[a-z0-9])?` |
| "pipelineDescription": { # A descriptive representation of submitted pipeline as well as the executed form. This data is provided by the Dataflow service for ease of visualizing the pipeline and interpreting Dataflow provided metrics. # Preliminary field: The format of this data may change at any time. A description of the user pipeline and stages through which it is executed. Created by Cloud Dataflow service. Only retrieved with JOB_VIEW_DESCRIPTION or JOB_VIEW_ALL. |
| "displayData": [ # Pipeline level display data. |
| { # Data provided with a pipeline or transform to provide descriptive info. |
| "boolValue": True or False, # Contains value if the data is of a boolean type. |
| "durationValue": "A String", # Contains value if the data is of duration type. |
| "floatValue": 3.14, # Contains value if the data is of float type. |
| "int64Value": "A String", # Contains value if the data is of int64 type. |
| "javaClassValue": "A String", # Contains value if the data is of java class type. |
| "key": "A String", # The key identifying the display data. This is intended to be used as a label for the display data when viewed in a dax monitoring system. |
| "label": "A String", # An optional label to display in a dax UI for the element. |
| "namespace": "A String", # The namespace for the key. This is usually a class name or programming language namespace (i.e. python module) which defines the display data. This allows a dax monitoring system to specially handle the data and perform custom rendering. |
| "shortStrValue": "A String", # A possible additional shorter value to display. For example a java_class_name_value of com.mypackage.MyDoFn will be stored with MyDoFn as the short_str_value and com.mypackage.MyDoFn as the java_class_name value. short_str_value can be displayed and java_class_name_value will be displayed as a tooltip. |
| "strValue": "A String", # Contains value if the data is of string type. |
| "timestampValue": "A String", # Contains value if the data is of timestamp type. |
| "url": "A String", # An optional full URL. |
| }, |
| ], |
| "executionPipelineStage": [ # Description of each stage of execution of the pipeline. |
| { # Description of the composing transforms, names/ids, and input/outputs of a stage of execution. Some composing transforms and sources may have been generated by the Dataflow service during execution planning. |
| "componentSource": [ # Collections produced and consumed by component transforms of this stage. |
| { # Description of an interstitial value between transforms in an execution stage. |
| "name": "A String", # Dataflow service generated name for this source. |
| "originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated. |
| "userName": "A String", # Human-readable name for this transform; may be user or system generated. |
| }, |
| ], |
| "componentTransform": [ # Transforms that comprise this execution stage. |
| { # Description of a transform executed as part of an execution stage. |
| "name": "A String", # Dataflow service generated name for this source. |
| "originalTransform": "A String", # User name for the original user transform with which this transform is most closely associated. |
| "userName": "A String", # Human-readable name for this transform; may be user or system generated. |
| }, |
| ], |
| "id": "A String", # Dataflow service generated id for this stage. |
| "inputSource": [ # Input sources for this stage. |
| { # Description of an input or output of an execution stage. |
| "name": "A String", # Dataflow service generated name for this source. |
| "originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated. |
| "sizeBytes": "A String", # Size of the source, if measurable. |
| "userName": "A String", # Human-readable name for this source; may be user or system generated. |
| }, |
| ], |
| "kind": "A String", # Type of transform this stage is executing. |
| "name": "A String", # Dataflow service generated name for this stage. |
| "outputSource": [ # Output sources for this stage. |
| { # Description of an input or output of an execution stage. |
| "name": "A String", # Dataflow service generated name for this source. |
| "originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated. |
| "sizeBytes": "A String", # Size of the source, if measurable. |
| "userName": "A String", # Human-readable name for this source; may be user or system generated. |
| }, |
| ], |
| "prerequisiteStage": [ # Other stages that must complete before this stage can run. |
| "A String", |
| ], |
| }, |
| ], |
| "originalPipelineTransform": [ # Description of each transform in the pipeline and collections between them. |
| { # Description of the type, names/ids, and input/outputs for a transform. |
| "displayData": [ # Transform-specific display data. |
| { # Data provided with a pipeline or transform to provide descriptive info. |
| "boolValue": True or False, # Contains value if the data is of a boolean type. |
| "durationValue": "A String", # Contains value if the data is of duration type. |
| "floatValue": 3.14, # Contains value if the data is of float type. |
| "int64Value": "A String", # Contains value if the data is of int64 type. |
| "javaClassValue": "A String", # Contains value if the data is of java class type. |
| "key": "A String", # The key identifying the display data. This is intended to be used as a label for the display data when viewed in a dax monitoring system. |
| "label": "A String", # An optional label to display in a dax UI for the element. |
| "namespace": "A String", # The namespace for the key. This is usually a class name or programming language namespace (i.e. python module) which defines the display data. This allows a dax monitoring system to specially handle the data and perform custom rendering. |
| "shortStrValue": "A String", # A possible additional shorter value to display. For example a java_class_name_value of com.mypackage.MyDoFn will be stored with MyDoFn as the short_str_value and com.mypackage.MyDoFn as the java_class_name value. short_str_value can be displayed and java_class_name_value will be displayed as a tooltip. |
| "strValue": "A String", # Contains value if the data is of string type. |
| "timestampValue": "A String", # Contains value if the data is of timestamp type. |
| "url": "A String", # An optional full URL. |
| }, |
| ], |
| "id": "A String", # SDK generated id of this transform instance. |
| "inputCollectionName": [ # User names for all collection inputs to this transform. |
| "A String", |
| ], |
| "kind": "A String", # Type of transform. |
| "name": "A String", # User provided name for this transform instance. |
| "outputCollectionName": [ # User names for all collection outputs to this transform. |
| "A String", |
| ], |
| }, |
| ], |
| }, |
| "projectId": "A String", # The ID of the Cloud Platform project that the job belongs to. |
| "replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID of the job it replaced. When sending a `CreateJobRequest`, you can update a job by specifying it here. The job named here is stopped, and its intermediate state is transferred to this job. |
| "replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job. |
| "requestedState": "A String", # The job's requested state. `UpdateJob` may be used to switch between the `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING` states, by setting requested_state. `UpdateJob` may also be used to directly set a job's requested state to `JOB_STATE_CANCELLED` or `JOB_STATE_DONE`, irrevocably terminating the job if it has not already reached a terminal state. |
| "satisfiesPzs": True or False, # Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests. |
| "stageStates": [ # This field may be mutated by the Cloud Dataflow service; callers cannot mutate it. |
| { # A message describing the state of a particular execution stage. |
| "currentStateTime": "A String", # The time at which the stage transitioned to this state. |
| "executionStageName": "A String", # The name of the execution stage. |
| "executionStageState": "A String", # Executions stage states allow the same set of values as JobState. |
| }, |
| ], |
| "startTime": "A String", # The timestamp when the job was started (transitioned to JOB_STATE_PENDING). Flexible resource scheduling jobs are started with some delay after job creation, so start_time is unset before start and is updated when the job is started by the Cloud Dataflow service. For other jobs, start_time always equals to create_time and is immutable and set by the Cloud Dataflow service. |
| "steps": [ # Exactly one of step or steps_location should be specified. The top-level steps that constitute the entire job. Only retrieved with JOB_VIEW_ALL. |
| { # Defines a particular step within a Cloud Dataflow job. A job consists of multiple steps, each of which performs some specific operation as part of the overall job. Data is typically passed from one step to another as part of the job. Here's an example of a sequence of steps which together implement a Map-Reduce job: * Read a collection of data from some source, parsing the collection's elements. * Validate the elements. * Apply a user-defined function to map each element to some value and extract an element-specific key value. * Group elements with the same key into a single element with that key, transforming a multiply-keyed collection into a uniquely-keyed collection. * Write the elements out to some data sink. Note that the Cloud Dataflow service may be used to run many different types of jobs, not just Map-Reduce. |
| "kind": "A String", # The kind of step in the Cloud Dataflow job. |
| "name": "A String", # The name that identifies the step. This must be unique for each step with respect to all other steps in the Cloud Dataflow job. |
| "properties": { # Named properties associated with the step. Each kind of predefined step has its own required set of properties. Must be provided on Create. Only retrieved with JOB_VIEW_ALL. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| ], |
| "stepsLocation": "A String", # The Cloud Storage location where the steps are stored. |
| "tempFiles": [ # A set of files the system should be aware of that are used for temporary storage. These temporary files will be removed on job completion. No duplicates are allowed. No file patterns are supported. The supported files are: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object} |
| "A String", |
| ], |
| "transformNameMapping": { # The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job. |
| "a_key": "A String", |
| }, |
| "type": "A String", # The type of Cloud Dataflow job. |
| }, |
| }</pre> |
| </div> |
| |
| </body></html> |
