File: manager_v1beta2.templates.html

package info (click to toggle)
python-googleapi 1.5.0-2~bpo8%2B1
  • links: PTS
  • area: main
  • in suites: jessie-backports
  • size: 28,336 kB
  • sloc: python: 6,808; makefile: 64; sh: 53; xml: 5
file content (809 lines) | stat: -rw-r--r-- 51,198 bytes parent folder | download
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
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
<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="manager_v1beta2.html">Deployment Manager API</a> . <a href="manager_v1beta2.templates.html">templates</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#delete">delete(projectId, templateName)</a></code></p>
<p class="firstline"></p>
<p class="toc_element">
  <code><a href="#get">get(projectId, templateName)</a></code></p>
<p class="firstline"></p>
<p class="toc_element">
  <code><a href="#insert">insert(projectId, body)</a></code></p>
<p class="firstline"></p>
<p class="toc_element">
  <code><a href="#list">list(projectId, pageToken=None, maxResults=None)</a></code></p>
<p class="firstline"></p>
<p class="toc_element">
  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="delete">delete(projectId, templateName)</code>
  <pre>

Args:
  projectId: string, A parameter (required)
  templateName: string, A parameter (required)
</pre>
</div>

<div class="method">
    <code class="details" id="get">get(projectId, templateName)</code>
  <pre>

Args:
  projectId: string, A parameter (required)
  templateName: string, A parameter (required)

Returns:
  An object of the form:

    { # A Template represents a complete configuration for a Deployment.
      "modules": { # A list of modules for this Template.
        "a_key": { # A module in a configuration. A module represents a single homogeneous, possibly replicated task. # Name of the module. The name must conform to the following regular expression: [a-zA-Z0-9-_]{1,64}
          "lbModule": {
            "description": "A String",
            "portRange": "A String",
            "sessionAffinity": "A String",
            "ipProtocol": "A String",
            "healthChecks": [
              "A String",
            ],
            "ipAddress": "A String",
            "targetModules": [
              "A String",
            ],
          },
          "networkModule": {
            "IPv4Range": "A String", # Required; The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16.
            "gatewayIPv4": "A String", # An optional address that is used for default routing to other networks. This must be within the range specified by IPv4Range, and is typicall the first usable address in that range. If not specified, the default value is the first usable address in IPv4Range.
            "description": "A String", # The description of the network.
          },
          "firewallModule": { # A Firewall resource
            "network": "A String", # The NetworkModule to which this firewall should apply. If not specified, or if specified as 'default', this firewall will be applied to the 'default' network.
            "sourceTags": [ # Source Tags to apply this firewall to, see the GCE Spec for details on syntax
              "A String",
            ],
            "sourceRanges": [ # Source IP ranges to apply this firewall to, see the GCE Spec for details on syntax
              "A String",
            ],
            "targetTags": [ # Target Tags to apply this firewall to, see the GCE Spec for details on syntax
              "A String",
            ],
            "allowed": [ # The allowed ports or port ranges.
              { # An allowed port resource.
                "IPProtocol": "A String", # ?tcp?, ?udp? or ?icmp?
                "ports": [ # List of ports or port ranges (Example inputs include: ["22"], [?33?, "12345-12349"].
                  "A String",
                ],
              },
            ],
            "description": "A String", # The description of the firewall (optional)
          },
          "healthCheckModule": {
            "description": "A String",
            "timeoutSec": 42,
            "checkIntervalSec": 42,
            "unhealthyThreshold": 42,
            "healthyThreshold": 42,
            "host": "A String",
            "path": "A String",
            "port": 42,
          },
          "autoscalingModule": {
            "maxNumReplicas": 42,
            "description": "A String",
            "targetModule": "A String",
            "targetUtilization": 3.14, # target_utilization should be in range [0,1].
            "signalType": "A String",
            "coolDownPeriodSec": 42,
            "minNumReplicas": 42,
          },
          "replicaPoolModule": {
            "numReplicas": 42, # Number of replicas in this module.
            "healthChecks": [ # The Health Checks to configure for the ReplicaPoolModule
              "A String",
            ],
            "resourceView": "A String", # [Output Only] The name of the Resource View associated with a ReplicaPoolModule. This field will be generated by the service.
            "envVariables": { # A list of environment variables.
              "a_key": { # An environment variable. # Name of the environment variable. The name must conform to the following regular expression: [a-zA-Z_]+[a-zA-Z0-9_]+.
                "hidden": True or False, # Whether this variable is hidden or visible.
                "value": "A String", # Value of the environment variable.
              },
            },
            "replicaPoolParams": { # Configuration information for a ReplicaPools resource. Specifying an item within will determine the ReplicaPools API version used for a ReplicaPoolModule. Only one may be specified. # Information for a ReplicaPoolModule.
              "v1beta1": { # Configuration information for a ReplicaPools v1beta1 API resource. Directly maps to ReplicaPool InitTemplate. # ReplicaPoolParams specifications for use with ReplicaPools v1beta1.
                "disksToCreate": [ # A list of Disk resources to create and attach to each Replica in the Pool. Currently, you can only define one disk and it must be a root persistent disk. Note that Replica Pool will create a root persistent disk for each replica.
                  { # A Persistent Disk resource that will be created and attached to each Replica in the Pool. Each Replica will have a unique persistent disk that is created and attached to that Replica.
                    "initializeParams": { # Initialization parameters for creating a new disk. # Create the new disk using these parameters. The name of the disk will be <instance_name>-<five_random_charactersgt;.
                      "diskSizeGb": "A String", # The size of the created disk in gigabytes.
                      "sourceImage": "A String", # The fully-qualified URL of a source image to use to create this disk.
                      "diskType": "A String", # Name of the disk type resource describing which disk type to use to create the disk. For example 'pd-ssd' or 'pd-standard'. Default is 'pd-standard'
                    },
                    "boot": True or False, # If true, indicates that this is the root persistent disk.
                    "attachment": { # How to attach a disk to a Replica. # How the disk will be attached to the Replica.
                      "deviceName": "A String", # The device name of this disk.
                      "index": 42, # A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, this is assigned by the server.
                    },
                    "autoDelete": True or False, # If true, then this disk will be deleted when the instance is deleted.
                  },
                ],
                "autoRestart": True or False, # Whether these replicas should be restarted if they experience a failure. The default value is true.
                "canIpForward": True or False, # Enables IP Forwarding
                "description": "A String", # An optional textual description of the resource.
                "zone": "A String", # The zone for this ReplicaPool.
                "tags": { # A Compute Engine Instance tag, identical to the tags on the corresponding Compute Engine Instance resource. # A list of tags to apply to the Google Compute Engine instance to identify resources.
                  "items": [ # Items contained in this tag.
                    "A String",
                  ],
                  "fingerPrint": "A String", # The fingerprint of the tag.
                },
                "onHostMaintenance": "A String",
                "disksToAttach": [ # A list of existing Persistent Disk resources to attach to each replica in the pool. Each disk will be attached in read-only mode to every replica.
                  { # A pre-existing persistent disk that will be attached to every Replica in the Pool.
                    "source": "A String", # The fully-qualified URL of the Persistent Disk resource. It must be in the same zone as the Pool.
                    "attachment": { # How to attach a disk to a Replica. # Optional. How the disk will be attached to the Replica.
                      "deviceName": "A String", # The device name of this disk.
                      "index": 42, # A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, this is assigned by the server.
                    },
                  },
                ],
                "machineType": "A String", # The machine type for this instance. Either a complete URL, or the resource name (e.g. n1-standard-1).
                "baseInstanceName": "A String", # The base name for instances within this ReplicaPool.
                "initAction": "A String", # Name of the Action to be run during initialization of a ReplicaPoolModule.
                "networkInterfaces": [ # A list of network interfaces for the instance. Currently only one interface is supported by Google Compute Engine.
                  { # A Compute Engine NetworkInterface resource. Identical to the NetworkInterface on the corresponding Compute Engine resource.
                    "accessConfigs": [ # An array of configurations for this interface. This specifies how this interface is configured to interact with other network services
                      { # A Compute Engine network accessConfig. Identical to the accessConfig on corresponding Compute Engine resource.
                        "type": "A String", # Type of this access configuration file. (Currently only ONE_TO_ONE_NAT is legal.)
                        "name": "A String", # Name of this access configuration.
                        "natIp": "A String", # An external IP address associated with this instance.
                      },
                    ],
                    "networkIp": "A String", # An optional IPV4 internal network address to assign to the instance for this network interface.
                    "name": "A String", # Name of the interface.
                    "network": "A String", # The name of the NetworkModule to which this interface applies. If not specified, or specified as 'default', this will use the 'default' network.
                  },
                ],
                "serviceAccounts": [ # A list of Service Accounts to enable for this instance.
                  { # A Compute Engine service account, identical to the Compute Engine resource.
                    "scopes": [ # List of OAuth2 scopes to obtain for the service account.
                      "A String",
                    ],
                    "email": "A String", # Service account email address.
                  },
                ],
                "metadata": { # A Compute Engine metadata entry. Identical to the metadata on the corresponding Compute Engine resource. # The metadata key/value pairs assigned to this instance.
                  "items": [ # A list of metadata items.
                    { # A Compute Engine metadata item, defined as a key:value pair. Identical to the metadata on the corresponding Compute Engine resource.
                      "value": "A String", # A metadata value.
                      "key": "A String", # A metadata key.
                    },
                  ],
                  "fingerPrint": "A String", # The fingerprint of the metadata.
                },
              },
            },
          },
          "type": "A String", # The type of this module. Valid values ("AUTOSCALING", "FIREWALL", "HEALTH_CHECK", "LOAD_BALANCING", "NETWORK", "REPLICA_POOL")
        },
      },
      "description": "A String", # A user-supplied description of this Template.
      "actions": { # Action definitions for use in Module intents in this Template.
        "a_key": { # An Action encapsulates a set of commands as a single runnable module with additional information needed during run-time. # The name of this action, used when specifying Actions in Module definitions.
          "timeoutMs": 42, # The timeout in milliseconds for this action to run.
          "commands": [ # A list of commands to run sequentially for this action.
            "A String",
          ],
        },
      },
      "name": "A String", # Name of this Template. The name must conform to the expression: [a-zA-Z0-9-_]{1,64}
    }</pre>
</div>

<div class="method">
    <code class="details" id="insert">insert(projectId, body)</code>
  <pre>

Args:
  projectId: string, A parameter (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A Template represents a complete configuration for a Deployment.
    "modules": { # A list of modules for this Template.
      "a_key": { # A module in a configuration. A module represents a single homogeneous, possibly replicated task. # Name of the module. The name must conform to the following regular expression: [a-zA-Z0-9-_]{1,64}
        "lbModule": {
          "description": "A String",
          "portRange": "A String",
          "sessionAffinity": "A String",
          "ipProtocol": "A String",
          "healthChecks": [
            "A String",
          ],
          "ipAddress": "A String",
          "targetModules": [
            "A String",
          ],
        },
        "networkModule": {
          "IPv4Range": "A String", # Required; The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16.
          "gatewayIPv4": "A String", # An optional address that is used for default routing to other networks. This must be within the range specified by IPv4Range, and is typicall the first usable address in that range. If not specified, the default value is the first usable address in IPv4Range.
          "description": "A String", # The description of the network.
        },
        "firewallModule": { # A Firewall resource
          "network": "A String", # The NetworkModule to which this firewall should apply. If not specified, or if specified as 'default', this firewall will be applied to the 'default' network.
          "sourceTags": [ # Source Tags to apply this firewall to, see the GCE Spec for details on syntax
            "A String",
          ],
          "sourceRanges": [ # Source IP ranges to apply this firewall to, see the GCE Spec for details on syntax
            "A String",
          ],
          "targetTags": [ # Target Tags to apply this firewall to, see the GCE Spec for details on syntax
            "A String",
          ],
          "allowed": [ # The allowed ports or port ranges.
            { # An allowed port resource.
              "IPProtocol": "A String", # ?tcp?, ?udp? or ?icmp?
              "ports": [ # List of ports or port ranges (Example inputs include: ["22"], [?33?, "12345-12349"].
                "A String",
              ],
            },
          ],
          "description": "A String", # The description of the firewall (optional)
        },
        "healthCheckModule": {
          "description": "A String",
          "timeoutSec": 42,
          "checkIntervalSec": 42,
          "unhealthyThreshold": 42,
          "healthyThreshold": 42,
          "host": "A String",
          "path": "A String",
          "port": 42,
        },
        "autoscalingModule": {
          "maxNumReplicas": 42,
          "description": "A String",
          "targetModule": "A String",
          "targetUtilization": 3.14, # target_utilization should be in range [0,1].
          "signalType": "A String",
          "coolDownPeriodSec": 42,
          "minNumReplicas": 42,
        },
        "replicaPoolModule": {
          "numReplicas": 42, # Number of replicas in this module.
          "healthChecks": [ # The Health Checks to configure for the ReplicaPoolModule
            "A String",
          ],
          "resourceView": "A String", # [Output Only] The name of the Resource View associated with a ReplicaPoolModule. This field will be generated by the service.
          "envVariables": { # A list of environment variables.
            "a_key": { # An environment variable. # Name of the environment variable. The name must conform to the following regular expression: [a-zA-Z_]+[a-zA-Z0-9_]+.
              "hidden": True or False, # Whether this variable is hidden or visible.
              "value": "A String", # Value of the environment variable.
            },
          },
          "replicaPoolParams": { # Configuration information for a ReplicaPools resource. Specifying an item within will determine the ReplicaPools API version used for a ReplicaPoolModule. Only one may be specified. # Information for a ReplicaPoolModule.
            "v1beta1": { # Configuration information for a ReplicaPools v1beta1 API resource. Directly maps to ReplicaPool InitTemplate. # ReplicaPoolParams specifications for use with ReplicaPools v1beta1.
              "disksToCreate": [ # A list of Disk resources to create and attach to each Replica in the Pool. Currently, you can only define one disk and it must be a root persistent disk. Note that Replica Pool will create a root persistent disk for each replica.
                { # A Persistent Disk resource that will be created and attached to each Replica in the Pool. Each Replica will have a unique persistent disk that is created and attached to that Replica.
                  "initializeParams": { # Initialization parameters for creating a new disk. # Create the new disk using these parameters. The name of the disk will be <instance_name>-<five_random_charactersgt;.
                    "diskSizeGb": "A String", # The size of the created disk in gigabytes.
                    "sourceImage": "A String", # The fully-qualified URL of a source image to use to create this disk.
                    "diskType": "A String", # Name of the disk type resource describing which disk type to use to create the disk. For example 'pd-ssd' or 'pd-standard'. Default is 'pd-standard'
                  },
                  "boot": True or False, # If true, indicates that this is the root persistent disk.
                  "attachment": { # How to attach a disk to a Replica. # How the disk will be attached to the Replica.
                    "deviceName": "A String", # The device name of this disk.
                    "index": 42, # A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, this is assigned by the server.
                  },
                  "autoDelete": True or False, # If true, then this disk will be deleted when the instance is deleted.
                },
              ],
              "autoRestart": True or False, # Whether these replicas should be restarted if they experience a failure. The default value is true.
              "canIpForward": True or False, # Enables IP Forwarding
              "description": "A String", # An optional textual description of the resource.
              "zone": "A String", # The zone for this ReplicaPool.
              "tags": { # A Compute Engine Instance tag, identical to the tags on the corresponding Compute Engine Instance resource. # A list of tags to apply to the Google Compute Engine instance to identify resources.
                "items": [ # Items contained in this tag.
                  "A String",
                ],
                "fingerPrint": "A String", # The fingerprint of the tag.
              },
              "onHostMaintenance": "A String",
              "disksToAttach": [ # A list of existing Persistent Disk resources to attach to each replica in the pool. Each disk will be attached in read-only mode to every replica.
                { # A pre-existing persistent disk that will be attached to every Replica in the Pool.
                  "source": "A String", # The fully-qualified URL of the Persistent Disk resource. It must be in the same zone as the Pool.
                  "attachment": { # How to attach a disk to a Replica. # Optional. How the disk will be attached to the Replica.
                    "deviceName": "A String", # The device name of this disk.
                    "index": 42, # A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, this is assigned by the server.
                  },
                },
              ],
              "machineType": "A String", # The machine type for this instance. Either a complete URL, or the resource name (e.g. n1-standard-1).
              "baseInstanceName": "A String", # The base name for instances within this ReplicaPool.
              "initAction": "A String", # Name of the Action to be run during initialization of a ReplicaPoolModule.
              "networkInterfaces": [ # A list of network interfaces for the instance. Currently only one interface is supported by Google Compute Engine.
                { # A Compute Engine NetworkInterface resource. Identical to the NetworkInterface on the corresponding Compute Engine resource.
                  "accessConfigs": [ # An array of configurations for this interface. This specifies how this interface is configured to interact with other network services
                    { # A Compute Engine network accessConfig. Identical to the accessConfig on corresponding Compute Engine resource.
                      "type": "A String", # Type of this access configuration file. (Currently only ONE_TO_ONE_NAT is legal.)
                      "name": "A String", # Name of this access configuration.
                      "natIp": "A String", # An external IP address associated with this instance.
                    },
                  ],
                  "networkIp": "A String", # An optional IPV4 internal network address to assign to the instance for this network interface.
                  "name": "A String", # Name of the interface.
                  "network": "A String", # The name of the NetworkModule to which this interface applies. If not specified, or specified as 'default', this will use the 'default' network.
                },
              ],
              "serviceAccounts": [ # A list of Service Accounts to enable for this instance.
                { # A Compute Engine service account, identical to the Compute Engine resource.
                  "scopes": [ # List of OAuth2 scopes to obtain for the service account.
                    "A String",
                  ],
                  "email": "A String", # Service account email address.
                },
              ],
              "metadata": { # A Compute Engine metadata entry. Identical to the metadata on the corresponding Compute Engine resource. # The metadata key/value pairs assigned to this instance.
                "items": [ # A list of metadata items.
                  { # A Compute Engine metadata item, defined as a key:value pair. Identical to the metadata on the corresponding Compute Engine resource.
                    "value": "A String", # A metadata value.
                    "key": "A String", # A metadata key.
                  },
                ],
                "fingerPrint": "A String", # The fingerprint of the metadata.
              },
            },
          },
        },
        "type": "A String", # The type of this module. Valid values ("AUTOSCALING", "FIREWALL", "HEALTH_CHECK", "LOAD_BALANCING", "NETWORK", "REPLICA_POOL")
      },
    },
    "description": "A String", # A user-supplied description of this Template.
    "actions": { # Action definitions for use in Module intents in this Template.
      "a_key": { # An Action encapsulates a set of commands as a single runnable module with additional information needed during run-time. # The name of this action, used when specifying Actions in Module definitions.
        "timeoutMs": 42, # The timeout in milliseconds for this action to run.
        "commands": [ # A list of commands to run sequentially for this action.
          "A String",
        ],
      },
    },
    "name": "A String", # Name of this Template. The name must conform to the expression: [a-zA-Z0-9-_]{1,64}
  }


Returns:
  An object of the form:

    { # A Template represents a complete configuration for a Deployment.
      "modules": { # A list of modules for this Template.
        "a_key": { # A module in a configuration. A module represents a single homogeneous, possibly replicated task. # Name of the module. The name must conform to the following regular expression: [a-zA-Z0-9-_]{1,64}
          "lbModule": {
            "description": "A String",
            "portRange": "A String",
            "sessionAffinity": "A String",
            "ipProtocol": "A String",
            "healthChecks": [
              "A String",
            ],
            "ipAddress": "A String",
            "targetModules": [
              "A String",
            ],
          },
          "networkModule": {
            "IPv4Range": "A String", # Required; The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16.
            "gatewayIPv4": "A String", # An optional address that is used for default routing to other networks. This must be within the range specified by IPv4Range, and is typicall the first usable address in that range. If not specified, the default value is the first usable address in IPv4Range.
            "description": "A String", # The description of the network.
          },
          "firewallModule": { # A Firewall resource
            "network": "A String", # The NetworkModule to which this firewall should apply. If not specified, or if specified as 'default', this firewall will be applied to the 'default' network.
            "sourceTags": [ # Source Tags to apply this firewall to, see the GCE Spec for details on syntax
              "A String",
            ],
            "sourceRanges": [ # Source IP ranges to apply this firewall to, see the GCE Spec for details on syntax
              "A String",
            ],
            "targetTags": [ # Target Tags to apply this firewall to, see the GCE Spec for details on syntax
              "A String",
            ],
            "allowed": [ # The allowed ports or port ranges.
              { # An allowed port resource.
                "IPProtocol": "A String", # ?tcp?, ?udp? or ?icmp?
                "ports": [ # List of ports or port ranges (Example inputs include: ["22"], [?33?, "12345-12349"].
                  "A String",
                ],
              },
            ],
            "description": "A String", # The description of the firewall (optional)
          },
          "healthCheckModule": {
            "description": "A String",
            "timeoutSec": 42,
            "checkIntervalSec": 42,
            "unhealthyThreshold": 42,
            "healthyThreshold": 42,
            "host": "A String",
            "path": "A String",
            "port": 42,
          },
          "autoscalingModule": {
            "maxNumReplicas": 42,
            "description": "A String",
            "targetModule": "A String",
            "targetUtilization": 3.14, # target_utilization should be in range [0,1].
            "signalType": "A String",
            "coolDownPeriodSec": 42,
            "minNumReplicas": 42,
          },
          "replicaPoolModule": {
            "numReplicas": 42, # Number of replicas in this module.
            "healthChecks": [ # The Health Checks to configure for the ReplicaPoolModule
              "A String",
            ],
            "resourceView": "A String", # [Output Only] The name of the Resource View associated with a ReplicaPoolModule. This field will be generated by the service.
            "envVariables": { # A list of environment variables.
              "a_key": { # An environment variable. # Name of the environment variable. The name must conform to the following regular expression: [a-zA-Z_]+[a-zA-Z0-9_]+.
                "hidden": True or False, # Whether this variable is hidden or visible.
                "value": "A String", # Value of the environment variable.
              },
            },
            "replicaPoolParams": { # Configuration information for a ReplicaPools resource. Specifying an item within will determine the ReplicaPools API version used for a ReplicaPoolModule. Only one may be specified. # Information for a ReplicaPoolModule.
              "v1beta1": { # Configuration information for a ReplicaPools v1beta1 API resource. Directly maps to ReplicaPool InitTemplate. # ReplicaPoolParams specifications for use with ReplicaPools v1beta1.
                "disksToCreate": [ # A list of Disk resources to create and attach to each Replica in the Pool. Currently, you can only define one disk and it must be a root persistent disk. Note that Replica Pool will create a root persistent disk for each replica.
                  { # A Persistent Disk resource that will be created and attached to each Replica in the Pool. Each Replica will have a unique persistent disk that is created and attached to that Replica.
                    "initializeParams": { # Initialization parameters for creating a new disk. # Create the new disk using these parameters. The name of the disk will be <instance_name>-<five_random_charactersgt;.
                      "diskSizeGb": "A String", # The size of the created disk in gigabytes.
                      "sourceImage": "A String", # The fully-qualified URL of a source image to use to create this disk.
                      "diskType": "A String", # Name of the disk type resource describing which disk type to use to create the disk. For example 'pd-ssd' or 'pd-standard'. Default is 'pd-standard'
                    },
                    "boot": True or False, # If true, indicates that this is the root persistent disk.
                    "attachment": { # How to attach a disk to a Replica. # How the disk will be attached to the Replica.
                      "deviceName": "A String", # The device name of this disk.
                      "index": 42, # A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, this is assigned by the server.
                    },
                    "autoDelete": True or False, # If true, then this disk will be deleted when the instance is deleted.
                  },
                ],
                "autoRestart": True or False, # Whether these replicas should be restarted if they experience a failure. The default value is true.
                "canIpForward": True or False, # Enables IP Forwarding
                "description": "A String", # An optional textual description of the resource.
                "zone": "A String", # The zone for this ReplicaPool.
                "tags": { # A Compute Engine Instance tag, identical to the tags on the corresponding Compute Engine Instance resource. # A list of tags to apply to the Google Compute Engine instance to identify resources.
                  "items": [ # Items contained in this tag.
                    "A String",
                  ],
                  "fingerPrint": "A String", # The fingerprint of the tag.
                },
                "onHostMaintenance": "A String",
                "disksToAttach": [ # A list of existing Persistent Disk resources to attach to each replica in the pool. Each disk will be attached in read-only mode to every replica.
                  { # A pre-existing persistent disk that will be attached to every Replica in the Pool.
                    "source": "A String", # The fully-qualified URL of the Persistent Disk resource. It must be in the same zone as the Pool.
                    "attachment": { # How to attach a disk to a Replica. # Optional. How the disk will be attached to the Replica.
                      "deviceName": "A String", # The device name of this disk.
                      "index": 42, # A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, this is assigned by the server.
                    },
                  },
                ],
                "machineType": "A String", # The machine type for this instance. Either a complete URL, or the resource name (e.g. n1-standard-1).
                "baseInstanceName": "A String", # The base name for instances within this ReplicaPool.
                "initAction": "A String", # Name of the Action to be run during initialization of a ReplicaPoolModule.
                "networkInterfaces": [ # A list of network interfaces for the instance. Currently only one interface is supported by Google Compute Engine.
                  { # A Compute Engine NetworkInterface resource. Identical to the NetworkInterface on the corresponding Compute Engine resource.
                    "accessConfigs": [ # An array of configurations for this interface. This specifies how this interface is configured to interact with other network services
                      { # A Compute Engine network accessConfig. Identical to the accessConfig on corresponding Compute Engine resource.
                        "type": "A String", # Type of this access configuration file. (Currently only ONE_TO_ONE_NAT is legal.)
                        "name": "A String", # Name of this access configuration.
                        "natIp": "A String", # An external IP address associated with this instance.
                      },
                    ],
                    "networkIp": "A String", # An optional IPV4 internal network address to assign to the instance for this network interface.
                    "name": "A String", # Name of the interface.
                    "network": "A String", # The name of the NetworkModule to which this interface applies. If not specified, or specified as 'default', this will use the 'default' network.
                  },
                ],
                "serviceAccounts": [ # A list of Service Accounts to enable for this instance.
                  { # A Compute Engine service account, identical to the Compute Engine resource.
                    "scopes": [ # List of OAuth2 scopes to obtain for the service account.
                      "A String",
                    ],
                    "email": "A String", # Service account email address.
                  },
                ],
                "metadata": { # A Compute Engine metadata entry. Identical to the metadata on the corresponding Compute Engine resource. # The metadata key/value pairs assigned to this instance.
                  "items": [ # A list of metadata items.
                    { # A Compute Engine metadata item, defined as a key:value pair. Identical to the metadata on the corresponding Compute Engine resource.
                      "value": "A String", # A metadata value.
                      "key": "A String", # A metadata key.
                    },
                  ],
                  "fingerPrint": "A String", # The fingerprint of the metadata.
                },
              },
            },
          },
          "type": "A String", # The type of this module. Valid values ("AUTOSCALING", "FIREWALL", "HEALTH_CHECK", "LOAD_BALANCING", "NETWORK", "REPLICA_POOL")
        },
      },
      "description": "A String", # A user-supplied description of this Template.
      "actions": { # Action definitions for use in Module intents in this Template.
        "a_key": { # An Action encapsulates a set of commands as a single runnable module with additional information needed during run-time. # The name of this action, used when specifying Actions in Module definitions.
          "timeoutMs": 42, # The timeout in milliseconds for this action to run.
          "commands": [ # A list of commands to run sequentially for this action.
            "A String",
          ],
        },
      },
      "name": "A String", # Name of this Template. The name must conform to the expression: [a-zA-Z0-9-_]{1,64}
    }</pre>
</div>

<div class="method">
    <code class="details" id="list">list(projectId, pageToken=None, maxResults=None)</code>
  <pre>

Args:
  projectId: string, A parameter (required)
  pageToken: string, Specifies a nextPageToken returned by a previous list request. This token can be used to request the next page of results from a previous list request.
  maxResults: integer, Maximum count of results to be returned. Acceptable values are 0 to 100, inclusive. (Default: 50)

Returns:
  An object of the form:

    {
    "nextPageToken": "A String",
    "resources": [
      { # A Template represents a complete configuration for a Deployment.
          "modules": { # A list of modules for this Template.
            "a_key": { # A module in a configuration. A module represents a single homogeneous, possibly replicated task. # Name of the module. The name must conform to the following regular expression: [a-zA-Z0-9-_]{1,64}
              "lbModule": {
                "description": "A String",
                "portRange": "A String",
                "sessionAffinity": "A String",
                "ipProtocol": "A String",
                "healthChecks": [
                  "A String",
                ],
                "ipAddress": "A String",
                "targetModules": [
                  "A String",
                ],
              },
              "networkModule": {
                "IPv4Range": "A String", # Required; The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16.
                "gatewayIPv4": "A String", # An optional address that is used for default routing to other networks. This must be within the range specified by IPv4Range, and is typicall the first usable address in that range. If not specified, the default value is the first usable address in IPv4Range.
                "description": "A String", # The description of the network.
              },
              "firewallModule": { # A Firewall resource
                "network": "A String", # The NetworkModule to which this firewall should apply. If not specified, or if specified as 'default', this firewall will be applied to the 'default' network.
                "sourceTags": [ # Source Tags to apply this firewall to, see the GCE Spec for details on syntax
                  "A String",
                ],
                "sourceRanges": [ # Source IP ranges to apply this firewall to, see the GCE Spec for details on syntax
                  "A String",
                ],
                "targetTags": [ # Target Tags to apply this firewall to, see the GCE Spec for details on syntax
                  "A String",
                ],
                "allowed": [ # The allowed ports or port ranges.
                  { # An allowed port resource.
                    "IPProtocol": "A String", # ?tcp?, ?udp? or ?icmp?
                    "ports": [ # List of ports or port ranges (Example inputs include: ["22"], [?33?, "12345-12349"].
                      "A String",
                    ],
                  },
                ],
                "description": "A String", # The description of the firewall (optional)
              },
              "healthCheckModule": {
                "description": "A String",
                "timeoutSec": 42,
                "checkIntervalSec": 42,
                "unhealthyThreshold": 42,
                "healthyThreshold": 42,
                "host": "A String",
                "path": "A String",
                "port": 42,
              },
              "autoscalingModule": {
                "maxNumReplicas": 42,
                "description": "A String",
                "targetModule": "A String",
                "targetUtilization": 3.14, # target_utilization should be in range [0,1].
                "signalType": "A String",
                "coolDownPeriodSec": 42,
                "minNumReplicas": 42,
              },
              "replicaPoolModule": {
                "numReplicas": 42, # Number of replicas in this module.
                "healthChecks": [ # The Health Checks to configure for the ReplicaPoolModule
                  "A String",
                ],
                "resourceView": "A String", # [Output Only] The name of the Resource View associated with a ReplicaPoolModule. This field will be generated by the service.
                "envVariables": { # A list of environment variables.
                  "a_key": { # An environment variable. # Name of the environment variable. The name must conform to the following regular expression: [a-zA-Z_]+[a-zA-Z0-9_]+.
                    "hidden": True or False, # Whether this variable is hidden or visible.
                    "value": "A String", # Value of the environment variable.
                  },
                },
                "replicaPoolParams": { # Configuration information for a ReplicaPools resource. Specifying an item within will determine the ReplicaPools API version used for a ReplicaPoolModule. Only one may be specified. # Information for a ReplicaPoolModule.
                  "v1beta1": { # Configuration information for a ReplicaPools v1beta1 API resource. Directly maps to ReplicaPool InitTemplate. # ReplicaPoolParams specifications for use with ReplicaPools v1beta1.
                    "disksToCreate": [ # A list of Disk resources to create and attach to each Replica in the Pool. Currently, you can only define one disk and it must be a root persistent disk. Note that Replica Pool will create a root persistent disk for each replica.
                      { # A Persistent Disk resource that will be created and attached to each Replica in the Pool. Each Replica will have a unique persistent disk that is created and attached to that Replica.
                        "initializeParams": { # Initialization parameters for creating a new disk. # Create the new disk using these parameters. The name of the disk will be <instance_name>-<five_random_charactersgt;.
                          "diskSizeGb": "A String", # The size of the created disk in gigabytes.
                          "sourceImage": "A String", # The fully-qualified URL of a source image to use to create this disk.
                          "diskType": "A String", # Name of the disk type resource describing which disk type to use to create the disk. For example 'pd-ssd' or 'pd-standard'. Default is 'pd-standard'
                        },
                        "boot": True or False, # If true, indicates that this is the root persistent disk.
                        "attachment": { # How to attach a disk to a Replica. # How the disk will be attached to the Replica.
                          "deviceName": "A String", # The device name of this disk.
                          "index": 42, # A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, this is assigned by the server.
                        },
                        "autoDelete": True or False, # If true, then this disk will be deleted when the instance is deleted.
                      },
                    ],
                    "autoRestart": True or False, # Whether these replicas should be restarted if they experience a failure. The default value is true.
                    "canIpForward": True or False, # Enables IP Forwarding
                    "description": "A String", # An optional textual description of the resource.
                    "zone": "A String", # The zone for this ReplicaPool.
                    "tags": { # A Compute Engine Instance tag, identical to the tags on the corresponding Compute Engine Instance resource. # A list of tags to apply to the Google Compute Engine instance to identify resources.
                      "items": [ # Items contained in this tag.
                        "A String",
                      ],
                      "fingerPrint": "A String", # The fingerprint of the tag.
                    },
                    "onHostMaintenance": "A String",
                    "disksToAttach": [ # A list of existing Persistent Disk resources to attach to each replica in the pool. Each disk will be attached in read-only mode to every replica.
                      { # A pre-existing persistent disk that will be attached to every Replica in the Pool.
                        "source": "A String", # The fully-qualified URL of the Persistent Disk resource. It must be in the same zone as the Pool.
                        "attachment": { # How to attach a disk to a Replica. # Optional. How the disk will be attached to the Replica.
                          "deviceName": "A String", # The device name of this disk.
                          "index": 42, # A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, this is assigned by the server.
                        },
                      },
                    ],
                    "machineType": "A String", # The machine type for this instance. Either a complete URL, or the resource name (e.g. n1-standard-1).
                    "baseInstanceName": "A String", # The base name for instances within this ReplicaPool.
                    "initAction": "A String", # Name of the Action to be run during initialization of a ReplicaPoolModule.
                    "networkInterfaces": [ # A list of network interfaces for the instance. Currently only one interface is supported by Google Compute Engine.
                      { # A Compute Engine NetworkInterface resource. Identical to the NetworkInterface on the corresponding Compute Engine resource.
                        "accessConfigs": [ # An array of configurations for this interface. This specifies how this interface is configured to interact with other network services
                          { # A Compute Engine network accessConfig. Identical to the accessConfig on corresponding Compute Engine resource.
                            "type": "A String", # Type of this access configuration file. (Currently only ONE_TO_ONE_NAT is legal.)
                            "name": "A String", # Name of this access configuration.
                            "natIp": "A String", # An external IP address associated with this instance.
                          },
                        ],
                        "networkIp": "A String", # An optional IPV4 internal network address to assign to the instance for this network interface.
                        "name": "A String", # Name of the interface.
                        "network": "A String", # The name of the NetworkModule to which this interface applies. If not specified, or specified as 'default', this will use the 'default' network.
                      },
                    ],
                    "serviceAccounts": [ # A list of Service Accounts to enable for this instance.
                      { # A Compute Engine service account, identical to the Compute Engine resource.
                        "scopes": [ # List of OAuth2 scopes to obtain for the service account.
                          "A String",
                        ],
                        "email": "A String", # Service account email address.
                      },
                    ],
                    "metadata": { # A Compute Engine metadata entry. Identical to the metadata on the corresponding Compute Engine resource. # The metadata key/value pairs assigned to this instance.
                      "items": [ # A list of metadata items.
                        { # A Compute Engine metadata item, defined as a key:value pair. Identical to the metadata on the corresponding Compute Engine resource.
                          "value": "A String", # A metadata value.
                          "key": "A String", # A metadata key.
                        },
                      ],
                      "fingerPrint": "A String", # The fingerprint of the metadata.
                    },
                  },
                },
              },
              "type": "A String", # The type of this module. Valid values ("AUTOSCALING", "FIREWALL", "HEALTH_CHECK", "LOAD_BALANCING", "NETWORK", "REPLICA_POOL")
            },
          },
          "description": "A String", # A user-supplied description of this Template.
          "actions": { # Action definitions for use in Module intents in this Template.
            "a_key": { # An Action encapsulates a set of commands as a single runnable module with additional information needed during run-time. # The name of this action, used when specifying Actions in Module definitions.
              "timeoutMs": 42, # The timeout in milliseconds for this action to run.
              "commands": [ # A list of commands to run sequentially for this action.
                "A String",
              ],
            },
          },
          "name": "A String", # Name of this Template. The name must conform to the expression: [a-zA-Z0-9-_]{1,64}
        },
    ],
  }</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
  <pre>Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.
    </pre>
</div>

</body></html>