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
|
<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.deployments.html">deployments</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(projectId, region, deploymentName)</a></code></p>
<p class="firstline"></p>
<p class="toc_element">
<code><a href="#get">get(projectId, region, deploymentName)</a></code></p>
<p class="firstline"></p>
<p class="toc_element">
<code><a href="#insert">insert(projectId, region, body)</a></code></p>
<p class="firstline"></p>
<p class="toc_element">
<code><a href="#list">list(projectId, region, 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, region, deploymentName)</code>
<pre>
Args:
projectId: string, A parameter (required)
region: string, A parameter (required)
deploymentName: string, A parameter (required)
</pre>
</div>
<div class="method">
<code class="details" id="get">get(projectId, region, deploymentName)</code>
<pre>
Args:
projectId: string, A parameter (required)
region: string, A parameter (required)
deploymentName: string, A parameter (required)
Returns:
An object of the form:
{ # A deployment represents a physical instantiation of a Template.
"description": "A String", # A user-supplied description of this Deployment.
"templateName": "A String", # The name of the Template on which this deployment is based.
"overrides": [ # The set of parameter overrides to apply to the corresponding Template before deploying.
{ # A specification for overriding parameters in a Template that corresponds to the Deployment.
"path": "A String", # A JSON Path expression that specifies which parameter should be overridden.
"value": "A String", # The new value to assign to the overridden parameter.
},
],
"modules": { # [Output Only] List of status for the modules in this deployment.
"a_key": { # [Output Only] Aggregate status for a module. # Name of the module.
"healthCheckModuleStatus": { # [Output Only] The status of the HealthCheckModule, set for type HEALTH_CHECK.
"healthCheckUrl": "A String", # [Output Only] The HealthCheck URL.
},
"replicaPoolModuleStatus": { # [Output Only] The status of the ReplicaPoolModule, set for type VM.
"resourceViewUrl": "A String", # [Output Only] The URL of the Resource Group associated with this ReplicaPool.
"replicaPoolUrl": "A String", # [Output Only] The URL of the associated ReplicaPool resource.
},
"networkModuleStatus": { # [Output Only] The status of the NetworkModule, set for type NETWORK.
"networkUrl": "A String", # [Output Only] The URL of the corresponding Network resource.
},
"state": { # [Output Only] The current state of a replica or module. # [Output Only] The current state of the module.
"status": "A String", # [Output Only] The status of the deployment. Possible values include:
# - UNKNOWN
# - DEPLOYING
# - DEPLOYED
# - DEPLOYMENT_FAILED
# - DELETING
# - DELETED
# - DELETE_FAILED
"details": "A String", # [Output Only] Human readable details about the current state.
},
"autoscalingModuleStatus": { # [Output Only] The status of the AutoscalingModule, set for type AUTOSCALING.
"autoscalingConfigUrl": "A String", # [Output Only] The URL of the corresponding Autoscaling configuration.
},
"firewallModuleStatus": { # [Output Only] The status of the FirewallModule, set for type FIREWALL.
"firewallUrl": "A String", # [Output Only] The URL of the corresponding Firewall resource.
},
"type": "A String", # [Output Only] The type of the module.
"lbModuleStatus": { # [Output Only] The status of the LbModule, set for type LOAD_BALANCING.
"forwardingRuleUrl": "A String", # [Output Only] The URL of the corresponding ForwardingRule in GCE.
"targetPoolUrl": "A String", # [Output Only] The URL of the corresponding TargetPool resource in GCE.
},
},
},
"state": { # [Output Only] The current state of a replica or module. # [Output Only] Current status of this deployment.
"status": "A String", # [Output Only] The status of the deployment. Possible values include:
# - UNKNOWN
# - DEPLOYING
# - DEPLOYED
# - DEPLOYMENT_FAILED
# - DELETING
# - DELETED
# - DELETE_FAILED
"details": "A String", # [Output Only] Human readable details about the current state.
},
"creationDate": "A String", # [Output Only] The time when this deployment was created.
"name": "A String", # Name of this deployment. The name must conform to the following regular expression: [a-zA-Z0-9-_]{1,64}
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(projectId, region, body)</code>
<pre>
Args:
projectId: string, A parameter (required)
region: string, A parameter (required)
body: object, The request body. (required)
The object takes the form of:
{ # A deployment represents a physical instantiation of a Template.
"description": "A String", # A user-supplied description of this Deployment.
"templateName": "A String", # The name of the Template on which this deployment is based.
"overrides": [ # The set of parameter overrides to apply to the corresponding Template before deploying.
{ # A specification for overriding parameters in a Template that corresponds to the Deployment.
"path": "A String", # A JSON Path expression that specifies which parameter should be overridden.
"value": "A String", # The new value to assign to the overridden parameter.
},
],
"modules": { # [Output Only] List of status for the modules in this deployment.
"a_key": { # [Output Only] Aggregate status for a module. # Name of the module.
"healthCheckModuleStatus": { # [Output Only] The status of the HealthCheckModule, set for type HEALTH_CHECK.
"healthCheckUrl": "A String", # [Output Only] The HealthCheck URL.
},
"replicaPoolModuleStatus": { # [Output Only] The status of the ReplicaPoolModule, set for type VM.
"resourceViewUrl": "A String", # [Output Only] The URL of the Resource Group associated with this ReplicaPool.
"replicaPoolUrl": "A String", # [Output Only] The URL of the associated ReplicaPool resource.
},
"networkModuleStatus": { # [Output Only] The status of the NetworkModule, set for type NETWORK.
"networkUrl": "A String", # [Output Only] The URL of the corresponding Network resource.
},
"state": { # [Output Only] The current state of a replica or module. # [Output Only] The current state of the module.
"status": "A String", # [Output Only] The status of the deployment. Possible values include:
# - UNKNOWN
# - DEPLOYING
# - DEPLOYED
# - DEPLOYMENT_FAILED
# - DELETING
# - DELETED
# - DELETE_FAILED
"details": "A String", # [Output Only] Human readable details about the current state.
},
"autoscalingModuleStatus": { # [Output Only] The status of the AutoscalingModule, set for type AUTOSCALING.
"autoscalingConfigUrl": "A String", # [Output Only] The URL of the corresponding Autoscaling configuration.
},
"firewallModuleStatus": { # [Output Only] The status of the FirewallModule, set for type FIREWALL.
"firewallUrl": "A String", # [Output Only] The URL of the corresponding Firewall resource.
},
"type": "A String", # [Output Only] The type of the module.
"lbModuleStatus": { # [Output Only] The status of the LbModule, set for type LOAD_BALANCING.
"forwardingRuleUrl": "A String", # [Output Only] The URL of the corresponding ForwardingRule in GCE.
"targetPoolUrl": "A String", # [Output Only] The URL of the corresponding TargetPool resource in GCE.
},
},
},
"state": { # [Output Only] The current state of a replica or module. # [Output Only] Current status of this deployment.
"status": "A String", # [Output Only] The status of the deployment. Possible values include:
# - UNKNOWN
# - DEPLOYING
# - DEPLOYED
# - DEPLOYMENT_FAILED
# - DELETING
# - DELETED
# - DELETE_FAILED
"details": "A String", # [Output Only] Human readable details about the current state.
},
"creationDate": "A String", # [Output Only] The time when this deployment was created.
"name": "A String", # Name of this deployment. The name must conform to the following regular expression: [a-zA-Z0-9-_]{1,64}
}
Returns:
An object of the form:
{ # A deployment represents a physical instantiation of a Template.
"description": "A String", # A user-supplied description of this Deployment.
"templateName": "A String", # The name of the Template on which this deployment is based.
"overrides": [ # The set of parameter overrides to apply to the corresponding Template before deploying.
{ # A specification for overriding parameters in a Template that corresponds to the Deployment.
"path": "A String", # A JSON Path expression that specifies which parameter should be overridden.
"value": "A String", # The new value to assign to the overridden parameter.
},
],
"modules": { # [Output Only] List of status for the modules in this deployment.
"a_key": { # [Output Only] Aggregate status for a module. # Name of the module.
"healthCheckModuleStatus": { # [Output Only] The status of the HealthCheckModule, set for type HEALTH_CHECK.
"healthCheckUrl": "A String", # [Output Only] The HealthCheck URL.
},
"replicaPoolModuleStatus": { # [Output Only] The status of the ReplicaPoolModule, set for type VM.
"resourceViewUrl": "A String", # [Output Only] The URL of the Resource Group associated with this ReplicaPool.
"replicaPoolUrl": "A String", # [Output Only] The URL of the associated ReplicaPool resource.
},
"networkModuleStatus": { # [Output Only] The status of the NetworkModule, set for type NETWORK.
"networkUrl": "A String", # [Output Only] The URL of the corresponding Network resource.
},
"state": { # [Output Only] The current state of a replica or module. # [Output Only] The current state of the module.
"status": "A String", # [Output Only] The status of the deployment. Possible values include:
# - UNKNOWN
# - DEPLOYING
# - DEPLOYED
# - DEPLOYMENT_FAILED
# - DELETING
# - DELETED
# - DELETE_FAILED
"details": "A String", # [Output Only] Human readable details about the current state.
},
"autoscalingModuleStatus": { # [Output Only] The status of the AutoscalingModule, set for type AUTOSCALING.
"autoscalingConfigUrl": "A String", # [Output Only] The URL of the corresponding Autoscaling configuration.
},
"firewallModuleStatus": { # [Output Only] The status of the FirewallModule, set for type FIREWALL.
"firewallUrl": "A String", # [Output Only] The URL of the corresponding Firewall resource.
},
"type": "A String", # [Output Only] The type of the module.
"lbModuleStatus": { # [Output Only] The status of the LbModule, set for type LOAD_BALANCING.
"forwardingRuleUrl": "A String", # [Output Only] The URL of the corresponding ForwardingRule in GCE.
"targetPoolUrl": "A String", # [Output Only] The URL of the corresponding TargetPool resource in GCE.
},
},
},
"state": { # [Output Only] The current state of a replica or module. # [Output Only] Current status of this deployment.
"status": "A String", # [Output Only] The status of the deployment. Possible values include:
# - UNKNOWN
# - DEPLOYING
# - DEPLOYED
# - DEPLOYMENT_FAILED
# - DELETING
# - DELETED
# - DELETE_FAILED
"details": "A String", # [Output Only] Human readable details about the current state.
},
"creationDate": "A String", # [Output Only] The time when this deployment was created.
"name": "A String", # Name of this deployment. The name must conform to the following regular expression: [a-zA-Z0-9-_]{1,64}
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(projectId, region, pageToken=None, maxResults=None)</code>
<pre>
Args:
projectId: string, A parameter (required)
region: 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 deployment represents a physical instantiation of a Template.
"description": "A String", # A user-supplied description of this Deployment.
"templateName": "A String", # The name of the Template on which this deployment is based.
"overrides": [ # The set of parameter overrides to apply to the corresponding Template before deploying.
{ # A specification for overriding parameters in a Template that corresponds to the Deployment.
"path": "A String", # A JSON Path expression that specifies which parameter should be overridden.
"value": "A String", # The new value to assign to the overridden parameter.
},
],
"modules": { # [Output Only] List of status for the modules in this deployment.
"a_key": { # [Output Only] Aggregate status for a module. # Name of the module.
"healthCheckModuleStatus": { # [Output Only] The status of the HealthCheckModule, set for type HEALTH_CHECK.
"healthCheckUrl": "A String", # [Output Only] The HealthCheck URL.
},
"replicaPoolModuleStatus": { # [Output Only] The status of the ReplicaPoolModule, set for type VM.
"resourceViewUrl": "A String", # [Output Only] The URL of the Resource Group associated with this ReplicaPool.
"replicaPoolUrl": "A String", # [Output Only] The URL of the associated ReplicaPool resource.
},
"networkModuleStatus": { # [Output Only] The status of the NetworkModule, set for type NETWORK.
"networkUrl": "A String", # [Output Only] The URL of the corresponding Network resource.
},
"state": { # [Output Only] The current state of a replica or module. # [Output Only] The current state of the module.
"status": "A String", # [Output Only] The status of the deployment. Possible values include:
# - UNKNOWN
# - DEPLOYING
# - DEPLOYED
# - DEPLOYMENT_FAILED
# - DELETING
# - DELETED
# - DELETE_FAILED
"details": "A String", # [Output Only] Human readable details about the current state.
},
"autoscalingModuleStatus": { # [Output Only] The status of the AutoscalingModule, set for type AUTOSCALING.
"autoscalingConfigUrl": "A String", # [Output Only] The URL of the corresponding Autoscaling configuration.
},
"firewallModuleStatus": { # [Output Only] The status of the FirewallModule, set for type FIREWALL.
"firewallUrl": "A String", # [Output Only] The URL of the corresponding Firewall resource.
},
"type": "A String", # [Output Only] The type of the module.
"lbModuleStatus": { # [Output Only] The status of the LbModule, set for type LOAD_BALANCING.
"forwardingRuleUrl": "A String", # [Output Only] The URL of the corresponding ForwardingRule in GCE.
"targetPoolUrl": "A String", # [Output Only] The URL of the corresponding TargetPool resource in GCE.
},
},
},
"state": { # [Output Only] The current state of a replica or module. # [Output Only] Current status of this deployment.
"status": "A String", # [Output Only] The status of the deployment. Possible values include:
# - UNKNOWN
# - DEPLOYING
# - DEPLOYED
# - DEPLOYMENT_FAILED
# - DELETING
# - DELETED
# - DELETE_FAILED
"details": "A String", # [Output Only] Human readable details about the current state.
},
"creationDate": "A String", # [Output Only] The time when this deployment was created.
"name": "A String", # Name of this deployment. The name must conform to the following regular 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>
|
