1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
|
<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="dataflow_v1b3.html">Dataflow API</a> . <a href="dataflow_v1b3.projects.html">projects</a> . <a href="dataflow_v1b3.projects.catalogTemplates.html">catalogTemplates</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="dataflow_v1b3.projects.catalogTemplates.templateVersions.html">templateVersions()</a></code>
</p>
<p class="firstline">Returns the templateVersions Resource.</p>
<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="#commit">commit(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new TemplateVersion (Important: not new Template) entry in the spanner table. Requires project_id and display_name (template).</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes an existing Template. Do nothing if Template does not exist.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Get TemplateVersion using project_id and display_name with an optional version_id field. Get latest (has tag "latest") TemplateVersion if version_id not set.</p>
<p class="toc_element">
<code><a href="#label">label(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the label of the TemplateVersion. Label can be duplicated in Template, so either add or remove the label in the TemplateVersion.</p>
<p class="toc_element">
<code><a href="#tag">tag(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the tag of the TemplateVersion, and tag is unique in Template. If tag exists in another TemplateVersion in the Template, updates the tag to this TemplateVersion will remove it from the old TemplateVersion and add it to this TemplateVersion. If request is remove_only (remove_only = true), remove the tag from this TemplateVersion.</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="commit">commit(name, body=None, x__xgafv=None)</code>
<pre>Creates a new TemplateVersion (Important: not new Template) entry in the spanner table. Requires project_id and display_name (template).
Args:
name: string, The location of the template, name includes project_id and display_name. Commit using project_id(pid1) and display_name(tid1). Format: projects/{pid1}/catalogTemplates/{tid1} (required)
body: object, The request body.
The object takes the form of:
{ # Commit will add a new TemplateVersion to an existing template.
"templateVersion": { # ///////////////////////////////////////////////////////////////////////////// //// 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! # TemplateVersion obejct to create.
"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.
"containerSpec": { # Container Spec. # Container image path set for flex Template.
"defaultEnvironment": { # The environment values to be set at runtime for flex template. # Default 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 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.
"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 Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000.
"network": "A String", # Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".
"numWorkers": 42, # The initial number of Google Compute Engine instances for the job.
"serviceAccountEmail": "A String", # The email address of the service account to run the job as.
"subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. You can specify a subnetwork using either a complete URL or an abbreviated path. Expected to be of the form "https://www.googleapis.com/compute/v1/projects/HOST_PROJECT_ID/regions/REGION/subnetworks/SUBNETWORK" or "regions/REGION/subnetworks/SUBNETWORK". If the subnetwork is located in a Shared VPC network, you must use the complete URL.
"tempLocation": "A String", # The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`.
"workerRegion": "A String", # The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1". Mutually exclusive with worker_zone. If neither worker_region nor worker_zone is specified, default to the control plane's region.
"workerZone": "A String", # The Compute Engine zone (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1-a". Mutually exclusive with worker_region. If neither worker_region nor worker_zone is specified, a zone in the control plane's region is chosen based on available capacity. If both `worker_zone` and `zone` are set, `worker_zone` takes precedence.
"zone": "A String", # The Compute Engine [availability zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones) for launching worker instances to run your pipeline. In the future, worker_zone will take precedence.
},
"image": "A String", # Name of the docker container image. E.g., gcr.io/project/some-image
"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.
"helpText": "A String", # Required. The help text to display for the 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.
"name": "A String", # Required. The name of the parameter.
"paramType": "A String", # Optional. The type of the parameter. Used for selecting input picker.
"regexes": [ # Optional. Regexes that the parameter must match.
"A String",
],
},
],
},
"sdkInfo": { # SDK Information. # Required. SDK info of the Flex Template.
"language": "A String", # Required. The SDK Language.
"version": "A String", # Optional. The SDK version.
},
},
"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.
"helpText": "A String", # Required. The help text to display for the 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.
"name": "A String", # Required. The name of the parameter.
"paramType": "A String", # Optional. The type of the parameter. Used for selecting input picker.
"regexes": [ # Optional. Regexes that the parameter must match.
"A String",
],
},
],
},
},
"createTime": "A String", # Creation time of this TemplateVersion.
"description": "A String", # Template description from the user.
"displayName": "A String", # A customized name for Template. Multiple TemplateVersions per Template.
"labels": { # Labels for the Template Version. Labels can be duplicate within Template.
"a_key": "A String",
},
"projectId": "A String", # A unique project_id. Multiple Templates per Project.
"tags": [ # Alias for version_id, helps locate a TemplateVersion.
"A String",
],
"type": "A String", # Either LEGACY or FLEX. This should match with the type of artifact.
"versionId": "A String", # An auto generated version_id for TemplateVersion.
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # ///////////////////////////////////////////////////////////////////////////// //// 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!
"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.
"containerSpec": { # Container Spec. # Container image path set for flex Template.
"defaultEnvironment": { # The environment values to be set at runtime for flex template. # Default 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 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.
"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 Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000.
"network": "A String", # Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".
"numWorkers": 42, # The initial number of Google Compute Engine instances for the job.
"serviceAccountEmail": "A String", # The email address of the service account to run the job as.
"subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. You can specify a subnetwork using either a complete URL or an abbreviated path. Expected to be of the form "https://www.googleapis.com/compute/v1/projects/HOST_PROJECT_ID/regions/REGION/subnetworks/SUBNETWORK" or "regions/REGION/subnetworks/SUBNETWORK". If the subnetwork is located in a Shared VPC network, you must use the complete URL.
"tempLocation": "A String", # The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`.
"workerRegion": "A String", # The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1". Mutually exclusive with worker_zone. If neither worker_region nor worker_zone is specified, default to the control plane's region.
"workerZone": "A String", # The Compute Engine zone (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1-a". Mutually exclusive with worker_region. If neither worker_region nor worker_zone is specified, a zone in the control plane's region is chosen based on available capacity. If both `worker_zone` and `zone` are set, `worker_zone` takes precedence.
"zone": "A String", # The Compute Engine [availability zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones) for launching worker instances to run your pipeline. In the future, worker_zone will take precedence.
},
"image": "A String", # Name of the docker container image. E.g., gcr.io/project/some-image
"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.
"helpText": "A String", # Required. The help text to display for the 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.
"name": "A String", # Required. The name of the parameter.
"paramType": "A String", # Optional. The type of the parameter. Used for selecting input picker.
"regexes": [ # Optional. Regexes that the parameter must match.
"A String",
],
},
],
},
"sdkInfo": { # SDK Information. # Required. SDK info of the Flex Template.
"language": "A String", # Required. The SDK Language.
"version": "A String", # Optional. The SDK version.
},
},
"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.
"helpText": "A String", # Required. The help text to display for the 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.
"name": "A String", # Required. The name of the parameter.
"paramType": "A String", # Optional. The type of the parameter. Used for selecting input picker.
"regexes": [ # Optional. Regexes that the parameter must match.
"A String",
],
},
],
},
},
"createTime": "A String", # Creation time of this TemplateVersion.
"description": "A String", # Template description from the user.
"displayName": "A String", # A customized name for Template. Multiple TemplateVersions per Template.
"labels": { # Labels for the Template Version. Labels can be duplicate within Template.
"a_key": "A String",
},
"projectId": "A String", # A unique project_id. Multiple Templates per Project.
"tags": [ # Alias for version_id, helps locate a TemplateVersion.
"A String",
],
"type": "A String", # Either LEGACY or FLEX. This should match with the type of artifact.
"versionId": "A String", # An auto generated version_id for TemplateVersion.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes an existing Template. Do nothing if Template does not exist.
Args:
name: string, name includes project_id and display_name. Delete by project_id(pid1) and display_name(tid1). Format: projects/{pid1}/catalogTemplates/{tid1} (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>Get TemplateVersion using project_id and display_name with an optional version_id field. Get latest (has tag "latest") TemplateVersion if version_id not set.
Args:
name: string, Resource name includes project_id and display_name. version_id is optional. Get the latest TemplateVersion if version_id not set. Get by project_id(pid1) and display_name(tid1): Format: projects/{pid1}/catalogTemplates/{tid1} Get by project_id(pid1), display_name(tid1), and version_id(vid1): Format: projects/{pid1}/catalogTemplates/{tid1@vid} (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # ///////////////////////////////////////////////////////////////////////////// //// 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!
"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.
"containerSpec": { # Container Spec. # Container image path set for flex Template.
"defaultEnvironment": { # The environment values to be set at runtime for flex template. # Default 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 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.
"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 Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000.
"network": "A String", # Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".
"numWorkers": 42, # The initial number of Google Compute Engine instances for the job.
"serviceAccountEmail": "A String", # The email address of the service account to run the job as.
"subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. You can specify a subnetwork using either a complete URL or an abbreviated path. Expected to be of the form "https://www.googleapis.com/compute/v1/projects/HOST_PROJECT_ID/regions/REGION/subnetworks/SUBNETWORK" or "regions/REGION/subnetworks/SUBNETWORK". If the subnetwork is located in a Shared VPC network, you must use the complete URL.
"tempLocation": "A String", # The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`.
"workerRegion": "A String", # The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1". Mutually exclusive with worker_zone. If neither worker_region nor worker_zone is specified, default to the control plane's region.
"workerZone": "A String", # The Compute Engine zone (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1-a". Mutually exclusive with worker_region. If neither worker_region nor worker_zone is specified, a zone in the control plane's region is chosen based on available capacity. If both `worker_zone` and `zone` are set, `worker_zone` takes precedence.
"zone": "A String", # The Compute Engine [availability zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones) for launching worker instances to run your pipeline. In the future, worker_zone will take precedence.
},
"image": "A String", # Name of the docker container image. E.g., gcr.io/project/some-image
"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.
"helpText": "A String", # Required. The help text to display for the 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.
"name": "A String", # Required. The name of the parameter.
"paramType": "A String", # Optional. The type of the parameter. Used for selecting input picker.
"regexes": [ # Optional. Regexes that the parameter must match.
"A String",
],
},
],
},
"sdkInfo": { # SDK Information. # Required. SDK info of the Flex Template.
"language": "A String", # Required. The SDK Language.
"version": "A String", # Optional. The SDK version.
},
},
"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.
"helpText": "A String", # Required. The help text to display for the 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.
"name": "A String", # Required. The name of the parameter.
"paramType": "A String", # Optional. The type of the parameter. Used for selecting input picker.
"regexes": [ # Optional. Regexes that the parameter must match.
"A String",
],
},
],
},
},
"createTime": "A String", # Creation time of this TemplateVersion.
"description": "A String", # Template description from the user.
"displayName": "A String", # A customized name for Template. Multiple TemplateVersions per Template.
"labels": { # Labels for the Template Version. Labels can be duplicate within Template.
"a_key": "A String",
},
"projectId": "A String", # A unique project_id. Multiple Templates per Project.
"tags": [ # Alias for version_id, helps locate a TemplateVersion.
"A String",
],
"type": "A String", # Either LEGACY or FLEX. This should match with the type of artifact.
"versionId": "A String", # An auto generated version_id for TemplateVersion.
}</pre>
</div>
<div class="method">
<code class="details" id="label">label(name, body=None, x__xgafv=None)</code>
<pre>Updates the label of the TemplateVersion. Label can be duplicated in Template, so either add or remove the label in the TemplateVersion.
Args:
name: string, Resource name includes project_id, display_name, and version_id. Updates by project_id(pid1), display_name(tid1), and version_id(vid1): Format: projects/{pid1}/catalogTemplates/{tid1@vid} (required)
body: object, The request body.
The object takes the form of:
{ # Either add the label to TemplateVersion or remove it from the TemplateVersion.
"key": "A String", # The label key for update.
"op": "A String", # Requests for add label to TemplateVersion or remove label from TemplateVersion.
"value": "A String", # The label value for update.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Respond the labels in the TemplateVersion.
"labels": { # All the label in the TemplateVersion.
"a_key": "A String",
},
}</pre>
</div>
<div class="method">
<code class="details" id="tag">tag(name, body=None, x__xgafv=None)</code>
<pre>Updates the tag of the TemplateVersion, and tag is unique in Template. If tag exists in another TemplateVersion in the Template, updates the tag to this TemplateVersion will remove it from the old TemplateVersion and add it to this TemplateVersion. If request is remove_only (remove_only = true), remove the tag from this TemplateVersion.
Args:
name: string, Resource name includes project_id, display_name, and version_id. Updates by project_id(pid1), display_name(tid1), and version_id(vid1): Format: projects/{pid1}/catalogTemplates/{tid1@vid} (required)
body: object, The request body.
The object takes the form of:
{ # Add a tag to the current TemplateVersion. If tag exist in another TemplateVersion in the Template, remove the tag before add it to the current TemplateVersion. If remove_only set, remove the tag from the current TemplateVersion.
"removeOnly": True or False, # The flag that indicates if the request is only for remove tag from TemplateVersion.
"tag": "A String", # The tag for update.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Respond the current tags in the TemplateVersion.
"tags": [ # All the tags in the TemplateVersion.
"A String",
],
}</pre>
</div>
</body></html>
|
