You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/dyn/dataflow_v1b3.projects.jobs.html
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -1450,7 +1450,7 @@ <h3>Method Details</h3>
1450
1450
Returns:
1451
1451
An object of the form:
1452
1452
1453
-
{ # JobMetrics contains a collection of metrics describing the detailed progress of a Dataflow job. Metrics correspond to user-defined and system-defined metrics in the job. This resource captures only the most recent values of each metric; time-series data can be queried for them (under the same metric names) from Cloud Monitoring.
1453
+
{ # JobMetrics contains a collection of metrics describing the detailed progress of a Dataflow job. Metrics correspond to user-defined and system-defined metrics in the job. For more information, see [Dataflow job metrics] (https://cloud.google.com/dataflow/docs/guides/using-monitoring-intf). This resource captures only the most recent values of each metric; time-series data can be queried for them (under the same metric names) from Cloud Monitoring.
1454
1454
"metricTime": "A String", # Timestamp as of which metric values are current.
1455
1455
"metrics": [ # All metrics for this job.
Copy file name to clipboardExpand all lines: docs/dyn/dataflow_v1b3.projects.locations.jobs.html
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -1212,7 +1212,7 @@ <h3>Method Details</h3>
1212
1212
Returns:
1213
1213
An object of the form:
1214
1214
1215
-
{ # JobMetrics contains a collection of metrics describing the detailed progress of a Dataflow job. Metrics correspond to user-defined and system-defined metrics in the job. This resource captures only the most recent values of each metric; time-series data can be queried for them (under the same metric names) from Cloud Monitoring.
1215
+
{ # JobMetrics contains a collection of metrics describing the detailed progress of a Dataflow job. Metrics correspond to user-defined and system-defined metrics in the job. For more information, see [Dataflow job metrics] (https://cloud.google.com/dataflow/docs/guides/using-monitoring-intf). This resource captures only the most recent values of each metric; time-series data can be queried for them (under the same metric names) from Cloud Monitoring.
1216
1216
"metricTime": "A String", # Timestamp as of which metric values are current.
1217
1217
"metrics": [ # All metrics for this job.
Copy file name to clipboardExpand all lines: docs/dyn/dataflow_v1b3.projects.locations.templates.html
+32-32Lines changed: 32 additions & 32 deletions
Original file line number
Diff line number
Diff line change
@@ -104,26 +104,26 @@ <h3>Method Details</h3>
104
104
105
105
{ # A request to create a Cloud Dataflow job from a template.
106
106
"environment": { # The environment values to set at runtime. # The runtime environment for the job.
107
-
"additionalExperiments": [ # Additional experiment flags for the job, specified with the `--experiments` option.
107
+
"additionalExperiments": [ # Optional. Additional experiment flags for the job, specified with the `--experiments` option.
108
108
"A String",
109
109
],
110
-
"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" }.
110
+
"additionalUserLabels": { # Optional. 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" }.
111
111
"a_key": "A String",
112
112
},
113
-
"bypassTempDirValidation": True or False, # Whether to bypass the safety checks for the job's temporary directory. Use with caution.
114
-
"enableStreamingEngine": True or False, # Whether to enable Streaming Engine for the job.
115
-
"ipConfiguration": "A String", # Configuration for VM IPs.
116
-
"kmsKeyName": "A String", # Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/
117
-
"machineType": "A String", # The machine type to use for the job. Defaults to the value from the template if not specified.
118
-
"maxWorkers": 42, # The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000.
119
-
"network": "A String", # Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".
120
-
"numWorkers": 42, # The initial number of Google Compute Engine instances for the job.
121
-
"serviceAccountEmail": "A String", # The email address of the service account to run the job as.
122
-
"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.
123
-
"tempLocation": "A String", # The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`.
124
-
"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.
125
-
"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.
126
-
"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.
113
+
"bypassTempDirValidation": True or False, # Optional. Whether to bypass the safety checks for the job's temporary directory. Use with caution.
114
+
"enableStreamingEngine": True or False, # Optional. Whether to enable Streaming Engine for the job.
115
+
"ipConfiguration": "A String", # Optional. Configuration for VM IPs.
116
+
"kmsKeyName": "A String", # Optional. Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/
117
+
"machineType": "A String", # Optional. The machine type to use for the job. Defaults to the value from the template if not specified.
118
+
"maxWorkers": 42, # Optional. The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000. The default value is 1.
119
+
"network": "A String", # Optional. Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".
120
+
"numWorkers": 42, # Optional. The initial number of Google Compute Engine instances for the job. The default value is 11.
121
+
"serviceAccountEmail": "A String", # Optional. The email address of the service account to run the job as.
122
+
"subnetwork": "A String", # Optional. 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.
123
+
"tempLocation": "A String", # Required. The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`.
124
+
"workerRegion": "A String", # Required. 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.
125
+
"workerZone": "A String", # Optional. 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.
126
+
"zone": "A String", # Optional. 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.
127
127
},
128
128
"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://`.
129
129
"jobName": "A String", # Required. The job name to use for the created job.
@@ -528,26 +528,26 @@ <h3>Method Details</h3>
528
528
529
529
{ # Parameters to provide to the template being launched. Note that the [metadata in the pipeline code] (https://cloud.google.com/dataflow/docs/guides/templates/creating-templates#metadata) determines which runtime parameters are valid.
530
530
"environment": { # The environment values to set at runtime. # The runtime environment for the job.
531
-
"additionalExperiments": [ # Additional experiment flags for the job, specified with the `--experiments` option.
531
+
"additionalExperiments": [ # Optional. Additional experiment flags for the job, specified with the `--experiments` option.
532
532
"A String",
533
533
],
534
-
"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" }.
534
+
"additionalUserLabels": { # Optional. 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" }.
535
535
"a_key": "A String",
536
536
},
537
-
"bypassTempDirValidation": True or False, # Whether to bypass the safety checks for the job's temporary directory. Use with caution.
538
-
"enableStreamingEngine": True or False, # Whether to enable Streaming Engine for the job.
539
-
"ipConfiguration": "A String", # Configuration for VM IPs.
540
-
"kmsKeyName": "A String", # Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/
541
-
"machineType": "A String", # The machine type to use for the job. Defaults to the value from the template if not specified.
542
-
"maxWorkers": 42, # The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000.
543
-
"network": "A String", # Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".
544
-
"numWorkers": 42, # The initial number of Google Compute Engine instances for the job.
545
-
"serviceAccountEmail": "A String", # The email address of the service account to run the job as.
546
-
"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.
547
-
"tempLocation": "A String", # The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`.
548
-
"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.
549
-
"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.
550
-
"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.
537
+
"bypassTempDirValidation": True or False, # Optional. Whether to bypass the safety checks for the job's temporary directory. Use with caution.
538
+
"enableStreamingEngine": True or False, # Optional. Whether to enable Streaming Engine for the job.
539
+
"ipConfiguration": "A String", # Optional. Configuration for VM IPs.
540
+
"kmsKeyName": "A String", # Optional. Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/
541
+
"machineType": "A String", # Optional. The machine type to use for the job. Defaults to the value from the template if not specified.
542
+
"maxWorkers": 42, # Optional. The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000. The default value is 1.
543
+
"network": "A String", # Optional. Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".
544
+
"numWorkers": 42, # Optional. The initial number of Google Compute Engine instances for the job. The default value is 11.
545
+
"serviceAccountEmail": "A String", # Optional. The email address of the service account to run the job as.
546
+
"subnetwork": "A String", # Optional. 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.
547
+
"tempLocation": "A String", # Required. The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`.
548
+
"workerRegion": "A String", # Required. 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.
549
+
"workerZone": "A String", # Optional. 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.
550
+
"zone": "A String", # Optional. 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.
551
551
},
552
552
"jobName": "A String", # Required. The job name to use for the created job. The name must match the regular expression `[a-z]([-a-z0-9]{0,1022}[a-z0-9])?`
553
553
"parameters": { # The runtime parameters to pass to the job.
0 commit comments