diff --git a/docs/dyn/dataflow_v1b3.projects.jobs.html b/docs/dyn/dataflow_v1b3.projects.jobs.html index 8ca79492c27..b2b6665e228 100644 --- a/docs/dyn/dataflow_v1b3.projects.jobs.html +++ b/docs/dyn/dataflow_v1b3.projects.jobs.html @@ -1450,7 +1450,7 @@

Method Details

Returns: An object of the form: - { # 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. + { # 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. "metricTime": "A String", # Timestamp as of which metric values are current. "metrics": [ # All metrics for this job. { # Describes the state of a metric. diff --git a/docs/dyn/dataflow_v1b3.projects.locations.html b/docs/dyn/dataflow_v1b3.projects.locations.html index 884ec1cc9b5..1275b8a5f0d 100644 --- a/docs/dyn/dataflow_v1b3.projects.locations.html +++ b/docs/dyn/dataflow_v1b3.projects.locations.html @@ -89,11 +89,6 @@

Instance Methods

Returns the snapshots Resource.

-

- sql() -

-

Returns the sql Resource.

-

templates()

diff --git a/docs/dyn/dataflow_v1b3.projects.locations.jobs.html b/docs/dyn/dataflow_v1b3.projects.locations.jobs.html index 2bd8df6a999..c5fcf4dbed3 100644 --- a/docs/dyn/dataflow_v1b3.projects.locations.jobs.html +++ b/docs/dyn/dataflow_v1b3.projects.locations.jobs.html @@ -1212,7 +1212,7 @@

Method Details

Returns: An object of the form: - { # 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. + { # 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. "metricTime": "A String", # Timestamp as of which metric values are current. "metrics": [ # All metrics for this job. { # Describes the state of a metric. diff --git a/docs/dyn/dataflow_v1b3.projects.locations.templates.html b/docs/dyn/dataflow_v1b3.projects.locations.templates.html index 790ee10b312..ef10b28926d 100644 --- a/docs/dyn/dataflow_v1b3.projects.locations.templates.html +++ b/docs/dyn/dataflow_v1b3.projects.locations.templates.html @@ -104,26 +104,26 @@

Method Details

{ # 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. + "additionalExperiments": [ # Optional. 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" }. + "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" }. "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 instances 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. + "bypassTempDirValidation": True or False, # Optional. Whether to bypass the safety checks for the job's temporary directory. Use with caution. + "enableStreamingEngine": True or False, # Optional. Whether to enable Streaming Engine for the job. + "ipConfiguration": "A String", # Optional. Configuration for VM IPs. + "kmsKeyName": "A String", # Optional. Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/ + "machineType": "A String", # Optional. The machine type to use for the job. Defaults to the value from the template if not specified. + "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. + "network": "A String", # Optional. Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default". + "numWorkers": 42, # Optional. The initial number of Google Compute Engine instances for the job. The default value is 11. + "serviceAccountEmail": "A String", # Optional. The email address of the service account to run the job as. + "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. + "tempLocation": "A String", # Required. The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`. + "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. + "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. + "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. }, "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. @@ -528,26 +528,26 @@

Method Details

{ # 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. "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. + "additionalExperiments": [ # Optional. 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" }. + "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" }. "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 instances 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. + "bypassTempDirValidation": True or False, # Optional. Whether to bypass the safety checks for the job's temporary directory. Use with caution. + "enableStreamingEngine": True or False, # Optional. Whether to enable Streaming Engine for the job. + "ipConfiguration": "A String", # Optional. Configuration for VM IPs. + "kmsKeyName": "A String", # Optional. Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/ + "machineType": "A String", # Optional. The machine type to use for the job. Defaults to the value from the template if not specified. + "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. + "network": "A String", # Optional. Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default". + "numWorkers": 42, # Optional. The initial number of Google Compute Engine instances for the job. The default value is 11. + "serviceAccountEmail": "A String", # Optional. The email address of the service account to run the job as. + "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. + "tempLocation": "A String", # Required. The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`. + "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. + "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. + "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. }, "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])?` "parameters": { # The runtime parameters to pass to the job. diff --git a/docs/dyn/dataflow_v1b3.projects.templates.html b/docs/dyn/dataflow_v1b3.projects.templates.html index fd31e808e95..01825d35558 100644 --- a/docs/dyn/dataflow_v1b3.projects.templates.html +++ b/docs/dyn/dataflow_v1b3.projects.templates.html @@ -103,26 +103,26 @@

Method Details

{ # 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. + "additionalExperiments": [ # Optional. 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" }. + "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" }. "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 instances 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. + "bypassTempDirValidation": True or False, # Optional. Whether to bypass the safety checks for the job's temporary directory. Use with caution. + "enableStreamingEngine": True or False, # Optional. Whether to enable Streaming Engine for the job. + "ipConfiguration": "A String", # Optional. Configuration for VM IPs. + "kmsKeyName": "A String", # Optional. Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/ + "machineType": "A String", # Optional. The machine type to use for the job. Defaults to the value from the template if not specified. + "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. + "network": "A String", # Optional. Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default". + "numWorkers": 42, # Optional. The initial number of Google Compute Engine instances for the job. The default value is 11. + "serviceAccountEmail": "A String", # Optional. The email address of the service account to run the job as. + "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. + "tempLocation": "A String", # Required. The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`. + "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. + "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. + "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. }, "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. @@ -526,26 +526,26 @@

Method Details

{ # 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. "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. + "additionalExperiments": [ # Optional. 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" }. + "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" }. "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 instances 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. + "bypassTempDirValidation": True or False, # Optional. Whether to bypass the safety checks for the job's temporary directory. Use with caution. + "enableStreamingEngine": True or False, # Optional. Whether to enable Streaming Engine for the job. + "ipConfiguration": "A String", # Optional. Configuration for VM IPs. + "kmsKeyName": "A String", # Optional. Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/ + "machineType": "A String", # Optional. The machine type to use for the job. Defaults to the value from the template if not specified. + "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. + "network": "A String", # Optional. Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default". + "numWorkers": 42, # Optional. The initial number of Google Compute Engine instances for the job. The default value is 11. + "serviceAccountEmail": "A String", # Optional. The email address of the service account to run the job as. + "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. + "tempLocation": "A String", # Required. The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`. + "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. + "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. + "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. }, "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])?` "parameters": { # The runtime parameters to pass to the job. diff --git a/googleapiclient/discovery_cache/documents/dataflow.v1b3.json b/googleapiclient/discovery_cache/documents/dataflow.v1b3.json index 67032c2b836..81acb3af78b 100644 --- a/googleapiclient/discovery_cache/documents/dataflow.v1b3.json +++ b/googleapiclient/discovery_cache/documents/dataflow.v1b3.json @@ -1829,47 +1829,6 @@ } } }, - "sql": { - "methods": { - "validate": { - "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.", - "flatPath": "v1b3/projects/{projectId}/locations/{location}/sql:validate", - "httpMethod": "GET", - "id": "dataflow.projects.locations.sql.validate", - "parameterOrder": [ - "projectId", - "location" - ], - "parameters": { - "location": { - "description": "The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request.", - "location": "path", - "required": true, - "type": "string" - }, - "projectId": { - "description": "Required. The ID of the Cloud Platform project that the job belongs to.", - "location": "path", - "required": true, - "type": "string" - }, - "query": { - "description": "The sql query to validate.", - "location": "query", - "type": "string" - } - }, - "path": "v1b3/projects/{projectId}/locations/{location}/sql:validate", - "response": { - "$ref": "ValidateResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/userinfo.email" - ] - } - } - }, "templates": { "methods": { "create": { @@ -2240,7 +2199,7 @@ } } }, - "revision": "20230106", + "revision": "20230119", "rootUrl": "https://dataflow.googleapis.com/", "schemas": { "ApproximateProgress": { @@ -4065,7 +4024,7 @@ "type": "object" }, "JobMetrics": { - "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.", + "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.", "id": "JobMetrics", "properties": { "metricTime": { @@ -4986,28 +4945,6 @@ }, "type": "object" }, - "QueryInfo": { - "description": "Information about a validated query.", - "id": "QueryInfo", - "properties": { - "queryProperty": { - "description": "Includes an entry for each satisfied QueryProperty.", - "items": { - "enum": [ - "QUERY_PROPERTY_UNSPECIFIED", - "HAS_UNBOUNDED_SOURCE" - ], - "enumDescriptions": [ - "The query property is unknown or unspecified.", - "Indicates this query reads from >= 1 unbounded source." - ], - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, "ReadInstruction": { "description": "An instruction that reads records. Takes no inputs, produces one output.", "id": "ReadInstruction", @@ -5131,7 +5068,7 @@ "id": "RuntimeEnvironment", "properties": { "additionalExperiments": { - "description": "Additional experiment flags for the job, specified with the `--experiments` option.", + "description": "Optional. Additional experiment flags for the job, specified with the `--experiments` option.", "items": { "type": "string" }, @@ -5141,19 +5078,19 @@ "additionalProperties": { "type": "string" }, - "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\" }.", + "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\" }.", "type": "object" }, "bypassTempDirValidation": { - "description": "Whether to bypass the safety checks for the job's temporary directory. Use with caution.", + "description": "Optional. Whether to bypass the safety checks for the job's temporary directory. Use with caution.", "type": "boolean" }, "enableStreamingEngine": { - "description": "Whether to enable Streaming Engine for the job.", + "description": "Optional. Whether to enable Streaming Engine for the job.", "type": "boolean" }, "ipConfiguration": { - "description": "Configuration for VM IPs.", + "description": "Optional. Configuration for VM IPs.", "enum": [ "WORKER_IP_UNSPECIFIED", "WORKER_IP_PUBLIC", @@ -5167,49 +5104,49 @@ "type": "string" }, "kmsKeyName": { - "description": "Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/", + "description": "Optional. Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/", "type": "string" }, "machineType": { - "description": "The machine type to use for the job. Defaults to the value from the template if not specified.", + "description": "Optional. The machine type to use for the job. Defaults to the value from the template if not specified.", "type": "string" }, "maxWorkers": { - "description": "The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000.", + "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.", "format": "int32", "type": "integer" }, "network": { - "description": "Network to which VMs will be assigned. If empty or unspecified, the service will use the network \"default\".", + "description": "Optional. Network to which VMs will be assigned. If empty or unspecified, the service will use the network \"default\".", "type": "string" }, "numWorkers": { - "description": "The initial number of Google Compute Engine instances for the job.", + "description": "Optional. The initial number of Google Compute Engine instances for the job. The default value is 11.", "format": "int32", "type": "integer" }, "serviceAccountEmail": { - "description": "The email address of the service account to run the job as.", + "description": "Optional. The email address of the service account to run the job as.", "type": "string" }, "subnetwork": { - "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.", + "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.", "type": "string" }, "tempLocation": { - "description": "The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`.", + "description": "Required. The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`.", "type": "string" }, "workerRegion": { - "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.", + "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.", "type": "string" }, "workerZone": { - "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.", + "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.", "type": "string" }, "zone": { - "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.", + "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.", "type": "string" } }, @@ -6629,21 +6566,6 @@ }, "type": "object" }, - "ValidateResponse": { - "description": "Response to the validation request.", - "id": "ValidateResponse", - "properties": { - "errorMessage": { - "description": "Will be empty if validation succeeds.", - "type": "string" - }, - "queryInfo": { - "$ref": "QueryInfo", - "description": "Information about the validated query. Not defined if validation fails." - } - }, - "type": "object" - }, "WorkItem": { "description": "WorkItem represents basic information about a WorkItem to be executed in the cloud.", "id": "WorkItem",