Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 63caac01ea7b9fbd8ae70bcbb4c6ecbec833ad3d / . / docs / dyn / manager_v1beta2.deployments.html
blob: 16299f3bf554845ed8ee0f85a1618675e9c7b5a1 [file] [log] [blame]
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="manager_v1beta2.html">Deployment Manager API</a> . <a href="manager_v1beta2.deployments.html">deployments</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(projectId, region, deploymentName)</a></code></p>
79<p class="firstline"></p>
80<p class="toc_element">
81 <code><a href="#get">get(projectId, region, deploymentName)</a></code></p>
82<p class="firstline"></p>
83<p class="toc_element">
84 <code><a href="#insert">insert(projectId, region, body)</a></code></p>
85<p class="firstline"></p>
86<p class="toc_element">
87 <code><a href="#list">list(projectId, region, pageToken=None, maxResults=None)</a></code></p>
88<p class="firstline"></p>
89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<h3>Method Details</h3>
93<div class="method">
94 <code class="details" id="delete">delete(projectId, region, deploymentName)</code>
95 <pre>
96
97Args:
98 projectId: string, A parameter (required)
99 region: string, A parameter (required)
100 deploymentName: string, A parameter (required)
101</pre>
102</div>
103
104<div class="method">
105 <code class="details" id="get">get(projectId, region, deploymentName)</code>
106 <pre>
107
108Args:
109 projectId: string, A parameter (required)
110 region: string, A parameter (required)
111 deploymentName: string, A parameter (required)
112
113Returns:
114 An object of the form:
115
116 { # A deployment represents a physical instantiation of a Template.
117 "description": "A String", # A user-supplied description of this Deployment.
118 "templateName": "A String", # The name of the Template on which this deployment is based.
119 "overrides": [ # The set of parameter overrides to apply to the corresponding Template before deploying.
120 { # A specification for overriding parameters in a Template that corresponds to the Deployment.
121 "path": "A String", # A JSON Path expression that specifies which parameter should be overridden.
122 "value": "A String", # The new value to assign to the overridden parameter.
123 },
124 ],
125 "modules": { # [Output Only] List of status for the modules in this deployment.
126 "a_key": { # [Output Only] Aggregate status for a module. # Name of the module.
127 "healthCheckModuleStatus": { # [Output Only] The status of the HealthCheckModule, set for type HEALTH_CHECK.
128 "healthCheckUrl": "A String", # [Output Only] The HealthCheck URL.
129 },
130 "replicaPoolModuleStatus": { # [Output Only] The status of the ReplicaPoolModule, set for type VM.
131 "resourceViewUrl": "A String", # [Output Only] The URL of the Resource Group associated with this ReplicaPool.
132 "replicaPoolUrl": "A String", # [Output Only] The URL of the associated ReplicaPool resource.
133 },
134 "networkModuleStatus": { # [Output Only] The status of the NetworkModule, set for type NETWORK.
135 "networkUrl": "A String", # [Output Only] The URL of the corresponding Network resource.
136 },
137 "state": { # [Output Only] The current state of a replica or module. # [Output Only] The current state of the module.
138 "status": "A String", # [Output Only] The status of the deployment. Possible values include:
139 # - UNKNOWN
140 # - DEPLOYING
141 # - DEPLOYED
142 # - DEPLOYMENT_FAILED
143 # - DELETING
144 # - DELETED
145 # - DELETE_FAILED
146 "details": "A String", # [Output Only] Human readable details about the current state.
147 },
148 "autoscalingModuleStatus": { # [Output Only] The status of the AutoscalingModule, set for type AUTOSCALING.
149 "autoscalingConfigUrl": "A String", # [Output Only] The URL of the corresponding Autoscaling configuration.
150 },
151 "firewallModuleStatus": { # [Output Only] The status of the FirewallModule, set for type FIREWALL.
152 "firewallUrl": "A String", # [Output Only] The URL of the corresponding Firewall resource.
153 },
154 "type": "A String", # [Output Only] The type of the module.
155 "lbModuleStatus": { # [Output Only] The status of the LbModule, set for type LOAD_BALANCING.
156 "forwardingRuleUrl": "A String", # [Output Only] The URL of the corresponding ForwardingRule in GCE.
157 "targetPoolUrl": "A String", # [Output Only] The URL of the corresponding TargetPool resource in GCE.
158 },
159 },
160 },
161 "state": { # [Output Only] The current state of a replica or module. # [Output Only] Current status of this deployment.
162 "status": "A String", # [Output Only] The status of the deployment. Possible values include:
163 # - UNKNOWN
164 # - DEPLOYING
165 # - DEPLOYED
166 # - DEPLOYMENT_FAILED
167 # - DELETING
168 # - DELETED
169 # - DELETE_FAILED
170 "details": "A String", # [Output Only] Human readable details about the current state.
171 },
172 "creationDate": "A String", # [Output Only] The time when this deployment was created.
173 "name": "A String", # Name of this deployment. The name must conform to the following regular expression: [a-zA-Z0-9-_]{1,64}
174 }</pre>
175</div>
176
177<div class="method">
178 <code class="details" id="insert">insert(projectId, region, body)</code>
179 <pre>
180
181Args:
182 projectId: string, A parameter (required)
183 region: string, A parameter (required)
184 body: object, The request body. (required)
185 The object takes the form of:
186
187{ # A deployment represents a physical instantiation of a Template.
188 "description": "A String", # A user-supplied description of this Deployment.
189 "templateName": "A String", # The name of the Template on which this deployment is based.
190 "overrides": [ # The set of parameter overrides to apply to the corresponding Template before deploying.
191 { # A specification for overriding parameters in a Template that corresponds to the Deployment.
192 "path": "A String", # A JSON Path expression that specifies which parameter should be overridden.
193 "value": "A String", # The new value to assign to the overridden parameter.
194 },
195 ],
196 "modules": { # [Output Only] List of status for the modules in this deployment.
197 "a_key": { # [Output Only] Aggregate status for a module. # Name of the module.
198 "healthCheckModuleStatus": { # [Output Only] The status of the HealthCheckModule, set for type HEALTH_CHECK.
199 "healthCheckUrl": "A String", # [Output Only] The HealthCheck URL.
200 },
201 "replicaPoolModuleStatus": { # [Output Only] The status of the ReplicaPoolModule, set for type VM.
202 "resourceViewUrl": "A String", # [Output Only] The URL of the Resource Group associated with this ReplicaPool.
203 "replicaPoolUrl": "A String", # [Output Only] The URL of the associated ReplicaPool resource.
204 },
205 "networkModuleStatus": { # [Output Only] The status of the NetworkModule, set for type NETWORK.
206 "networkUrl": "A String", # [Output Only] The URL of the corresponding Network resource.
207 },
208 "state": { # [Output Only] The current state of a replica or module. # [Output Only] The current state of the module.
209 "status": "A String", # [Output Only] The status of the deployment. Possible values include:
210 # - UNKNOWN
211 # - DEPLOYING
212 # - DEPLOYED
213 # - DEPLOYMENT_FAILED
214 # - DELETING
215 # - DELETED
216 # - DELETE_FAILED
217 "details": "A String", # [Output Only] Human readable details about the current state.
218 },
219 "autoscalingModuleStatus": { # [Output Only] The status of the AutoscalingModule, set for type AUTOSCALING.
220 "autoscalingConfigUrl": "A String", # [Output Only] The URL of the corresponding Autoscaling configuration.
221 },
222 "firewallModuleStatus": { # [Output Only] The status of the FirewallModule, set for type FIREWALL.
223 "firewallUrl": "A String", # [Output Only] The URL of the corresponding Firewall resource.
224 },
225 "type": "A String", # [Output Only] The type of the module.
226 "lbModuleStatus": { # [Output Only] The status of the LbModule, set for type LOAD_BALANCING.
227 "forwardingRuleUrl": "A String", # [Output Only] The URL of the corresponding ForwardingRule in GCE.
228 "targetPoolUrl": "A String", # [Output Only] The URL of the corresponding TargetPool resource in GCE.
229 },
230 },
231 },
232 "state": { # [Output Only] The current state of a replica or module. # [Output Only] Current status of this deployment.
233 "status": "A String", # [Output Only] The status of the deployment. Possible values include:
234 # - UNKNOWN
235 # - DEPLOYING
236 # - DEPLOYED
237 # - DEPLOYMENT_FAILED
238 # - DELETING
239 # - DELETED
240 # - DELETE_FAILED
241 "details": "A String", # [Output Only] Human readable details about the current state.
242 },
243 "creationDate": "A String", # [Output Only] The time when this deployment was created.
244 "name": "A String", # Name of this deployment. The name must conform to the following regular expression: [a-zA-Z0-9-_]{1,64}
245 }
246
247
248Returns:
249 An object of the form:
250
251 { # A deployment represents a physical instantiation of a Template.
252 "description": "A String", # A user-supplied description of this Deployment.
253 "templateName": "A String", # The name of the Template on which this deployment is based.
254 "overrides": [ # The set of parameter overrides to apply to the corresponding Template before deploying.
255 { # A specification for overriding parameters in a Template that corresponds to the Deployment.
256 "path": "A String", # A JSON Path expression that specifies which parameter should be overridden.
257 "value": "A String", # The new value to assign to the overridden parameter.
258 },
259 ],
260 "modules": { # [Output Only] List of status for the modules in this deployment.
261 "a_key": { # [Output Only] Aggregate status for a module. # Name of the module.
262 "healthCheckModuleStatus": { # [Output Only] The status of the HealthCheckModule, set for type HEALTH_CHECK.
263 "healthCheckUrl": "A String", # [Output Only] The HealthCheck URL.
264 },
265 "replicaPoolModuleStatus": { # [Output Only] The status of the ReplicaPoolModule, set for type VM.
266 "resourceViewUrl": "A String", # [Output Only] The URL of the Resource Group associated with this ReplicaPool.
267 "replicaPoolUrl": "A String", # [Output Only] The URL of the associated ReplicaPool resource.
268 },
269 "networkModuleStatus": { # [Output Only] The status of the NetworkModule, set for type NETWORK.
270 "networkUrl": "A String", # [Output Only] The URL of the corresponding Network resource.
271 },
272 "state": { # [Output Only] The current state of a replica or module. # [Output Only] The current state of the module.
273 "status": "A String", # [Output Only] The status of the deployment. Possible values include:
274 # - UNKNOWN
275 # - DEPLOYING
276 # - DEPLOYED
277 # - DEPLOYMENT_FAILED
278 # - DELETING
279 # - DELETED
280 # - DELETE_FAILED
281 "details": "A String", # [Output Only] Human readable details about the current state.
282 },
283 "autoscalingModuleStatus": { # [Output Only] The status of the AutoscalingModule, set for type AUTOSCALING.
284 "autoscalingConfigUrl": "A String", # [Output Only] The URL of the corresponding Autoscaling configuration.
285 },
286 "firewallModuleStatus": { # [Output Only] The status of the FirewallModule, set for type FIREWALL.
287 "firewallUrl": "A String", # [Output Only] The URL of the corresponding Firewall resource.
288 },
289 "type": "A String", # [Output Only] The type of the module.
290 "lbModuleStatus": { # [Output Only] The status of the LbModule, set for type LOAD_BALANCING.
291 "forwardingRuleUrl": "A String", # [Output Only] The URL of the corresponding ForwardingRule in GCE.
292 "targetPoolUrl": "A String", # [Output Only] The URL of the corresponding TargetPool resource in GCE.
293 },
294 },
295 },
296 "state": { # [Output Only] The current state of a replica or module. # [Output Only] Current status of this deployment.
297 "status": "A String", # [Output Only] The status of the deployment. Possible values include:
298 # - UNKNOWN
299 # - DEPLOYING
300 # - DEPLOYED
301 # - DEPLOYMENT_FAILED
302 # - DELETING
303 # - DELETED
304 # - DELETE_FAILED
305 "details": "A String", # [Output Only] Human readable details about the current state.
306 },
307 "creationDate": "A String", # [Output Only] The time when this deployment was created.
308 "name": "A String", # Name of this deployment. The name must conform to the following regular expression: [a-zA-Z0-9-_]{1,64}
309 }</pre>
310</div>
311
312<div class="method">
313 <code class="details" id="list">list(projectId, region, pageToken=None, maxResults=None)</code>
314 <pre>
315
316Args:
317 projectId: string, A parameter (required)
318 region: string, A parameter (required)
319 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.
320 maxResults: integer, Maximum count of results to be returned. Acceptable values are 0 to 100, inclusive. (Default: 50)
321
322Returns:
323 An object of the form:
324
325 {
326 "nextPageToken": "A String",
327 "resources": [
328 { # A deployment represents a physical instantiation of a Template.
329 "description": "A String", # A user-supplied description of this Deployment.
330 "templateName": "A String", # The name of the Template on which this deployment is based.
331 "overrides": [ # The set of parameter overrides to apply to the corresponding Template before deploying.
332 { # A specification for overriding parameters in a Template that corresponds to the Deployment.
333 "path": "A String", # A JSON Path expression that specifies which parameter should be overridden.
334 "value": "A String", # The new value to assign to the overridden parameter.
335 },
336 ],
337 "modules": { # [Output Only] List of status for the modules in this deployment.
338 "a_key": { # [Output Only] Aggregate status for a module. # Name of the module.
339 "healthCheckModuleStatus": { # [Output Only] The status of the HealthCheckModule, set for type HEALTH_CHECK.
340 "healthCheckUrl": "A String", # [Output Only] The HealthCheck URL.
341 },
342 "replicaPoolModuleStatus": { # [Output Only] The status of the ReplicaPoolModule, set for type VM.
343 "resourceViewUrl": "A String", # [Output Only] The URL of the Resource Group associated with this ReplicaPool.
344 "replicaPoolUrl": "A String", # [Output Only] The URL of the associated ReplicaPool resource.
345 },
346 "networkModuleStatus": { # [Output Only] The status of the NetworkModule, set for type NETWORK.
347 "networkUrl": "A String", # [Output Only] The URL of the corresponding Network resource.
348 },
349 "state": { # [Output Only] The current state of a replica or module. # [Output Only] The current state of the module.
350 "status": "A String", # [Output Only] The status of the deployment. Possible values include:
351 # - UNKNOWN
352 # - DEPLOYING
353 # - DEPLOYED
354 # - DEPLOYMENT_FAILED
355 # - DELETING
356 # - DELETED
357 # - DELETE_FAILED
358 "details": "A String", # [Output Only] Human readable details about the current state.
359 },
360 "autoscalingModuleStatus": { # [Output Only] The status of the AutoscalingModule, set for type AUTOSCALING.
361 "autoscalingConfigUrl": "A String", # [Output Only] The URL of the corresponding Autoscaling configuration.
362 },
363 "firewallModuleStatus": { # [Output Only] The status of the FirewallModule, set for type FIREWALL.
364 "firewallUrl": "A String", # [Output Only] The URL of the corresponding Firewall resource.
365 },
366 "type": "A String", # [Output Only] The type of the module.
367 "lbModuleStatus": { # [Output Only] The status of the LbModule, set for type LOAD_BALANCING.
368 "forwardingRuleUrl": "A String", # [Output Only] The URL of the corresponding ForwardingRule in GCE.
369 "targetPoolUrl": "A String", # [Output Only] The URL of the corresponding TargetPool resource in GCE.
370 },
371 },
372 },
373 "state": { # [Output Only] The current state of a replica or module. # [Output Only] Current status of this deployment.
374 "status": "A String", # [Output Only] The status of the deployment. Possible values include:
375 # - UNKNOWN
376 # - DEPLOYING
377 # - DEPLOYED
378 # - DEPLOYMENT_FAILED
379 # - DELETING
380 # - DELETED
381 # - DELETE_FAILED
382 "details": "A String", # [Output Only] Human readable details about the current state.
383 },
384 "creationDate": "A String", # [Output Only] The time when this deployment was created.
385 "name": "A String", # Name of this deployment. The name must conform to the following regular expression: [a-zA-Z0-9-_]{1,64}
386 },
387 ],
388 }</pre>
389</div>
390
391<div class="method">
392 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
393 <pre>Retrieves the next page of results.
394
395Args:
396 previous_request: The request for the previous page. (required)
397 previous_response: The response from the request for the previous page. (required)
398
399Returns:
400 A request object that you can call 'execute()' on to request the next
401 page. Returns None if there are no more items in the collection.
402 </pre>
403</div>
404
405</body></html>