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-1
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-1
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-32
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.
Copy file name to clipboardexpand all lines: docs/dyn/dataflow_v1b3.projects.templates.html
+32-32
Original file line number
Diff line number
Diff line change
@@ -103,26 +103,26 @@ <h3>Method Details</h3>
103
103
104
104
{ # A request to create a Cloud Dataflow job from a template.
105
105
"environment": { # The environment values to set at runtime. # The runtime environment for the job.
106
-
"additionalExperiments": [ # Additional experiment flags for the job, specified with the `--experiments` option.
106
+
"additionalExperiments": [ # Optional. Additional experiment flags for the job, specified with the `--experiments` option.
107
107
"A String",
108
108
],
109
-
"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" }.
109
+
"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" }.
110
110
"a_key": "A String",
111
111
},
112
-
"bypassTempDirValidation": True or False, # Whether to bypass the safety checks for the job's temporary directory. Use with caution.
113
-
"enableStreamingEngine": True or False, # Whether to enable Streaming Engine for the job.
114
-
"ipConfiguration": "A String", # Configuration for VM IPs.
115
-
"kmsKeyName": "A String", # Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/
116
-
"machineType": "A String", # The machine type to use for the job. Defaults to the value from the template if not specified.
117
-
"maxWorkers": 42, # The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000.
118
-
"network": "A String", # Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".
119
-
"numWorkers": 42, # The initial number of Google Compute Engine instances for the job.
120
-
"serviceAccountEmail": "A String", # The email address of the service account to run the job as.
121
-
"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.
122
-
"tempLocation": "A String", # The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`.
123
-
"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.
124
-
"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.
125
-
"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.
112
+
"bypassTempDirValidation": True or False, # Optional. Whether to bypass the safety checks for the job's temporary directory. Use with caution.
113
+
"enableStreamingEngine": True or False, # Optional. Whether to enable Streaming Engine for the job.
114
+
"ipConfiguration": "A String", # Optional. Configuration for VM IPs.
115
+
"kmsKeyName": "A String", # Optional. Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/
116
+
"machineType": "A String", # Optional. The machine type to use for the job. Defaults to the value from the template if not specified.
117
+
"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.
118
+
"network": "A String", # Optional. Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".
119
+
"numWorkers": 42, # Optional. The initial number of Google Compute Engine instances for the job. The default value is 11.
120
+
"serviceAccountEmail": "A String", # Optional. The email address of the service account to run the job as.
121
+
"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.
122
+
"tempLocation": "A String", # Required. The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`.
123
+
"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.
124
+
"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.
125
+
"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.
126
126
},
127
127
"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://`.
128
128
"jobName": "A String", # Required. The job name to use for the created job.
@@ -526,26 +526,26 @@ <h3>Method Details</h3>
526
526
527
527
{ # 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.
528
528
"environment": { # The environment values to set at runtime. # The runtime environment for the job.
529
-
"additionalExperiments": [ # Additional experiment flags for the job, specified with the `--experiments` option.
529
+
"additionalExperiments": [ # Optional. Additional experiment flags for the job, specified with the `--experiments` option.
530
530
"A String",
531
531
],
532
-
"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" }.
532
+
"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" }.
533
533
"a_key": "A String",
534
534
},
535
-
"bypassTempDirValidation": True or False, # Whether to bypass the safety checks for the job's temporary directory. Use with caution.
536
-
"enableStreamingEngine": True or False, # Whether to enable Streaming Engine for the job.
537
-
"ipConfiguration": "A String", # Configuration for VM IPs.
538
-
"kmsKeyName": "A String", # Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/
539
-
"machineType": "A String", # The machine type to use for the job. Defaults to the value from the template if not specified.
540
-
"maxWorkers": 42, # The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000.
541
-
"network": "A String", # Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".
542
-
"numWorkers": 42, # The initial number of Google Compute Engine instances for the job.
543
-
"serviceAccountEmail": "A String", # The email address of the service account to run the job as.
544
-
"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.
545
-
"tempLocation": "A String", # The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`.
546
-
"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.
547
-
"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.
548
-
"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.
535
+
"bypassTempDirValidation": True or False, # Optional. Whether to bypass the safety checks for the job's temporary directory. Use with caution.
536
+
"enableStreamingEngine": True or False, # Optional. Whether to enable Streaming Engine for the job.
537
+
"ipConfiguration": "A String", # Optional. Configuration for VM IPs.
538
+
"kmsKeyName": "A String", # Optional. Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/
539
+
"machineType": "A String", # Optional. The machine type to use for the job. Defaults to the value from the template if not specified.
540
+
"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.
541
+
"network": "A String", # Optional. Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".
542
+
"numWorkers": 42, # Optional. The initial number of Google Compute Engine instances for the job. The default value is 11.
543
+
"serviceAccountEmail": "A String", # Optional. The email address of the service account to run the job as.
544
+
"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.
545
+
"tempLocation": "A String", # Required. The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`.
546
+
"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.
547
+
"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.
548
+
"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.
549
549
},
550
550
"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])?`
551
551
"parameters": { # The runtime parameters to pass to the job.
Copy file name to clipboardexpand all lines: googleapiclient/discovery_cache/documents/dataflow.v1b3.json
+18-96
Original file line number
Diff line number
Diff line change
@@ -1829,47 +1829,6 @@
1829
1829
}
1830
1830
}
1831
1831
},
1832
-
"sql": {
1833
-
"methods": {
1834
-
"validate": {
1835
-
"description": "Validates a GoogleSQL query for Cloud Dataflow syntax. Will always confirm the given query parses correctly, and if able to look up schema information from DataCatalog, will validate that the query analyzes properly as well.",
"description": "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.",
4027
+
"description": "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.",
4069
4028
"id": "JobMetrics",
4070
4029
"properties": {
4071
4030
"metricTime": {
@@ -4986,28 +4945,6 @@
4986
4945
},
4987
4946
"type": "object"
4988
4947
},
4989
-
"QueryInfo": {
4990
-
"description": "Information about a validated query.",
4991
-
"id": "QueryInfo",
4992
-
"properties": {
4993
-
"queryProperty": {
4994
-
"description": "Includes an entry for each satisfied QueryProperty.",
4995
-
"items": {
4996
-
"enum": [
4997
-
"QUERY_PROPERTY_UNSPECIFIED",
4998
-
"HAS_UNBOUNDED_SOURCE"
4999
-
],
5000
-
"enumDescriptions": [
5001
-
"The query property is unknown or unspecified.",
5002
-
"Indicates this query reads from >= 1 unbounded source."
5003
-
],
5004
-
"type": "string"
5005
-
},
5006
-
"type": "array"
5007
-
}
5008
-
},
5009
-
"type": "object"
5010
-
},
5011
4948
"ReadInstruction": {
5012
4949
"description": "An instruction that reads records. Takes no inputs, produces one output.",
5013
4950
"id": "ReadInstruction",
@@ -5131,7 +5068,7 @@
5131
5068
"id": "RuntimeEnvironment",
5132
5069
"properties": {
5133
5070
"additionalExperiments": {
5134
-
"description": "Additional experiment flags for the job, specified with the `--experiments` option.",
5071
+
"description": "Optional. Additional experiment flags for the job, specified with the `--experiments` option.",
5135
5072
"items": {
5136
5073
"type": "string"
5137
5074
},
@@ -5141,19 +5078,19 @@
5141
5078
"additionalProperties": {
5142
5079
"type": "string"
5143
5080
},
5144
-
"description": "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\" }.",
5081
+
"description": "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\" }.",
5145
5082
"type": "object"
5146
5083
},
5147
5084
"bypassTempDirValidation": {
5148
-
"description": "Whether to bypass the safety checks for the job's temporary directory. Use with caution.",
5085
+
"description": "Optional. Whether to bypass the safety checks for the job's temporary directory. Use with caution.",
5149
5086
"type": "boolean"
5150
5087
},
5151
5088
"enableStreamingEngine": {
5152
-
"description": "Whether to enable Streaming Engine for the job.",
5089
+
"description": "Optional. Whether to enable Streaming Engine for the job.",
5153
5090
"type": "boolean"
5154
5091
},
5155
5092
"ipConfiguration": {
5156
-
"description": "Configuration for VM IPs.",
5093
+
"description": "Optional. Configuration for VM IPs.",
5157
5094
"enum": [
5158
5095
"WORKER_IP_UNSPECIFIED",
5159
5096
"WORKER_IP_PUBLIC",
@@ -5167,49 +5104,49 @@
5167
5104
"type": "string"
5168
5105
},
5169
5106
"kmsKeyName": {
5170
-
"description": "Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/",
5107
+
"description": "Optional. Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/",
5171
5108
"type": "string"
5172
5109
},
5173
5110
"machineType": {
5174
-
"description": "The machine type to use for the job. Defaults to the value from the template if not specified.",
5111
+
"description": "Optional. The machine type to use for the job. Defaults to the value from the template if not specified.",
5175
5112
"type": "string"
5176
5113
},
5177
5114
"maxWorkers": {
5178
-
"description": "The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000.",
5115
+
"description": "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.",
5179
5116
"format": "int32",
5180
5117
"type": "integer"
5181
5118
},
5182
5119
"network": {
5183
-
"description": "Network to which VMs will be assigned. If empty or unspecified, the service will use the network \"default\".",
5120
+
"description": "Optional. Network to which VMs will be assigned. If empty or unspecified, the service will use the network \"default\".",
5184
5121
"type": "string"
5185
5122
},
5186
5123
"numWorkers": {
5187
-
"description": "The initial number of Google Compute Engine instances for the job.",
5124
+
"description": "Optional. The initial number of Google Compute Engine instances for the job. The default value is 11.",
5188
5125
"format": "int32",
5189
5126
"type": "integer"
5190
5127
},
5191
5128
"serviceAccountEmail": {
5192
-
"description": "The email address of the service account to run the job as.",
5129
+
"description": "Optional. The email address of the service account to run the job as.",
5193
5130
"type": "string"
5194
5131
},
5195
5132
"subnetwork": {
5196
-
"description": "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.",
5133
+
"description": "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.",
5197
5134
"type": "string"
5198
5135
},
5199
5136
"tempLocation": {
5200
-
"description": "The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`.",
5137
+
"description": "Required. The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`.",
5201
5138
"type": "string"
5202
5139
},
5203
5140
"workerRegion": {
5204
-
"description": "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.",
5141
+
"description": "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.",
5205
5142
"type": "string"
5206
5143
},
5207
5144
"workerZone": {
5208
-
"description": "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.",
5145
+
"description": "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.",
5209
5146
"type": "string"
5210
5147
},
5211
5148
"zone": {
5212
-
"description": "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.",
5149
+
"description": "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.",
5213
5150
"type": "string"
5214
5151
}
5215
5152
},
@@ -6629,21 +6566,6 @@
6629
6566
},
6630
6567
"type": "object"
6631
6568
},
6632
-
"ValidateResponse": {
6633
-
"description": "Response to the validation request.",
6634
-
"id": "ValidateResponse",
6635
-
"properties": {
6636
-
"errorMessage": {
6637
-
"description": "Will be empty if validation succeeds.",
6638
-
"type": "string"
6639
-
},
6640
-
"queryInfo": {
6641
-
"$ref": "QueryInfo",
6642
-
"description": "Information about the validated query. Not defined if validation fails."
6643
-
}
6644
-
},
6645
-
"type": "object"
6646
-
},
6647
6569
"WorkItem": {
6648
6570
"description": "WorkItem represents basic information about a WorkItem to be executed in the cloud.",
0 commit comments