docs: update docs/dyn (#1096)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/6f0f288a-a1e8-4b2d-a85f-00b1c6150185/targets
- [ ] To automatically regenerate this PR, check this box.
Source-Link: https://github.com/googleapis/synthtool/commit/39b7149da4026765385403632db3c6f63db96b2c
Source-Link: https://github.com/googleapis/synthtool/commit/9a7d9fbb7045c34c9d3d22c1ff766eeae51f04c9
Source-Link: https://github.com/googleapis/synthtool/commit/dc9903a8c30c3662b6098f0e4a97f221d67268b2
Source-Link: https://github.com/googleapis/synthtool/commit/7fcc405a579d5d53a726ff3da1b7c8c08f0f2d58
Source-Link: https://github.com/googleapis/synthtool/commit/d5fc0bcf9ea9789c5b0e3154a9e3b29e5cea6116
Source-Link: https://github.com/googleapis/synthtool/commit/e89175cf074dccc4babb4eca66ae913696e47a71
Source-Link: https://github.com/googleapis/synthtool/commit/7d652819519dfa24da9e14548232e4aaba71a11c
Source-Link: https://github.com/googleapis/synthtool/commit/7db8a6c5ffb12a6e4c2f799c18f00f7f3d60e279
Source-Link: https://github.com/googleapis/synthtool/commit/1f1148d3c7a7a52f0c98077f976bd9b3c948ee2b
Source-Link: https://github.com/googleapis/synthtool/commit/2c8aecedd55b0480fb4e123b6e07fa5b12953862
Source-Link: https://github.com/googleapis/synthtool/commit/3d3e94c4e02370f307a9a200b0c743c3d8d19f29
Source-Link: https://github.com/googleapis/synthtool/commit/c7824ea48ff6d4d42dfae0849aec8a85acd90bd9
Source-Link: https://github.com/googleapis/synthtool/commit/ba9918cd22874245b55734f57470c719b577e591
Source-Link: https://github.com/googleapis/synthtool/commit/b19b401571e77192f8dd38eab5fb2300a0de9324
Source-Link: https://github.com/googleapis/synthtool/commit/6542bd723403513626f61642fc02ddca528409aa
diff --git a/docs/dyn/dataflow_v1b3.projects.templateVersions.html b/docs/dyn/dataflow_v1b3.projects.templateVersions.html
index d985fe9..d835e89 100644
--- a/docs/dyn/dataflow_v1b3.projects.templateVersions.html
+++ b/docs/dyn/dataflow_v1b3.projects.templateVersions.html
@@ -78,7 +78,7 @@
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
- <code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">List TemplateVersions using project_id and an optional display_name field. List all the TemplateVersions in the Template if display set. List all the TemplateVersions in the Project if display_name not set.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -90,13 +90,13 @@
</div>
<div class="method">
- <code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>List TemplateVersions using project_id and an optional display_name field. List all the TemplateVersions in the Template if display set. List all the TemplateVersions in the Project if display_name not set.
Args:
parent: string, parent includes project_id, and display_name is optional. List by project_id(pid1) and display_name(tid1). Format: projects/{pid1}/catalogTemplates/{tid1} List by project_id(pid1). Format: projects/{pid1} (required)
- pageToken: string, The page token, received from a previous ListTemplateVersions call. Provide this to retrieve the subsequent page.
pageSize: integer, The maximum number of TemplateVersions to return per page.
+ pageToken: string, The page token, received from a previous ListTemplateVersions call. Provide this to retrieve the subsequent page.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -110,79 +110,79 @@
{ # ///////////////////////////////////////////////////////////////////////////// //// Template Catalog is used to organize user TemplateVersions. //// TemplateVersions that have the same project_id and display_name are //// belong to the same Template. //// Templates with the same project_id belong to the same Project. //// TemplateVersion may have labels and multiple labels are allowed. //// Duplicated labels in the same `TemplateVersion` are not allowed. //// TemplateVersion may have tags and multiple tags are allowed. Duplicated //// tags in the same `Template` are not allowed!
"type": "A String", # Either LEGACY or FLEX. This should match with the type of artifact.
"projectId": "A String", # A unique project_id. Multiple Templates per Project.
- "description": "A String", # Template description from the user.
- "displayName": "A String", # A customized name for Template. Multiple TemplateVersions per Template.
- "versionId": "A String", # An auto generated version_id for TemplateVersion.
+ "labels": { # Labels for the Template Version. Labels can be duplicate within Template.
+ "a_key": "A String",
+ },
"tags": [ # Alias for version_id, helps locate a TemplateVersion.
"A String",
],
- "createTime": "A String", # Creation time of this TemplateVersion.
+ "displayName": "A String", # A customized name for Template. Multiple TemplateVersions per Template.
+ "versionId": "A String", # An auto generated version_id for TemplateVersion.
"artifact": { # Job information for templates. # Job graph and metadata if it is a legacy Template. Container image path and metadata if it is flex Template.
- "jobGraphGcsPath": "A String", # job_graph_gcs_path set for legacy Template.
"metadata": { # Metadata describing a template. # Metadata set for legacy Template.
"description": "A String", # Optional. A description of the template.
- "name": "A String", # Required. The name of the template.
"parameters": [ # The parameters for the template.
{ # Metadata for a specific parameter.
- "isOptional": True or False, # Optional. Whether the parameter is optional. Defaults to false.
- "label": "A String", # Required. The label to display for the parameter.
- "paramType": "A String", # Optional. The type of the parameter. Used for selecting input picker.
- "helpText": "A String", # Required. The help text to display for the parameter.
"regexes": [ # Optional. Regexes that the parameter must match.
"A String",
],
+ "isOptional": True or False, # Optional. Whether the parameter is optional. Defaults to false.
+ "label": "A String", # Required. The label to display for the parameter.
"name": "A String", # Required. The name of the parameter.
+ "paramType": "A String", # Optional. The type of the parameter. Used for selecting input picker.
+ "helpText": "A String", # Required. The help text to display for the parameter.
},
],
+ "name": "A String", # Required. The name of the template.
},
"containerSpec": { # Container Spec. # Container image path set for flex Template.
- "sdkInfo": { # SDK Information. # Required. SDK info of the Flex Template.
- "version": "A String", # Optional. The SDK version.
- "language": "A String", # Required. The SDK Language.
+ "metadata": { # Metadata describing a template. # Metadata describing a template including description and validation rules.
+ "description": "A String", # Optional. A description of the template.
+ "parameters": [ # The parameters for the template.
+ { # Metadata for a specific parameter.
+ "regexes": [ # Optional. Regexes that the parameter must match.
+ "A String",
+ ],
+ "isOptional": True or False, # Optional. Whether the parameter is optional. Defaults to false.
+ "label": "A String", # Required. The label to display for the parameter.
+ "name": "A String", # Required. The name of the parameter.
+ "paramType": "A String", # Optional. The type of the parameter. Used for selecting input picker.
+ "helpText": "A String", # Required. The help text to display for the parameter.
+ },
+ ],
+ "name": "A String", # Required. The name of the template.
},
"defaultEnvironment": { # The environment values to be set at runtime for flex template. # Default runtime environment for the job.
- "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.
- "numWorkers": 42, # The initial number of Google Compute Engine instances for the job.
"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".
- "ipConfiguration": "A String", # Configuration for VM IPs.
- "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.
+ "numWorkers": 42, # The initial number of Google Compute Engine instances for the job.
"additionalExperiments": [ # Additional experiment flags for the job.
"A String",
],
"kmsKeyName": "A String", # Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/
- "tempLocation": "A String", # The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`.
"machineType": "A String", # The machine type to use for the job. Defaults to the value from the template if not specified.
+ "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://`.
"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) page. 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.
+ "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.
+ "ipConfiguration": "A String", # Configuration for VM IPs.
+ "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.
+ "network": "A String", # Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".
"serviceAccountEmail": "A String", # The email address of the service account to run the job as.
},
- "metadata": { # Metadata describing a template. # Metadata describing a template including description and validation rules.
- "description": "A String", # Optional. A description of the template.
- "name": "A String", # Required. The name of the template.
- "parameters": [ # The parameters for the template.
- { # Metadata for a specific parameter.
- "isOptional": True or False, # Optional. Whether the parameter is optional. Defaults to false.
- "label": "A String", # Required. The label to display for the parameter.
- "paramType": "A String", # Optional. The type of the parameter. Used for selecting input picker.
- "helpText": "A String", # Required. The help text to display for the parameter.
- "regexes": [ # Optional. Regexes that the parameter must match.
- "A String",
- ],
- "name": "A String", # Required. The name of the parameter.
- },
- ],
+ "sdkInfo": { # SDK Information. # Required. SDK info of the Flex Template.
+ "language": "A String", # Required. The SDK Language.
+ "version": "A String", # Optional. The SDK version.
},
"image": "A String", # Name of the docker container image. E.g., gcr.io/project/some-image
},
+ "jobGraphGcsPath": "A String", # job_graph_gcs_path set for legacy Template.
},
- "labels": { # Labels for the Template Version. Labels can be duplicate within Template.
- "a_key": "A String",
- },
+ "createTime": "A String", # Creation time of this TemplateVersion.
+ "description": "A String", # Template description from the user.
},
],
"nextPageToken": "A String", # A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.