chore: Update discovery artifacts (#1587)
## Deleted keys were detected in the following stable discovery artifacts:
bigquery v2 https://github.com/googleapis/google-api-python-client/commit/faedd49d24634e1646e15cb79a983391a6938faa
container v1 https://github.com/googleapis/google-api-python-client/commit/3c92c46132922d77598527fc98780edca5978ce2
gameservices v1 https://github.com/googleapis/google-api-python-client/commit/ea5f2216765868a1d6e48995f23b74709ca5ebef
## Deleted keys were detected in the following pre-stable discovery artifacts:
container v1beta1 https://github.com/googleapis/google-api-python-client/commit/3c92c46132922d77598527fc98780edca5978ce2
gameservices v1beta https://github.com/googleapis/google-api-python-client/commit/ea5f2216765868a1d6e48995f23b74709ca5ebef
## Discovery Artifact Change Summary:
feat(adexchangebuyer2): update the api https://github.com/googleapis/google-api-python-client/commit/49432a596a9d2e0a014afb2c57cc0ceec37aa403
feat(bigquery): update the api https://github.com/googleapis/google-api-python-client/commit/faedd49d24634e1646e15cb79a983391a6938faa
feat(chromemanagement): update the api https://github.com/googleapis/google-api-python-client/commit/89fc0743cff2c64a438339003fc1c8fdf99938dd
feat(cloudbuild): update the api https://github.com/googleapis/google-api-python-client/commit/8c2010464ec7a8aa6ffe8a044ae44ea0ab199f45
feat(compute): update the api https://github.com/googleapis/google-api-python-client/commit/c2acfdbefef85f8a4696ae467bd61d05db25cf31
feat(contactcenterinsights): update the api https://github.com/googleapis/google-api-python-client/commit/04ba8ef034ac1fd69e8e641c585e762e19078806
feat(container): update the api https://github.com/googleapis/google-api-python-client/commit/3c92c46132922d77598527fc98780edca5978ce2
feat(content): update the api https://github.com/googleapis/google-api-python-client/commit/037b9e1d5c9865af22a3c70dc44542ea3ce547dc
feat(datafusion): update the api https://github.com/googleapis/google-api-python-client/commit/fc6d716e71875ea73036e576bbaafb2826e01e1d
feat(dlp): update the api https://github.com/googleapis/google-api-python-client/commit/08353cbe37fc4c0dcc1311efead553797067417e
feat(documentai): update the api https://github.com/googleapis/google-api-python-client/commit/7974abc07dceffbc9fdb5365b706ed5e1a9899fc
feat(firebaseappcheck): update the api https://github.com/googleapis/google-api-python-client/commit/13220f0704b0d5b954520307a6702efead926e5e
feat(gameservices): update the api https://github.com/googleapis/google-api-python-client/commit/ea5f2216765868a1d6e48995f23b74709ca5ebef
feat(gkehub): update the api https://github.com/googleapis/google-api-python-client/commit/f4ae68ff69c32b5708f1e5f735cb03f3184f7650
feat(healthcare): update the api https://github.com/googleapis/google-api-python-client/commit/5c430ab79811ae3565a83d57ba06e0d48560f791
feat(monitoring): update the api https://github.com/googleapis/google-api-python-client/commit/3ad9f05ae340101c6016e4ceeef52661d0c01e21
feat(networkmanagement): update the api https://github.com/googleapis/google-api-python-client/commit/992b9f851e871feb796485e6af936a3d05899e4e
feat(osconfig): update the api https://github.com/googleapis/google-api-python-client/commit/972e716c233348d6e5d686f3718607a42e7d728a
feat(oslogin): update the api https://github.com/googleapis/google-api-python-client/commit/1ba23c68428c3c07a778f25dc9fc10998022c414
feat(paymentsresellersubscription): update the api https://github.com/googleapis/google-api-python-client/commit/cc7fd94a993048d6ca7cc34e42c4536df6eeb93d
feat(recaptchaenterprise): update the api https://github.com/googleapis/google-api-python-client/commit/2da594c083639420e285d70d26483e46df9fa1a0
feat(redis): update the api https://github.com/googleapis/google-api-python-client/commit/c16b96450466eb72e8122fc8aca0ce010a113350
feat(run): update the api https://github.com/googleapis/google-api-python-client/commit/c502728bfd31e520d4f5f06cc763dc2316cbb221
feat(searchconsole): update the api https://github.com/googleapis/google-api-python-client/commit/eede698004d718213b315b3728793a967a92e87b
feat(speech): update the api https://github.com/googleapis/google-api-python-client/commit/9f0148f2f0f035b9e3c7d73dbd95a8f961ef3eb1
feat(tagmanager): update the api https://github.com/googleapis/google-api-python-client/commit/fe4351bca507192a682440fa52f50eb98cef4434
feat(vmmigration): update the api https://github.com/googleapis/google-api-python-client/commit/d8afe7c7e0a556d31dc904e8878c1bf884a375af
diff --git a/docs/dyn/datapipelines_v1.projects.locations.pipelines.html b/docs/dyn/datapipelines_v1.projects.locations.pipelines.html
new file mode 100644
index 0000000..e9b0b0e
--- /dev/null
+++ b/docs/dyn/datapipelines_v1.projects.locations.pipelines.html
@@ -0,0 +1,828 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 em;
+}
+
+.method {
+ margin-top: 1em;
+ border: solid 1px #CCC;
+ padding: 1em;
+ background: #EEE;
+}
+
+.details {
+ font-weight: bold;
+ font-size: 14px;
+}
+
+</style>
+
+<h1><a href="datapipelines_v1.html">Data pipelines API</a> . <a href="datapipelines_v1.projects.html">projects</a> . <a href="datapipelines_v1.projects.locations.html">locations</a> . <a href="datapipelines_v1.projects.locations.pipelines.html">pipelines</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#close">close()</a></code></p>
+<p class="firstline">Close httplib2 connections.</p>
+<p class="toc_element">
+ <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Creates a pipeline. For a batch pipeline, you can pass scheduler information. Data Pipelines uses the scheduler information to create an internal scheduler that runs jobs periodically. If the internal scheduler is not configured, you can use RunPipeline to run jobs.</p>
+<p class="toc_element">
+ <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
+<p class="firstline">Deletes a pipeline. If a scheduler job is attached to the pipeline, it will be deleted.</p>
+<p class="toc_element">
+ <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
+<p class="firstline">Looks up a single pipeline. Returns a "NOT_FOUND" error if no such pipeline exists. Returns a "FORBIDDEN" error if the caller doesn't have permission to access it.</p>
+<p class="toc_element">
+ <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Updates a pipeline. If successful, the updated [Pipeline] is returned. Returns `NOT_FOUND` if the pipeline doesn't exist. If UpdatePipeline does not return successfully, you can retry the UpdatePipeline request until you receive a successful response.</p>
+<p class="toc_element">
+ <code><a href="#run">run(name, body=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Creates a job for the specified pipeline directly. You can use this method when the internal scheduler is not configured and you want to trigger the job directly or through an external system. Returns a "NOT_FOUND" error if the pipeline doesn't exist. Returns a "FOBIDDEN" error if the user doesn't have permission to access the pipeline or run jobs for the pipeline.</p>
+<p class="toc_element">
+ <code><a href="#stop">stop(name, body=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Freezes pipeline execution permanently. If there's a corresponding scheduler entry, it's deleted, and the pipeline state is changed to "ARCHIVED". However, pipeline metadata is retained. Upon success, the pipeline state is updated to ARCHIVED.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="close">close()</code>
+ <pre>Close httplib2 connections.</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
+ <pre>Creates a pipeline. For a batch pipeline, you can pass scheduler information. Data Pipelines uses the scheduler information to create an internal scheduler that runs jobs periodically. If the internal scheduler is not configured, you can use RunPipeline to run jobs.
+
+Args:
+ parent: string, Required. The location name. For example: `projects/PROJECT_ID/locations/LOCATION_ID`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The main pipeline entity and all the needed metadata to launch and manage linked jobs.
+ "createTime": "A String", # Output only. Immutable. The timestamp when the pipeline was initially created. Set by the Data Pipelines service.
+ "displayName": "A String", # Required. The display name of the pipeline. It can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), and underscores (_).
+ "jobCount": 42, # Output only. Number of jobs.
+ "lastUpdateTime": "A String", # Output only. Immutable. The timestamp when the pipeline was last modified. Set by the Data Pipelines service.
+ "name": "A String", # The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), and periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the pipeline's location. The list of available locations can be obtained by calling ListLocations. Note that the Data Pipelines service is not available in all regions. It depends on Cloud Scheduler, an App Engine application, so it's only available in [App Engine regions](https://cloud.google.com/about/locations#region). * `PIPELINE_ID` is the ID of the pipeline. Must be unique for the selected project and location.
+ "scheduleInfo": { # Details of the schedule the pipeline runs on. # Internal scheduling information for a pipeline. If this information is provided, periodic jobs will be created per the schedule. If not, users are responsible for creating jobs externally.
+ "nextJobTime": "A String", # Output only. When the next Scheduler job is going to run.
+ "schedule": "A String", # Unix-cron format of the schedule. This information is retrieved from the linked Cloud Scheduler.
+ "timeZone": "A String", # Timezone ID. This matches the timezone IDs used by the Cloud Scheduler API. If empty, UTC time is assumed.
+ },
+ "schedulerServiceAccountEmail": "A String", # Optional. A service account email to be used with the Cloud Scheduler job. If not specified, the default compute engine service account will be used.
+ "state": "A String", # Required. The state of the pipeline. When the pipeline is created, the state is set to 'PIPELINE_STATE_ACTIVE' by default. State changes can be requested by setting the state to stopping, paused, or resuming. State cannot be changed through UpdatePipeline requests.
+ "type": "A String", # Required. The type of the pipeline. This field affects the scheduling of the pipeline and the type of metrics to show for the pipeline.
+ "workload": { # Workload details for creating the pipeline jobs. # Workload information for creating new jobs.
+ "dataflowFlexTemplateRequest": { # A request to launch a Dataflow job from a Flex Template. # Template information and additional parameters needed to launch a Dataflow job using the flex launch API.
+ "launchParameter": { # Launch Flex Template parameter. # Required. Parameter to launch a job from a Flex Template.
+ "containerSpecGcsPath": "A String", # Cloud Storage path to a file with a JSON-serialized ContainerSpec as content.
+ "environment": { # The environment values to be set at runtime for a Flex Template. # The runtime environment for the Flex Template job.
+ "additionalExperiments": [ # Additional experiment flags for the job.
+ "A String",
+ ],
+ "additionalUserLabels": { # Additional user labels to be specified for the job. Keys and values must follow the restrictions specified in the [labeling restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions). An object containing a list of key/value pairs. Example: `{ "name": "wrench", "mass": "1kg", "count": "3" }`.
+ "a_key": "A String",
+ },
+ "enableStreamingEngine": True or False, # Whether to enable Streaming Engine for the job.
+ "flexrsGoal": "A String", # Set FlexRS goal for the job. https://cloud.google.com/dataflow/docs/guides/flexrs
+ "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 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 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, defaults to the control plane 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 region is chosen based on available capacity. If both `worker_zone` and `zone` are set, `worker_zone` takes precedence.
+ "zone": "A String", # The Compute Engine [availability zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones) for launching worker instances to run your pipeline. In the future, worker_zone will take precedence.
+ },
+ "jobName": "A String", # Required. The job name to use for the created job. For an update job request, the job name should be the same as the existing running job.
+ "launchOptions": { # Launch options for this Flex Template job. This is a common set of options across languages and templates. This should not be used to pass job parameters.
+ "a_key": "A String",
+ },
+ "parameters": { # The parameters for the Flex Template. Example: `{"num_workers":"5"}`
+ "a_key": "A String",
+ },
+ "transformNameMappings": { # Use this to pass transform name mappings for streaming update jobs. Example: `{"oldTransformName":"newTransformName",...}`
+ "a_key": "A String",
+ },
+ "update": True or False, # Set this to true if you are sending a request to update a running streaming job. When set, the job name should be the same as the running job.
+ },
+ "location": "A String", # Required. The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request. For example, `us-central1`, `us-west1`.
+ "projectId": "A String", # Required. The ID of the Cloud Platform project that the job belongs to.
+ "validateOnly": True or False, # If true, the request is validated but not actually executed. Defaults to false.
+ },
+ "dataflowLaunchTemplateRequest": { # A request to launch a template. # Template information and additional parameters needed to launch a Dataflow job using the standard launch API.
+ "gcsPath": "A String", # A Cloud Storage path to the template from which to create the job. Must be a valid Cloud Storage URL, beginning with 'gs://'.
+ "launchParameters": { # Parameters to provide to the template being launched. # The parameters of the template to launch. This should be part of the body of the POST request.
+ "environment": { # The environment values to set at runtime. # The runtime environment for the job.
+ "additionalExperiments": [ # Additional experiment flags for the job.
+ "A String",
+ ],
+ "additionalUserLabels": { # Additional user labels to be specified for the job. Keys and values should follow the restrictions specified in the [labeling restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) page. An object containing a list of key/value pairs. Example: { "name": "wrench", "mass": "1kg", "count": "3" }.
+ "a_key": "A String",
+ },
+ "bypassTempDirValidation": True or False, # Whether to bypass the safety checks for the job's temporary directory. Use with caution.
+ "enableStreamingEngine": True or False, # Whether to enable Streaming Engine for the job.
+ "ipConfiguration": "A String", # Configuration for VM IPs.
+ "kmsKeyName": "A String", # Name for the Cloud KMS key for the job. The 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 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 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.
+ },
+ "jobName": "A String", # Required. The job name to use for the created job.
+ "parameters": { # The runtime parameters to pass to the job.
+ "a_key": "A String",
+ },
+ "transformNameMapping": { # Map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job. Only applicable when updating a pipeline.
+ "a_key": "A String",
+ },
+ "update": True or False, # If set, replace the existing pipeline with the name specified by jobName with this pipeline, preserving state.
+ },
+ "location": "A String", # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request.
+ "projectId": "A String", # Required. The ID of the Cloud Platform project that the job belongs to.
+ "validateOnly": True or False, # If true, the request is validated but not actually executed. Defaults to false.
+ },
+ },
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The main pipeline entity and all the needed metadata to launch and manage linked jobs.
+ "createTime": "A String", # Output only. Immutable. The timestamp when the pipeline was initially created. Set by the Data Pipelines service.
+ "displayName": "A String", # Required. The display name of the pipeline. It can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), and underscores (_).
+ "jobCount": 42, # Output only. Number of jobs.
+ "lastUpdateTime": "A String", # Output only. Immutable. The timestamp when the pipeline was last modified. Set by the Data Pipelines service.
+ "name": "A String", # The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), and periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the pipeline's location. The list of available locations can be obtained by calling ListLocations. Note that the Data Pipelines service is not available in all regions. It depends on Cloud Scheduler, an App Engine application, so it's only available in [App Engine regions](https://cloud.google.com/about/locations#region). * `PIPELINE_ID` is the ID of the pipeline. Must be unique for the selected project and location.
+ "scheduleInfo": { # Details of the schedule the pipeline runs on. # Internal scheduling information for a pipeline. If this information is provided, periodic jobs will be created per the schedule. If not, users are responsible for creating jobs externally.
+ "nextJobTime": "A String", # Output only. When the next Scheduler job is going to run.
+ "schedule": "A String", # Unix-cron format of the schedule. This information is retrieved from the linked Cloud Scheduler.
+ "timeZone": "A String", # Timezone ID. This matches the timezone IDs used by the Cloud Scheduler API. If empty, UTC time is assumed.
+ },
+ "schedulerServiceAccountEmail": "A String", # Optional. A service account email to be used with the Cloud Scheduler job. If not specified, the default compute engine service account will be used.
+ "state": "A String", # Required. The state of the pipeline. When the pipeline is created, the state is set to 'PIPELINE_STATE_ACTIVE' by default. State changes can be requested by setting the state to stopping, paused, or resuming. State cannot be changed through UpdatePipeline requests.
+ "type": "A String", # Required. The type of the pipeline. This field affects the scheduling of the pipeline and the type of metrics to show for the pipeline.
+ "workload": { # Workload details for creating the pipeline jobs. # Workload information for creating new jobs.
+ "dataflowFlexTemplateRequest": { # A request to launch a Dataflow job from a Flex Template. # Template information and additional parameters needed to launch a Dataflow job using the flex launch API.
+ "launchParameter": { # Launch Flex Template parameter. # Required. Parameter to launch a job from a Flex Template.
+ "containerSpecGcsPath": "A String", # Cloud Storage path to a file with a JSON-serialized ContainerSpec as content.
+ "environment": { # The environment values to be set at runtime for a Flex Template. # The runtime environment for the Flex Template job.
+ "additionalExperiments": [ # Additional experiment flags for the job.
+ "A String",
+ ],
+ "additionalUserLabels": { # Additional user labels to be specified for the job. Keys and values must follow the restrictions specified in the [labeling restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions). An object containing a list of key/value pairs. Example: `{ "name": "wrench", "mass": "1kg", "count": "3" }`.
+ "a_key": "A String",
+ },
+ "enableStreamingEngine": True or False, # Whether to enable Streaming Engine for the job.
+ "flexrsGoal": "A String", # Set FlexRS goal for the job. https://cloud.google.com/dataflow/docs/guides/flexrs
+ "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 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 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, defaults to the control plane 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 region is chosen based on available capacity. If both `worker_zone` and `zone` are set, `worker_zone` takes precedence.
+ "zone": "A String", # The Compute Engine [availability zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones) for launching worker instances to run your pipeline. In the future, worker_zone will take precedence.
+ },
+ "jobName": "A String", # Required. The job name to use for the created job. For an update job request, the job name should be the same as the existing running job.
+ "launchOptions": { # Launch options for this Flex Template job. This is a common set of options across languages and templates. This should not be used to pass job parameters.
+ "a_key": "A String",
+ },
+ "parameters": { # The parameters for the Flex Template. Example: `{"num_workers":"5"}`
+ "a_key": "A String",
+ },
+ "transformNameMappings": { # Use this to pass transform name mappings for streaming update jobs. Example: `{"oldTransformName":"newTransformName",...}`
+ "a_key": "A String",
+ },
+ "update": True or False, # Set this to true if you are sending a request to update a running streaming job. When set, the job name should be the same as the running job.
+ },
+ "location": "A String", # Required. The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request. For example, `us-central1`, `us-west1`.
+ "projectId": "A String", # Required. The ID of the Cloud Platform project that the job belongs to.
+ "validateOnly": True or False, # If true, the request is validated but not actually executed. Defaults to false.
+ },
+ "dataflowLaunchTemplateRequest": { # A request to launch a template. # Template information and additional parameters needed to launch a Dataflow job using the standard launch API.
+ "gcsPath": "A String", # A Cloud Storage path to the template from which to create the job. Must be a valid Cloud Storage URL, beginning with 'gs://'.
+ "launchParameters": { # Parameters to provide to the template being launched. # The parameters of the template to launch. This should be part of the body of the POST request.
+ "environment": { # The environment values to set at runtime. # The runtime environment for the job.
+ "additionalExperiments": [ # Additional experiment flags for the job.
+ "A String",
+ ],
+ "additionalUserLabels": { # Additional user labels to be specified for the job. Keys and values should follow the restrictions specified in the [labeling restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) page. An object containing a list of key/value pairs. Example: { "name": "wrench", "mass": "1kg", "count": "3" }.
+ "a_key": "A String",
+ },
+ "bypassTempDirValidation": True or False, # Whether to bypass the safety checks for the job's temporary directory. Use with caution.
+ "enableStreamingEngine": True or False, # Whether to enable Streaming Engine for the job.
+ "ipConfiguration": "A String", # Configuration for VM IPs.
+ "kmsKeyName": "A String", # Name for the Cloud KMS key for the job. The 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 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 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.
+ },
+ "jobName": "A String", # Required. The job name to use for the created job.
+ "parameters": { # The runtime parameters to pass to the job.
+ "a_key": "A String",
+ },
+ "transformNameMapping": { # Map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job. Only applicable when updating a pipeline.
+ "a_key": "A String",
+ },
+ "update": True or False, # If set, replace the existing pipeline with the name specified by jobName with this pipeline, preserving state.
+ },
+ "location": "A String", # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request.
+ "projectId": "A String", # Required. The ID of the Cloud Platform project that the job belongs to.
+ "validateOnly": True or False, # If true, the request is validated but not actually executed. Defaults to false.
+ },
+ },
+}</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="delete">delete(name, x__xgafv=None)</code>
+ <pre>Deletes a pipeline. If a scheduler job is attached to the pipeline, it will be deleted.
+
+Args:
+ name: string, Required. The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
+}</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(name, x__xgafv=None)</code>
+ <pre>Looks up a single pipeline. Returns a "NOT_FOUND" error if no such pipeline exists. Returns a "FORBIDDEN" error if the caller doesn't have permission to access it.
+
+Args:
+ name: string, Required. The pipeeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The main pipeline entity and all the needed metadata to launch and manage linked jobs.
+ "createTime": "A String", # Output only. Immutable. The timestamp when the pipeline was initially created. Set by the Data Pipelines service.
+ "displayName": "A String", # Required. The display name of the pipeline. It can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), and underscores (_).
+ "jobCount": 42, # Output only. Number of jobs.
+ "lastUpdateTime": "A String", # Output only. Immutable. The timestamp when the pipeline was last modified. Set by the Data Pipelines service.
+ "name": "A String", # The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), and periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the pipeline's location. The list of available locations can be obtained by calling ListLocations. Note that the Data Pipelines service is not available in all regions. It depends on Cloud Scheduler, an App Engine application, so it's only available in [App Engine regions](https://cloud.google.com/about/locations#region). * `PIPELINE_ID` is the ID of the pipeline. Must be unique for the selected project and location.
+ "scheduleInfo": { # Details of the schedule the pipeline runs on. # Internal scheduling information for a pipeline. If this information is provided, periodic jobs will be created per the schedule. If not, users are responsible for creating jobs externally.
+ "nextJobTime": "A String", # Output only. When the next Scheduler job is going to run.
+ "schedule": "A String", # Unix-cron format of the schedule. This information is retrieved from the linked Cloud Scheduler.
+ "timeZone": "A String", # Timezone ID. This matches the timezone IDs used by the Cloud Scheduler API. If empty, UTC time is assumed.
+ },
+ "schedulerServiceAccountEmail": "A String", # Optional. A service account email to be used with the Cloud Scheduler job. If not specified, the default compute engine service account will be used.
+ "state": "A String", # Required. The state of the pipeline. When the pipeline is created, the state is set to 'PIPELINE_STATE_ACTIVE' by default. State changes can be requested by setting the state to stopping, paused, or resuming. State cannot be changed through UpdatePipeline requests.
+ "type": "A String", # Required. The type of the pipeline. This field affects the scheduling of the pipeline and the type of metrics to show for the pipeline.
+ "workload": { # Workload details for creating the pipeline jobs. # Workload information for creating new jobs.
+ "dataflowFlexTemplateRequest": { # A request to launch a Dataflow job from a Flex Template. # Template information and additional parameters needed to launch a Dataflow job using the flex launch API.
+ "launchParameter": { # Launch Flex Template parameter. # Required. Parameter to launch a job from a Flex Template.
+ "containerSpecGcsPath": "A String", # Cloud Storage path to a file with a JSON-serialized ContainerSpec as content.
+ "environment": { # The environment values to be set at runtime for a Flex Template. # The runtime environment for the Flex Template job.
+ "additionalExperiments": [ # Additional experiment flags for the job.
+ "A String",
+ ],
+ "additionalUserLabels": { # Additional user labels to be specified for the job. Keys and values must follow the restrictions specified in the [labeling restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions). An object containing a list of key/value pairs. Example: `{ "name": "wrench", "mass": "1kg", "count": "3" }`.
+ "a_key": "A String",
+ },
+ "enableStreamingEngine": True or False, # Whether to enable Streaming Engine for the job.
+ "flexrsGoal": "A String", # Set FlexRS goal for the job. https://cloud.google.com/dataflow/docs/guides/flexrs
+ "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 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 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, defaults to the control plane 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 region is chosen based on available capacity. If both `worker_zone` and `zone` are set, `worker_zone` takes precedence.
+ "zone": "A String", # The Compute Engine [availability zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones) for launching worker instances to run your pipeline. In the future, worker_zone will take precedence.
+ },
+ "jobName": "A String", # Required. The job name to use for the created job. For an update job request, the job name should be the same as the existing running job.
+ "launchOptions": { # Launch options for this Flex Template job. This is a common set of options across languages and templates. This should not be used to pass job parameters.
+ "a_key": "A String",
+ },
+ "parameters": { # The parameters for the Flex Template. Example: `{"num_workers":"5"}`
+ "a_key": "A String",
+ },
+ "transformNameMappings": { # Use this to pass transform name mappings for streaming update jobs. Example: `{"oldTransformName":"newTransformName",...}`
+ "a_key": "A String",
+ },
+ "update": True or False, # Set this to true if you are sending a request to update a running streaming job. When set, the job name should be the same as the running job.
+ },
+ "location": "A String", # Required. The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request. For example, `us-central1`, `us-west1`.
+ "projectId": "A String", # Required. The ID of the Cloud Platform project that the job belongs to.
+ "validateOnly": True or False, # If true, the request is validated but not actually executed. Defaults to false.
+ },
+ "dataflowLaunchTemplateRequest": { # A request to launch a template. # Template information and additional parameters needed to launch a Dataflow job using the standard launch API.
+ "gcsPath": "A String", # A Cloud Storage path to the template from which to create the job. Must be a valid Cloud Storage URL, beginning with 'gs://'.
+ "launchParameters": { # Parameters to provide to the template being launched. # The parameters of the template to launch. This should be part of the body of the POST request.
+ "environment": { # The environment values to set at runtime. # The runtime environment for the job.
+ "additionalExperiments": [ # Additional experiment flags for the job.
+ "A String",
+ ],
+ "additionalUserLabels": { # Additional user labels to be specified for the job. Keys and values should follow the restrictions specified in the [labeling restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) page. An object containing a list of key/value pairs. Example: { "name": "wrench", "mass": "1kg", "count": "3" }.
+ "a_key": "A String",
+ },
+ "bypassTempDirValidation": True or False, # Whether to bypass the safety checks for the job's temporary directory. Use with caution.
+ "enableStreamingEngine": True or False, # Whether to enable Streaming Engine for the job.
+ "ipConfiguration": "A String", # Configuration for VM IPs.
+ "kmsKeyName": "A String", # Name for the Cloud KMS key for the job. The 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 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 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.
+ },
+ "jobName": "A String", # Required. The job name to use for the created job.
+ "parameters": { # The runtime parameters to pass to the job.
+ "a_key": "A String",
+ },
+ "transformNameMapping": { # Map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job. Only applicable when updating a pipeline.
+ "a_key": "A String",
+ },
+ "update": True or False, # If set, replace the existing pipeline with the name specified by jobName with this pipeline, preserving state.
+ },
+ "location": "A String", # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request.
+ "projectId": "A String", # Required. The ID of the Cloud Platform project that the job belongs to.
+ "validateOnly": True or False, # If true, the request is validated but not actually executed. Defaults to false.
+ },
+ },
+}</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
+ <pre>Updates a pipeline. If successful, the updated [Pipeline] is returned. Returns `NOT_FOUND` if the pipeline doesn't exist. If UpdatePipeline does not return successfully, you can retry the UpdatePipeline request until you receive a successful response.
+
+Args:
+ name: string, The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), and periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the pipeline's location. The list of available locations can be obtained by calling ListLocations. Note that the Data Pipelines service is not available in all regions. It depends on Cloud Scheduler, an App Engine application, so it's only available in [App Engine regions](https://cloud.google.com/about/locations#region). * `PIPELINE_ID` is the ID of the pipeline. Must be unique for the selected project and location. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The main pipeline entity and all the needed metadata to launch and manage linked jobs.
+ "createTime": "A String", # Output only. Immutable. The timestamp when the pipeline was initially created. Set by the Data Pipelines service.
+ "displayName": "A String", # Required. The display name of the pipeline. It can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), and underscores (_).
+ "jobCount": 42, # Output only. Number of jobs.
+ "lastUpdateTime": "A String", # Output only. Immutable. The timestamp when the pipeline was last modified. Set by the Data Pipelines service.
+ "name": "A String", # The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), and periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the pipeline's location. The list of available locations can be obtained by calling ListLocations. Note that the Data Pipelines service is not available in all regions. It depends on Cloud Scheduler, an App Engine application, so it's only available in [App Engine regions](https://cloud.google.com/about/locations#region). * `PIPELINE_ID` is the ID of the pipeline. Must be unique for the selected project and location.
+ "scheduleInfo": { # Details of the schedule the pipeline runs on. # Internal scheduling information for a pipeline. If this information is provided, periodic jobs will be created per the schedule. If not, users are responsible for creating jobs externally.
+ "nextJobTime": "A String", # Output only. When the next Scheduler job is going to run.
+ "schedule": "A String", # Unix-cron format of the schedule. This information is retrieved from the linked Cloud Scheduler.
+ "timeZone": "A String", # Timezone ID. This matches the timezone IDs used by the Cloud Scheduler API. If empty, UTC time is assumed.
+ },
+ "schedulerServiceAccountEmail": "A String", # Optional. A service account email to be used with the Cloud Scheduler job. If not specified, the default compute engine service account will be used.
+ "state": "A String", # Required. The state of the pipeline. When the pipeline is created, the state is set to 'PIPELINE_STATE_ACTIVE' by default. State changes can be requested by setting the state to stopping, paused, or resuming. State cannot be changed through UpdatePipeline requests.
+ "type": "A String", # Required. The type of the pipeline. This field affects the scheduling of the pipeline and the type of metrics to show for the pipeline.
+ "workload": { # Workload details for creating the pipeline jobs. # Workload information for creating new jobs.
+ "dataflowFlexTemplateRequest": { # A request to launch a Dataflow job from a Flex Template. # Template information and additional parameters needed to launch a Dataflow job using the flex launch API.
+ "launchParameter": { # Launch Flex Template parameter. # Required. Parameter to launch a job from a Flex Template.
+ "containerSpecGcsPath": "A String", # Cloud Storage path to a file with a JSON-serialized ContainerSpec as content.
+ "environment": { # The environment values to be set at runtime for a Flex Template. # The runtime environment for the Flex Template job.
+ "additionalExperiments": [ # Additional experiment flags for the job.
+ "A String",
+ ],
+ "additionalUserLabels": { # Additional user labels to be specified for the job. Keys and values must follow the restrictions specified in the [labeling restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions). An object containing a list of key/value pairs. Example: `{ "name": "wrench", "mass": "1kg", "count": "3" }`.
+ "a_key": "A String",
+ },
+ "enableStreamingEngine": True or False, # Whether to enable Streaming Engine for the job.
+ "flexrsGoal": "A String", # Set FlexRS goal for the job. https://cloud.google.com/dataflow/docs/guides/flexrs
+ "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 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 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, defaults to the control plane 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 region is chosen based on available capacity. If both `worker_zone` and `zone` are set, `worker_zone` takes precedence.
+ "zone": "A String", # The Compute Engine [availability zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones) for launching worker instances to run your pipeline. In the future, worker_zone will take precedence.
+ },
+ "jobName": "A String", # Required. The job name to use for the created job. For an update job request, the job name should be the same as the existing running job.
+ "launchOptions": { # Launch options for this Flex Template job. This is a common set of options across languages and templates. This should not be used to pass job parameters.
+ "a_key": "A String",
+ },
+ "parameters": { # The parameters for the Flex Template. Example: `{"num_workers":"5"}`
+ "a_key": "A String",
+ },
+ "transformNameMappings": { # Use this to pass transform name mappings for streaming update jobs. Example: `{"oldTransformName":"newTransformName",...}`
+ "a_key": "A String",
+ },
+ "update": True or False, # Set this to true if you are sending a request to update a running streaming job. When set, the job name should be the same as the running job.
+ },
+ "location": "A String", # Required. The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request. For example, `us-central1`, `us-west1`.
+ "projectId": "A String", # Required. The ID of the Cloud Platform project that the job belongs to.
+ "validateOnly": True or False, # If true, the request is validated but not actually executed. Defaults to false.
+ },
+ "dataflowLaunchTemplateRequest": { # A request to launch a template. # Template information and additional parameters needed to launch a Dataflow job using the standard launch API.
+ "gcsPath": "A String", # A Cloud Storage path to the template from which to create the job. Must be a valid Cloud Storage URL, beginning with 'gs://'.
+ "launchParameters": { # Parameters to provide to the template being launched. # The parameters of the template to launch. This should be part of the body of the POST request.
+ "environment": { # The environment values to set at runtime. # The runtime environment for the job.
+ "additionalExperiments": [ # Additional experiment flags for the job.
+ "A String",
+ ],
+ "additionalUserLabels": { # Additional user labels to be specified for the job. Keys and values should follow the restrictions specified in the [labeling restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) page. An object containing a list of key/value pairs. Example: { "name": "wrench", "mass": "1kg", "count": "3" }.
+ "a_key": "A String",
+ },
+ "bypassTempDirValidation": True or False, # Whether to bypass the safety checks for the job's temporary directory. Use with caution.
+ "enableStreamingEngine": True or False, # Whether to enable Streaming Engine for the job.
+ "ipConfiguration": "A String", # Configuration for VM IPs.
+ "kmsKeyName": "A String", # Name for the Cloud KMS key for the job. The 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 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 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.
+ },
+ "jobName": "A String", # Required. The job name to use for the created job.
+ "parameters": { # The runtime parameters to pass to the job.
+ "a_key": "A String",
+ },
+ "transformNameMapping": { # Map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job. Only applicable when updating a pipeline.
+ "a_key": "A String",
+ },
+ "update": True or False, # If set, replace the existing pipeline with the name specified by jobName with this pipeline, preserving state.
+ },
+ "location": "A String", # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request.
+ "projectId": "A String", # Required. The ID of the Cloud Platform project that the job belongs to.
+ "validateOnly": True or False, # If true, the request is validated but not actually executed. Defaults to false.
+ },
+ },
+}
+
+ updateMask: string, The list of fields to be updated.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The main pipeline entity and all the needed metadata to launch and manage linked jobs.
+ "createTime": "A String", # Output only. Immutable. The timestamp when the pipeline was initially created. Set by the Data Pipelines service.
+ "displayName": "A String", # Required. The display name of the pipeline. It can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), and underscores (_).
+ "jobCount": 42, # Output only. Number of jobs.
+ "lastUpdateTime": "A String", # Output only. Immutable. The timestamp when the pipeline was last modified. Set by the Data Pipelines service.
+ "name": "A String", # The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), and periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the pipeline's location. The list of available locations can be obtained by calling ListLocations. Note that the Data Pipelines service is not available in all regions. It depends on Cloud Scheduler, an App Engine application, so it's only available in [App Engine regions](https://cloud.google.com/about/locations#region). * `PIPELINE_ID` is the ID of the pipeline. Must be unique for the selected project and location.
+ "scheduleInfo": { # Details of the schedule the pipeline runs on. # Internal scheduling information for a pipeline. If this information is provided, periodic jobs will be created per the schedule. If not, users are responsible for creating jobs externally.
+ "nextJobTime": "A String", # Output only. When the next Scheduler job is going to run.
+ "schedule": "A String", # Unix-cron format of the schedule. This information is retrieved from the linked Cloud Scheduler.
+ "timeZone": "A String", # Timezone ID. This matches the timezone IDs used by the Cloud Scheduler API. If empty, UTC time is assumed.
+ },
+ "schedulerServiceAccountEmail": "A String", # Optional. A service account email to be used with the Cloud Scheduler job. If not specified, the default compute engine service account will be used.
+ "state": "A String", # Required. The state of the pipeline. When the pipeline is created, the state is set to 'PIPELINE_STATE_ACTIVE' by default. State changes can be requested by setting the state to stopping, paused, or resuming. State cannot be changed through UpdatePipeline requests.
+ "type": "A String", # Required. The type of the pipeline. This field affects the scheduling of the pipeline and the type of metrics to show for the pipeline.
+ "workload": { # Workload details for creating the pipeline jobs. # Workload information for creating new jobs.
+ "dataflowFlexTemplateRequest": { # A request to launch a Dataflow job from a Flex Template. # Template information and additional parameters needed to launch a Dataflow job using the flex launch API.
+ "launchParameter": { # Launch Flex Template parameter. # Required. Parameter to launch a job from a Flex Template.
+ "containerSpecGcsPath": "A String", # Cloud Storage path to a file with a JSON-serialized ContainerSpec as content.
+ "environment": { # The environment values to be set at runtime for a Flex Template. # The runtime environment for the Flex Template job.
+ "additionalExperiments": [ # Additional experiment flags for the job.
+ "A String",
+ ],
+ "additionalUserLabels": { # Additional user labels to be specified for the job. Keys and values must follow the restrictions specified in the [labeling restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions). An object containing a list of key/value pairs. Example: `{ "name": "wrench", "mass": "1kg", "count": "3" }`.
+ "a_key": "A String",
+ },
+ "enableStreamingEngine": True or False, # Whether to enable Streaming Engine for the job.
+ "flexrsGoal": "A String", # Set FlexRS goal for the job. https://cloud.google.com/dataflow/docs/guides/flexrs
+ "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 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 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, defaults to the control plane 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 region is chosen based on available capacity. If both `worker_zone` and `zone` are set, `worker_zone` takes precedence.
+ "zone": "A String", # The Compute Engine [availability zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones) for launching worker instances to run your pipeline. In the future, worker_zone will take precedence.
+ },
+ "jobName": "A String", # Required. The job name to use for the created job. For an update job request, the job name should be the same as the existing running job.
+ "launchOptions": { # Launch options for this Flex Template job. This is a common set of options across languages and templates. This should not be used to pass job parameters.
+ "a_key": "A String",
+ },
+ "parameters": { # The parameters for the Flex Template. Example: `{"num_workers":"5"}`
+ "a_key": "A String",
+ },
+ "transformNameMappings": { # Use this to pass transform name mappings for streaming update jobs. Example: `{"oldTransformName":"newTransformName",...}`
+ "a_key": "A String",
+ },
+ "update": True or False, # Set this to true if you are sending a request to update a running streaming job. When set, the job name should be the same as the running job.
+ },
+ "location": "A String", # Required. The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request. For example, `us-central1`, `us-west1`.
+ "projectId": "A String", # Required. The ID of the Cloud Platform project that the job belongs to.
+ "validateOnly": True or False, # If true, the request is validated but not actually executed. Defaults to false.
+ },
+ "dataflowLaunchTemplateRequest": { # A request to launch a template. # Template information and additional parameters needed to launch a Dataflow job using the standard launch API.
+ "gcsPath": "A String", # A Cloud Storage path to the template from which to create the job. Must be a valid Cloud Storage URL, beginning with 'gs://'.
+ "launchParameters": { # Parameters to provide to the template being launched. # The parameters of the template to launch. This should be part of the body of the POST request.
+ "environment": { # The environment values to set at runtime. # The runtime environment for the job.
+ "additionalExperiments": [ # Additional experiment flags for the job.
+ "A String",
+ ],
+ "additionalUserLabels": { # Additional user labels to be specified for the job. Keys and values should follow the restrictions specified in the [labeling restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) page. An object containing a list of key/value pairs. Example: { "name": "wrench", "mass": "1kg", "count": "3" }.
+ "a_key": "A String",
+ },
+ "bypassTempDirValidation": True or False, # Whether to bypass the safety checks for the job's temporary directory. Use with caution.
+ "enableStreamingEngine": True or False, # Whether to enable Streaming Engine for the job.
+ "ipConfiguration": "A String", # Configuration for VM IPs.
+ "kmsKeyName": "A String", # Name for the Cloud KMS key for the job. The 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 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 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.
+ },
+ "jobName": "A String", # Required. The job name to use for the created job.
+ "parameters": { # The runtime parameters to pass to the job.
+ "a_key": "A String",
+ },
+ "transformNameMapping": { # Map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job. Only applicable when updating a pipeline.
+ "a_key": "A String",
+ },
+ "update": True or False, # If set, replace the existing pipeline with the name specified by jobName with this pipeline, preserving state.
+ },
+ "location": "A String", # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request.
+ "projectId": "A String", # Required. The ID of the Cloud Platform project that the job belongs to.
+ "validateOnly": True or False, # If true, the request is validated but not actually executed. Defaults to false.
+ },
+ },
+}</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="run">run(name, body=None, x__xgafv=None)</code>
+ <pre>Creates a job for the specified pipeline directly. You can use this method when the internal scheduler is not configured and you want to trigger the job directly or through an external system. Returns a "NOT_FOUND" error if the pipeline doesn't exist. Returns a "FOBIDDEN" error if the user doesn't have permission to access the pipeline or run jobs for the pipeline.
+
+Args:
+ name: string, Required. The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for RunPipeline
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response message for RunPipeline
+ "job": { # Definition of the job information maintained by the pipeline. Fields in this entity are retrieved from the executor API (e.g. Dataflow API). # Job that was created as part of RunPipeline operation.
+ "createTime": "A String", # Output only. The time of job creation.
+ "dataflowJobDetails": { # Pipeline job details specific to the Dataflow API. This is encapsulated here to allow for more executors to store their specific details separately. # All the details that are specific to a Dataflow job.
+ "currentWorkers": 42, # Output only. The current number of workers used to run the jobs. Only set to a value if the job is still running.
+ "resourceInfo": { # Cached version of all the metrics of interest for the job. This value gets stored here when the job is terminated. As long as the job is running, this field is populated from the Dataflow API.
+ "a_key": 3.14,
+ },
+ "sdkVersion": { # The version of the SDK used to run the job. # Output only. The SDK version used to run the job.
+ "sdkSupportStatus": "A String", # The support status for this SDK version.
+ "version": "A String", # The version of the SDK used to run the job.
+ "versionDisplayName": "A String", # A readable string describing the version of the SDK.
+ },
+ },
+ "endTime": "A String", # Output only. The time of job termination. This is absent if the job is still running.
+ "id": "A String", # Output only. The internal ID for the job.
+ "name": "A String", # Required. The fully qualified resource name for the job.
+ "state": "A String", # The current state of the job.
+ "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Status capturing any error code or message related to job creation or execution.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ },
+}</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="stop">stop(name, body=None, x__xgafv=None)</code>
+ <pre>Freezes pipeline execution permanently. If there's a corresponding scheduler entry, it's deleted, and the pipeline state is changed to "ARCHIVED". However, pipeline metadata is retained. Upon success, the pipeline state is updated to ARCHIVED.
+
+Args:
+ name: string, Required. The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for StopPipeline.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The main pipeline entity and all the needed metadata to launch and manage linked jobs.
+ "createTime": "A String", # Output only. Immutable. The timestamp when the pipeline was initially created. Set by the Data Pipelines service.
+ "displayName": "A String", # Required. The display name of the pipeline. It can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), and underscores (_).
+ "jobCount": 42, # Output only. Number of jobs.
+ "lastUpdateTime": "A String", # Output only. Immutable. The timestamp when the pipeline was last modified. Set by the Data Pipelines service.
+ "name": "A String", # The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), and periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the pipeline's location. The list of available locations can be obtained by calling ListLocations. Note that the Data Pipelines service is not available in all regions. It depends on Cloud Scheduler, an App Engine application, so it's only available in [App Engine regions](https://cloud.google.com/about/locations#region). * `PIPELINE_ID` is the ID of the pipeline. Must be unique for the selected project and location.
+ "scheduleInfo": { # Details of the schedule the pipeline runs on. # Internal scheduling information for a pipeline. If this information is provided, periodic jobs will be created per the schedule. If not, users are responsible for creating jobs externally.
+ "nextJobTime": "A String", # Output only. When the next Scheduler job is going to run.
+ "schedule": "A String", # Unix-cron format of the schedule. This information is retrieved from the linked Cloud Scheduler.
+ "timeZone": "A String", # Timezone ID. This matches the timezone IDs used by the Cloud Scheduler API. If empty, UTC time is assumed.
+ },
+ "schedulerServiceAccountEmail": "A String", # Optional. A service account email to be used with the Cloud Scheduler job. If not specified, the default compute engine service account will be used.
+ "state": "A String", # Required. The state of the pipeline. When the pipeline is created, the state is set to 'PIPELINE_STATE_ACTIVE' by default. State changes can be requested by setting the state to stopping, paused, or resuming. State cannot be changed through UpdatePipeline requests.
+ "type": "A String", # Required. The type of the pipeline. This field affects the scheduling of the pipeline and the type of metrics to show for the pipeline.
+ "workload": { # Workload details for creating the pipeline jobs. # Workload information for creating new jobs.
+ "dataflowFlexTemplateRequest": { # A request to launch a Dataflow job from a Flex Template. # Template information and additional parameters needed to launch a Dataflow job using the flex launch API.
+ "launchParameter": { # Launch Flex Template parameter. # Required. Parameter to launch a job from a Flex Template.
+ "containerSpecGcsPath": "A String", # Cloud Storage path to a file with a JSON-serialized ContainerSpec as content.
+ "environment": { # The environment values to be set at runtime for a Flex Template. # The runtime environment for the Flex Template job.
+ "additionalExperiments": [ # Additional experiment flags for the job.
+ "A String",
+ ],
+ "additionalUserLabels": { # Additional user labels to be specified for the job. Keys and values must follow the restrictions specified in the [labeling restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions). An object containing a list of key/value pairs. Example: `{ "name": "wrench", "mass": "1kg", "count": "3" }`.
+ "a_key": "A String",
+ },
+ "enableStreamingEngine": True or False, # Whether to enable Streaming Engine for the job.
+ "flexrsGoal": "A String", # Set FlexRS goal for the job. https://cloud.google.com/dataflow/docs/guides/flexrs
+ "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 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 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, defaults to the control plane 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 region is chosen based on available capacity. If both `worker_zone` and `zone` are set, `worker_zone` takes precedence.
+ "zone": "A String", # The Compute Engine [availability zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones) for launching worker instances to run your pipeline. In the future, worker_zone will take precedence.
+ },
+ "jobName": "A String", # Required. The job name to use for the created job. For an update job request, the job name should be the same as the existing running job.
+ "launchOptions": { # Launch options for this Flex Template job. This is a common set of options across languages and templates. This should not be used to pass job parameters.
+ "a_key": "A String",
+ },
+ "parameters": { # The parameters for the Flex Template. Example: `{"num_workers":"5"}`
+ "a_key": "A String",
+ },
+ "transformNameMappings": { # Use this to pass transform name mappings for streaming update jobs. Example: `{"oldTransformName":"newTransformName",...}`
+ "a_key": "A String",
+ },
+ "update": True or False, # Set this to true if you are sending a request to update a running streaming job. When set, the job name should be the same as the running job.
+ },
+ "location": "A String", # Required. The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request. For example, `us-central1`, `us-west1`.
+ "projectId": "A String", # Required. The ID of the Cloud Platform project that the job belongs to.
+ "validateOnly": True or False, # If true, the request is validated but not actually executed. Defaults to false.
+ },
+ "dataflowLaunchTemplateRequest": { # A request to launch a template. # Template information and additional parameters needed to launch a Dataflow job using the standard launch API.
+ "gcsPath": "A String", # A Cloud Storage path to the template from which to create the job. Must be a valid Cloud Storage URL, beginning with 'gs://'.
+ "launchParameters": { # Parameters to provide to the template being launched. # The parameters of the template to launch. This should be part of the body of the POST request.
+ "environment": { # The environment values to set at runtime. # The runtime environment for the job.
+ "additionalExperiments": [ # Additional experiment flags for the job.
+ "A String",
+ ],
+ "additionalUserLabels": { # Additional user labels to be specified for the job. Keys and values should follow the restrictions specified in the [labeling restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) page. An object containing a list of key/value pairs. Example: { "name": "wrench", "mass": "1kg", "count": "3" }.
+ "a_key": "A String",
+ },
+ "bypassTempDirValidation": True or False, # Whether to bypass the safety checks for the job's temporary directory. Use with caution.
+ "enableStreamingEngine": True or False, # Whether to enable Streaming Engine for the job.
+ "ipConfiguration": "A String", # Configuration for VM IPs.
+ "kmsKeyName": "A String", # Name for the Cloud KMS key for the job. The 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 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 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.
+ },
+ "jobName": "A String", # Required. The job name to use for the created job.
+ "parameters": { # The runtime parameters to pass to the job.
+ "a_key": "A String",
+ },
+ "transformNameMapping": { # Map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job. Only applicable when updating a pipeline.
+ "a_key": "A String",
+ },
+ "update": True or False, # If set, replace the existing pipeline with the name specified by jobName with this pipeline, preserving state.
+ },
+ "location": "A String", # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request.
+ "projectId": "A String", # Required. The ID of the Cloud Platform project that the job belongs to.
+ "validateOnly": True or False, # If true, the request is validated but not actually executed. Defaults to false.
+ },
+ },
+}</pre>
+</div>
+
+</body></html>
\ No newline at end of file