Debian Codegraph @

docs/dyn/dataflow_v1b3.projects.catalogTemplates.templateVersions.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="dataflow_v1b3.html">Dataflow API</a> . <a href="dataflow_v1b3.projects.html">projects</a> . <a href="dataflow_v1b3.projects.catalogTemplates.html">catalogTemplates</a> . <a href="dataflow_v1b3.projects.catalogTemplates.templateVersions.html">templateVersions</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Creates a new Template with TemplateVersion. Requires project_id(projects) and template display_name(catalogTemplates). The template display_name is set by the user.</p>
83 <h3>Method Details</h3>
84 <div class="method">
85 <code class="details" id="close">close()</code>
86 <pre>Close httplib2 connections.</pre>
87 </div>
88
89 <div class="method">
90 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
91 <pre>Creates a new Template with TemplateVersion. Requires project_id(projects) and template display_name(catalogTemplates). The template display_name is set by the user.
92
93 Args:
94 parent: string, The parent project and template that the TemplateVersion will be created under. Create using project_id(pid1) and display_name(tid1). Format: projects/{pid1}/catalogTemplates/{tid1} (required)
95 body: object, The request body.
96 The object takes the form of:
97
98 { # Creates a new Template with TemplateVersions.
99 &quot;templateVersion&quot;: { # ///////////////////////////////////////////////////////////////////////////// //// 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! # The TemplateVersion object to create.
100 &quot;artifact&quot;: { # Job information for templates. # Job graph and metadata if it is a legacy Template. Container image path and metadata if it is flex Template.
101 &quot;containerSpec&quot;: { # Container Spec. # Container image path set for flex Template.
102 &quot;defaultEnvironment&quot;: { # The environment values to be set at runtime for flex template. # Default runtime environment for the job.
103 &quot;additionalExperiments&quot;: [ # Additional experiment flags for the job.
104 &quot;A String&quot;,
105 ],
106 &quot;additionalUserLabels&quot;: { # 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 &quot;key&quot;: value pairs. Example: { &quot;name&quot;: &quot;wrench&quot;, &quot;mass&quot;: &quot;1kg&quot;, &quot;count&quot;: &quot;3&quot; }.
107 &quot;a_key&quot;: &quot;A String&quot;,
108 },
109 &quot;enableStreamingEngine&quot;: True or False, # Whether to enable Streaming Engine for the job.
110 &quot;flexrsGoal&quot;: &quot;A String&quot;, # Set FlexRS goal for the job. https://cloud.google.com/dataflow/docs/guides/flexrs
111 &quot;ipConfiguration&quot;: &quot;A String&quot;, # Configuration for VM IPs.
112 &quot;kmsKeyName&quot;: &quot;A String&quot;, # Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/
113 &quot;machineType&quot;: &quot;A String&quot;, # The machine type to use for the job. Defaults to the value from the template if not specified.
114 &quot;maxWorkers&quot;: 42, # The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000.
115 &quot;network&quot;: &quot;A String&quot;, # Network to which VMs will be assigned. If empty or unspecified, the service will use the network &quot;default&quot;.
116 &quot;numWorkers&quot;: 42, # The initial number of Google Compute Engine instances for the job.
117 &quot;serviceAccountEmail&quot;: &quot;A String&quot;, # The email address of the service account to run the job as.
118 &quot;subnetwork&quot;: &quot;A String&quot;, # Subnetwork to which VMs will be assigned, if desired. You can specify a subnetwork using either a complete URL or an abbreviated path. Expected to be of the form &quot;https://www.googleapis.com/compute/v1/projects/HOST_PROJECT_ID/regions/REGION/subnetworks/SUBNETWORK&quot; or &quot;regions/REGION/subnetworks/SUBNETWORK&quot;. If the subnetwork is located in a Shared VPC network, you must use the complete URL.
119 &quot;tempLocation&quot;: &quot;A String&quot;, # The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`.
120 &quot;workerRegion&quot;: &quot;A String&quot;, # The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. &quot;us-west1&quot;. Mutually exclusive with worker_zone. If neither worker_region nor worker_zone is specified, default to the control plane&#x27;s region.
121 &quot;workerZone&quot;: &quot;A String&quot;, # The Compute Engine zone (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. &quot;us-west1-a&quot;. Mutually exclusive with worker_region. If neither worker_region nor worker_zone is specified, a zone in the control plane&#x27;s region is chosen based on available capacity. If both `worker_zone` and `zone` are set, `worker_zone` takes precedence.
122 &quot;zone&quot;: &quot;A String&quot;, # The Compute Engine [availability zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones) for launching worker instances to run your pipeline. In the future, worker_zone will take precedence.
123 },
124 &quot;image&quot;: &quot;A String&quot;, # Name of the docker container image. E.g., gcr.io/project/some-image
125 &quot;metadata&quot;: { # Metadata describing a template. # Metadata describing a template including description and validation rules.
126 &quot;description&quot;: &quot;A String&quot;, # Optional. A description of the template.
127 &quot;name&quot;: &quot;A String&quot;, # Required. The name of the template.
128 &quot;parameters&quot;: [ # The parameters for the template.
129 { # Metadata for a specific parameter.
130 &quot;helpText&quot;: &quot;A String&quot;, # Required. The help text to display for the parameter.
131 &quot;isOptional&quot;: True or False, # Optional. Whether the parameter is optional. Defaults to false.
132 &quot;label&quot;: &quot;A String&quot;, # Required. The label to display for the parameter.
133 &quot;name&quot;: &quot;A String&quot;, # Required. The name of the parameter.
134 &quot;paramType&quot;: &quot;A String&quot;, # Optional. The type of the parameter. Used for selecting input picker.
135 &quot;regexes&quot;: [ # Optional. Regexes that the parameter must match.
136 &quot;A String&quot;,
137 ],
138 },
139 ],
140 },
141 &quot;sdkInfo&quot;: { # SDK Information. # Required. SDK info of the Flex Template.
142 &quot;language&quot;: &quot;A String&quot;, # Required. The SDK Language.
143 &quot;version&quot;: &quot;A String&quot;, # Optional. The SDK version.
144 },
145 },
146 &quot;jobGraphGcsPath&quot;: &quot;A String&quot;, # job_graph_gcs_path set for legacy Template.
147 &quot;metadata&quot;: { # Metadata describing a template. # Metadata set for legacy Template.
148 &quot;description&quot;: &quot;A String&quot;, # Optional. A description of the template.
149 &quot;name&quot;: &quot;A String&quot;, # Required. The name of the template.
150 &quot;parameters&quot;: [ # The parameters for the template.
151 { # Metadata for a specific parameter.
152 &quot;helpText&quot;: &quot;A String&quot;, # Required. The help text to display for the parameter.
153 &quot;isOptional&quot;: True or False, # Optional. Whether the parameter is optional. Defaults to false.
154 &quot;label&quot;: &quot;A String&quot;, # Required. The label to display for the parameter.
155 &quot;name&quot;: &quot;A String&quot;, # Required. The name of the parameter.
156 &quot;paramType&quot;: &quot;A String&quot;, # Optional. The type of the parameter. Used for selecting input picker.
157 &quot;regexes&quot;: [ # Optional. Regexes that the parameter must match.
158 &quot;A String&quot;,
159 ],
160 },
161 ],
162 },
163 },
164 &quot;createTime&quot;: &quot;A String&quot;, # Creation time of this TemplateVersion.
165 &quot;description&quot;: &quot;A String&quot;, # Template description from the user.
166 &quot;displayName&quot;: &quot;A String&quot;, # A customized name for Template. Multiple TemplateVersions per Template.
167 &quot;labels&quot;: { # Labels for the Template Version. Labels can be duplicate within Template.
168 &quot;a_key&quot;: &quot;A String&quot;,
169 },
170 &quot;projectId&quot;: &quot;A String&quot;, # A unique project_id. Multiple Templates per Project.
171 &quot;tags&quot;: [ # Alias for version_id, helps locate a TemplateVersion.
172 &quot;A String&quot;,
173 ],
174 &quot;type&quot;: &quot;A String&quot;, # Either LEGACY or FLEX. This should match with the type of artifact.
175 &quot;versionId&quot;: &quot;A String&quot;, # An auto generated version_id for TemplateVersion.
176 },
177 }
178
179 x__xgafv: string, V1 error format.
180 Allowed values
181 1 - v1 error format
182 2 - v2 error format
183
184 Returns:
185 An object of the form:
186
187 { # ///////////////////////////////////////////////////////////////////////////// //// 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!
188 &quot;artifact&quot;: { # Job information for templates. # Job graph and metadata if it is a legacy Template. Container image path and metadata if it is flex Template.
189 &quot;containerSpec&quot;: { # Container Spec. # Container image path set for flex Template.
190 &quot;defaultEnvironment&quot;: { # The environment values to be set at runtime for flex template. # Default runtime environment for the job.
191 &quot;additionalExperiments&quot;: [ # Additional experiment flags for the job.
192 &quot;A String&quot;,
193 ],
194 &quot;additionalUserLabels&quot;: { # 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 &quot;key&quot;: value pairs. Example: { &quot;name&quot;: &quot;wrench&quot;, &quot;mass&quot;: &quot;1kg&quot;, &quot;count&quot;: &quot;3&quot; }.
195 &quot;a_key&quot;: &quot;A String&quot;,
196 },
197 &quot;enableStreamingEngine&quot;: True or False, # Whether to enable Streaming Engine for the job.
198 &quot;flexrsGoal&quot;: &quot;A String&quot;, # Set FlexRS goal for the job. https://cloud.google.com/dataflow/docs/guides/flexrs
199 &quot;ipConfiguration&quot;: &quot;A String&quot;, # Configuration for VM IPs.
200 &quot;kmsKeyName&quot;: &quot;A String&quot;, # Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/
201 &quot;machineType&quot;: &quot;A String&quot;, # The machine type to use for the job. Defaults to the value from the template if not specified.
202 &quot;maxWorkers&quot;: 42, # The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000.
203 &quot;network&quot;: &quot;A String&quot;, # Network to which VMs will be assigned. If empty or unspecified, the service will use the network &quot;default&quot;.
204 &quot;numWorkers&quot;: 42, # The initial number of Google Compute Engine instances for the job.
205 &quot;serviceAccountEmail&quot;: &quot;A String&quot;, # The email address of the service account to run the job as.
206 &quot;subnetwork&quot;: &quot;A String&quot;, # Subnetwork to which VMs will be assigned, if desired. You can specify a subnetwork using either a complete URL or an abbreviated path. Expected to be of the form &quot;https://www.googleapis.com/compute/v1/projects/HOST_PROJECT_ID/regions/REGION/subnetworks/SUBNETWORK&quot; or &quot;regions/REGION/subnetworks/SUBNETWORK&quot;. If the subnetwork is located in a Shared VPC network, you must use the complete URL.
207 &quot;tempLocation&quot;: &quot;A String&quot;, # The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`.
208 &quot;workerRegion&quot;: &quot;A String&quot;, # The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. &quot;us-west1&quot;. Mutually exclusive with worker_zone. If neither worker_region nor worker_zone is specified, default to the control plane&#x27;s region.
209 &quot;workerZone&quot;: &quot;A String&quot;, # The Compute Engine zone (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. &quot;us-west1-a&quot;. Mutually exclusive with worker_region. If neither worker_region nor worker_zone is specified, a zone in the control plane&#x27;s region is chosen based on available capacity. If both `worker_zone` and `zone` are set, `worker_zone` takes precedence.
210 &quot;zone&quot;: &quot;A String&quot;, # The Compute Engine [availability zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones) for launching worker instances to run your pipeline. In the future, worker_zone will take precedence.
211 },
212 &quot;image&quot;: &quot;A String&quot;, # Name of the docker container image. E.g., gcr.io/project/some-image
213 &quot;metadata&quot;: { # Metadata describing a template. # Metadata describing a template including description and validation rules.
214 &quot;description&quot;: &quot;A String&quot;, # Optional. A description of the template.
215 &quot;name&quot;: &quot;A String&quot;, # Required. The name of the template.
216 &quot;parameters&quot;: [ # The parameters for the template.
217 { # Metadata for a specific parameter.
218 &quot;helpText&quot;: &quot;A String&quot;, # Required. The help text to display for the parameter.
219 &quot;isOptional&quot;: True or False, # Optional. Whether the parameter is optional. Defaults to false.
220 &quot;label&quot;: &quot;A String&quot;, # Required. The label to display for the parameter.
221 &quot;name&quot;: &quot;A String&quot;, # Required. The name of the parameter.
222 &quot;paramType&quot;: &quot;A String&quot;, # Optional. The type of the parameter. Used for selecting input picker.
223 &quot;regexes&quot;: [ # Optional. Regexes that the parameter must match.
224 &quot;A String&quot;,
225 ],
226 },
227 ],
228 },
229 &quot;sdkInfo&quot;: { # SDK Information. # Required. SDK info of the Flex Template.
230 &quot;language&quot;: &quot;A String&quot;, # Required. The SDK Language.
231 &quot;version&quot;: &quot;A String&quot;, # Optional. The SDK version.
232 },
233 },
234 &quot;jobGraphGcsPath&quot;: &quot;A String&quot;, # job_graph_gcs_path set for legacy Template.
235 &quot;metadata&quot;: { # Metadata describing a template. # Metadata set for legacy Template.
236 &quot;description&quot;: &quot;A String&quot;, # Optional. A description of the template.
237 &quot;name&quot;: &quot;A String&quot;, # Required. The name of the template.
238 &quot;parameters&quot;: [ # The parameters for the template.
239 { # Metadata for a specific parameter.
240 &quot;helpText&quot;: &quot;A String&quot;, # Required. The help text to display for the parameter.
241 &quot;isOptional&quot;: True or False, # Optional. Whether the parameter is optional. Defaults to false.
242 &quot;label&quot;: &quot;A String&quot;, # Required. The label to display for the parameter.
243 &quot;name&quot;: &quot;A String&quot;, # Required. The name of the parameter.
244 &quot;paramType&quot;: &quot;A String&quot;, # Optional. The type of the parameter. Used for selecting input picker.
245 &quot;regexes&quot;: [ # Optional. Regexes that the parameter must match.
246 &quot;A String&quot;,
247 ],
248 },
249 ],
250 },
251 },
252 &quot;createTime&quot;: &quot;A String&quot;, # Creation time of this TemplateVersion.
253 &quot;description&quot;: &quot;A String&quot;, # Template description from the user.
254 &quot;displayName&quot;: &quot;A String&quot;, # A customized name for Template. Multiple TemplateVersions per Template.
255 &quot;labels&quot;: { # Labels for the Template Version. Labels can be duplicate within Template.
256 &quot;a_key&quot;: &quot;A String&quot;,
257 },
258 &quot;projectId&quot;: &quot;A String&quot;, # A unique project_id. Multiple Templates per Project.
259 &quot;tags&quot;: [ # Alias for version_id, helps locate a TemplateVersion.
260 &quot;A String&quot;,
261 ],
262 &quot;type&quot;: &quot;A String&quot;, # Either LEGACY or FLEX. This should match with the type of artifact.
263 &quot;versionId&quot;: &quot;A String&quot;, # An auto generated version_id for TemplateVersion.
264 }</pre>
265 </div>
266
267 </body></html>