Skip to content

Commit ab7a6d7

Browse files
feat(dataflow): update the api
#### dataflow:v1b3 The following keys were deleted: - resources.projects.resources.locations.resources.sql.methods.validate (Total Keys: 15) - schemas.QueryInfo (Total Keys: 4) - schemas.ValidateResponse (Total Keys: 4)
1 parent 512fa51 commit ab7a6d7

6 files changed

+84
-167
lines changed

docs/dyn/dataflow_v1b3.projects.jobs.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1450,7 +1450,7 @@ <h3>Method Details</h3>
14501450
Returns:
14511451
An object of the form:
14521452

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.
14541454
&quot;metricTime&quot;: &quot;A String&quot;, # Timestamp as of which metric values are current.
14551455
&quot;metrics&quot;: [ # All metrics for this job.
14561456
{ # Describes the state of a metric.

docs/dyn/dataflow_v1b3.projects.locations.html

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -89,11 +89,6 @@ <h2>Instance Methods</h2>
8989
</p>
9090
<p class="firstline">Returns the snapshots Resource.</p>
9191

92-
<p class="toc_element">
93-
<code><a href="dataflow_v1b3.projects.locations.sql.html">sql()</a></code>
94-
</p>
95-
<p class="firstline">Returns the sql Resource.</p>
96-
9792
<p class="toc_element">
9893
<code><a href="dataflow_v1b3.projects.locations.templates.html">templates()</a></code>
9994
</p>

docs/dyn/dataflow_v1b3.projects.locations.jobs.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1212,7 +1212,7 @@ <h3>Method Details</h3>
12121212
Returns:
12131213
An object of the form:
12141214

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.
12161216
&quot;metricTime&quot;: &quot;A String&quot;, # Timestamp as of which metric values are current.
12171217
&quot;metrics&quot;: [ # All metrics for this job.
12181218
{ # Describes the state of a metric.

docs/dyn/dataflow_v1b3.projects.locations.templates.html

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -104,26 +104,26 @@ <h3>Method Details</h3>
104104

105105
{ # A request to create a Cloud Dataflow job from a template.
106106
&quot;environment&quot;: { # The environment values to set at runtime. # The runtime environment for the job.
107-
&quot;additionalExperiments&quot;: [ # Additional experiment flags for the job, specified with the `--experiments` option.
107+
&quot;additionalExperiments&quot;: [ # Optional. Additional experiment flags for the job, specified with the `--experiments` option.
108108
&quot;A String&quot;,
109109
],
110-
&quot;additionalUserLabels&quot;: { # 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 &quot;key&quot;: value pairs. Example: { &quot;name&quot;: &quot;wrench&quot;, &quot;mass&quot;: &quot;1kg&quot;, &quot;count&quot;: &quot;3&quot; }.
110+
&quot;additionalUserLabels&quot;: { # 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 &quot;key&quot;: value pairs. Example: { &quot;name&quot;: &quot;wrench&quot;, &quot;mass&quot;: &quot;1kg&quot;, &quot;count&quot;: &quot;3&quot; }.
111111
&quot;a_key&quot;: &quot;A String&quot;,
112112
},
113-
&quot;bypassTempDirValidation&quot;: True or False, # Whether to bypass the safety checks for the job&#x27;s temporary directory. Use with caution.
114-
&quot;enableStreamingEngine&quot;: True or False, # Whether to enable Streaming Engine for the job.
115-
&quot;ipConfiguration&quot;: &quot;A String&quot;, # Configuration for VM IPs.
116-
&quot;kmsKeyName&quot;: &quot;A String&quot;, # Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/
117-
&quot;machineType&quot;: &quot;A String&quot;, # The machine type to use for the job. Defaults to the value from the template if not specified.
118-
&quot;maxWorkers&quot;: 42, # The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000.
119-
&quot;network&quot;: &quot;A String&quot;, # Network to which VMs will be assigned. If empty or unspecified, the service will use the network &quot;default&quot;.
120-
&quot;numWorkers&quot;: 42, # The initial number of Google Compute Engine instances for the job.
121-
&quot;serviceAccountEmail&quot;: &quot;A String&quot;, # The email address of the service account to run the job as.
122-
&quot;subnetwork&quot;: &quot;A String&quot;, # 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 &quot;https://www.googleapis.com/compute/v1/projects/HOST_PROJECT_ID/regions/REGION/subnetworks/SUBNETWORK&quot; or &quot;regions/REGION/subnetworks/SUBNETWORK&quot;. If the subnetwork is located in a Shared VPC network, you must use the complete URL.
123-
&quot;tempLocation&quot;: &quot;A String&quot;, # The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`.
124-
&quot;workerRegion&quot;: &quot;A String&quot;, # The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. &quot;us-west1&quot;. Mutually exclusive with worker_zone. If neither worker_region nor worker_zone is specified, default to the control plane&#x27;s region.
125-
&quot;workerZone&quot;: &quot;A String&quot;, # The Compute Engine zone (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. &quot;us-west1-a&quot;. Mutually exclusive with worker_region. If neither worker_region nor worker_zone is specified, a zone in the control plane&#x27;s region is chosen based on available capacity. If both `worker_zone` and `zone` are set, `worker_zone` takes precedence.
126-
&quot;zone&quot;: &quot;A String&quot;, # 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+
&quot;bypassTempDirValidation&quot;: True or False, # Optional. Whether to bypass the safety checks for the job&#x27;s temporary directory. Use with caution.
114+
&quot;enableStreamingEngine&quot;: True or False, # Optional. Whether to enable Streaming Engine for the job.
115+
&quot;ipConfiguration&quot;: &quot;A String&quot;, # Optional. Configuration for VM IPs.
116+
&quot;kmsKeyName&quot;: &quot;A String&quot;, # Optional. Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/
117+
&quot;machineType&quot;: &quot;A String&quot;, # Optional. The machine type to use for the job. Defaults to the value from the template if not specified.
118+
&quot;maxWorkers&quot;: 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+
&quot;network&quot;: &quot;A String&quot;, # Optional. Network to which VMs will be assigned. If empty or unspecified, the service will use the network &quot;default&quot;.
120+
&quot;numWorkers&quot;: 42, # Optional. The initial number of Google Compute Engine instances for the job. The default value is 11.
121+
&quot;serviceAccountEmail&quot;: &quot;A String&quot;, # Optional. The email address of the service account to run the job as.
122+
&quot;subnetwork&quot;: &quot;A String&quot;, # 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 &quot;https://www.googleapis.com/compute/v1/projects/HOST_PROJECT_ID/regions/REGION/subnetworks/SUBNETWORK&quot; or &quot;regions/REGION/subnetworks/SUBNETWORK&quot;. If the subnetwork is located in a Shared VPC network, you must use the complete URL.
123+
&quot;tempLocation&quot;: &quot;A String&quot;, # Required. The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`.
124+
&quot;workerRegion&quot;: &quot;A String&quot;, # Required. The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. &quot;us-west1&quot;. Mutually exclusive with worker_zone. If neither worker_region nor worker_zone is specified, default to the control plane&#x27;s region.
125+
&quot;workerZone&quot;: &quot;A String&quot;, # Optional. The Compute Engine zone (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. &quot;us-west1-a&quot;. Mutually exclusive with worker_region. If neither worker_region nor worker_zone is specified, a zone in the control plane&#x27;s region is chosen based on available capacity. If both `worker_zone` and `zone` are set, `worker_zone` takes precedence.
126+
&quot;zone&quot;: &quot;A String&quot;, # 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.
127127
},
128128
&quot;gcsPath&quot;: &quot;A String&quot;, # Required. A Cloud Storage path to the template from which to create the job. Must be a valid Cloud Storage URL, beginning with `gs://`.
129129
&quot;jobName&quot;: &quot;A String&quot;, # Required. The job name to use for the created job.
@@ -528,26 +528,26 @@ <h3>Method Details</h3>
528528

529529
{ # 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.
530530
&quot;environment&quot;: { # The environment values to set at runtime. # The runtime environment for the job.
531-
&quot;additionalExperiments&quot;: [ # Additional experiment flags for the job, specified with the `--experiments` option.
531+
&quot;additionalExperiments&quot;: [ # Optional. Additional experiment flags for the job, specified with the `--experiments` option.
532532
&quot;A String&quot;,
533533
],
534-
&quot;additionalUserLabels&quot;: { # 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 &quot;key&quot;: value pairs. Example: { &quot;name&quot;: &quot;wrench&quot;, &quot;mass&quot;: &quot;1kg&quot;, &quot;count&quot;: &quot;3&quot; }.
534+
&quot;additionalUserLabels&quot;: { # 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 &quot;key&quot;: value pairs. Example: { &quot;name&quot;: &quot;wrench&quot;, &quot;mass&quot;: &quot;1kg&quot;, &quot;count&quot;: &quot;3&quot; }.
535535
&quot;a_key&quot;: &quot;A String&quot;,
536536
},
537-
&quot;bypassTempDirValidation&quot;: True or False, # Whether to bypass the safety checks for the job&#x27;s temporary directory. Use with caution.
538-
&quot;enableStreamingEngine&quot;: True or False, # Whether to enable Streaming Engine for the job.
539-
&quot;ipConfiguration&quot;: &quot;A String&quot;, # Configuration for VM IPs.
540-
&quot;kmsKeyName&quot;: &quot;A String&quot;, # Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/
541-
&quot;machineType&quot;: &quot;A String&quot;, # The machine type to use for the job. Defaults to the value from the template if not specified.
542-
&quot;maxWorkers&quot;: 42, # The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000.
543-
&quot;network&quot;: &quot;A String&quot;, # Network to which VMs will be assigned. If empty or unspecified, the service will use the network &quot;default&quot;.
544-
&quot;numWorkers&quot;: 42, # The initial number of Google Compute Engine instances for the job.
545-
&quot;serviceAccountEmail&quot;: &quot;A String&quot;, # The email address of the service account to run the job as.
546-
&quot;subnetwork&quot;: &quot;A String&quot;, # 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 &quot;https://www.googleapis.com/compute/v1/projects/HOST_PROJECT_ID/regions/REGION/subnetworks/SUBNETWORK&quot; or &quot;regions/REGION/subnetworks/SUBNETWORK&quot;. If the subnetwork is located in a Shared VPC network, you must use the complete URL.
547-
&quot;tempLocation&quot;: &quot;A String&quot;, # The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`.
548-
&quot;workerRegion&quot;: &quot;A String&quot;, # The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. &quot;us-west1&quot;. Mutually exclusive with worker_zone. If neither worker_region nor worker_zone is specified, default to the control plane&#x27;s region.
549-
&quot;workerZone&quot;: &quot;A String&quot;, # The Compute Engine zone (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. &quot;us-west1-a&quot;. Mutually exclusive with worker_region. If neither worker_region nor worker_zone is specified, a zone in the control plane&#x27;s region is chosen based on available capacity. If both `worker_zone` and `zone` are set, `worker_zone` takes precedence.
550-
&quot;zone&quot;: &quot;A String&quot;, # 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+
&quot;bypassTempDirValidation&quot;: True or False, # Optional. Whether to bypass the safety checks for the job&#x27;s temporary directory. Use with caution.
538+
&quot;enableStreamingEngine&quot;: True or False, # Optional. Whether to enable Streaming Engine for the job.
539+
&quot;ipConfiguration&quot;: &quot;A String&quot;, # Optional. Configuration for VM IPs.
540+
&quot;kmsKeyName&quot;: &quot;A String&quot;, # Optional. Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/
541+
&quot;machineType&quot;: &quot;A String&quot;, # Optional. The machine type to use for the job. Defaults to the value from the template if not specified.
542+
&quot;maxWorkers&quot;: 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+
&quot;network&quot;: &quot;A String&quot;, # Optional. Network to which VMs will be assigned. If empty or unspecified, the service will use the network &quot;default&quot;.
544+
&quot;numWorkers&quot;: 42, # Optional. The initial number of Google Compute Engine instances for the job. The default value is 11.
545+
&quot;serviceAccountEmail&quot;: &quot;A String&quot;, # Optional. The email address of the service account to run the job as.
546+
&quot;subnetwork&quot;: &quot;A String&quot;, # 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 &quot;https://www.googleapis.com/compute/v1/projects/HOST_PROJECT_ID/regions/REGION/subnetworks/SUBNETWORK&quot; or &quot;regions/REGION/subnetworks/SUBNETWORK&quot;. If the subnetwork is located in a Shared VPC network, you must use the complete URL.
547+
&quot;tempLocation&quot;: &quot;A String&quot;, # Required. The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`.
548+
&quot;workerRegion&quot;: &quot;A String&quot;, # Required. The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. &quot;us-west1&quot;. Mutually exclusive with worker_zone. If neither worker_region nor worker_zone is specified, default to the control plane&#x27;s region.
549+
&quot;workerZone&quot;: &quot;A String&quot;, # Optional. The Compute Engine zone (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. &quot;us-west1-a&quot;. Mutually exclusive with worker_region. If neither worker_region nor worker_zone is specified, a zone in the control plane&#x27;s region is chosen based on available capacity. If both `worker_zone` and `zone` are set, `worker_zone` takes precedence.
550+
&quot;zone&quot;: &quot;A String&quot;, # 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.
551551
},
552552
&quot;jobName&quot;: &quot;A String&quot;, # 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])?`
553553
&quot;parameters&quot;: { # The runtime parameters to pass to the job.

0 commit comments

Comments
 (0)