Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 703c92ca475a5fd3e8cc2c5b3961be0251b5480c / . / docs / dyn / deploymentmanager_v2.deployments.html
blob: b2a884ed2b4721a5adc5bfb252d7f2d207d1ce42 [file] [log] [blame]
Takashi Matsuo06694102015-09-11 13:55:40 -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="deploymentmanager_v2.html">Google Cloud Deployment Manager API</a> . <a href="deploymentmanager_v2.deployments.html">deployments</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#cancelPreview">cancelPreview(project, deployment, body)</a></code></p>
79<p class="firstline">Cancels and removes the preview currently associated with the deployment.</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(project, deployment)</a></code></p>
82<p class="firstline">Deletes a deployment and all of the resources in the deployment.</p>
83<p class="toc_element">
84 <code><a href="#get">get(project, deployment)</a></code></p>
85<p class="firstline">Gets information about a specific deployment.</p>
86<p class="toc_element">
87 <code><a href="#insert">insert(project, body, preview=None)</a></code></p>
88<p class="firstline">Creates a deployment and all of the resources described by the deployment manifest.</p>
89<p class="toc_element">
90 <code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
91<p class="firstline">Lists all deployments for a given project.</p>
92<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<p class="toc_element">
96 <code><a href="#patch">patch(project, deployment, body, deletePolicy=None, createPolicy=None, preview=None)</a></code></p>
97<p class="firstline">Updates a deployment and all of the resources described by the deployment manifest. This method supports patch semantics.</p>
98<p class="toc_element">
99 <code><a href="#stop">stop(project, deployment, body)</a></code></p>
100<p class="firstline">Stops an ongoing operation. This does not roll back any work that has already been completed, but prevents any new work from being started.</p>
101<p class="toc_element">
102 <code><a href="#update">update(project, deployment, body, deletePolicy=None, createPolicy=None, preview=None)</a></code></p>
103<p class="firstline">Updates a deployment and all of the resources described by the deployment manifest.</p>
104<h3>Method Details</h3>
105<div class="method">
106 <code class="details" id="cancelPreview">cancelPreview(project, deployment, body)</code>
107 <pre>Cancels and removes the preview currently associated with the deployment.
108
109Args:
110 project: string, The project ID for this request. (required)
111 deployment: string, The name of the deployment for this request. (required)
112 body: object, The request body. (required)
113 The object takes the form of:
114
115{
116 "fingerprint": "A String", # Specifies a fingerprint for cancelPreview() requests. A fingerprint is a randomly generated value that must be provided in cancelPreview() requests to perform optimistic locking. This ensures optimistic concurrency so that the deployment does not have conflicting requests (e.g. if someone attempts to make a new update request while another user attempts to cancel a preview, this would prevent one of the requests).
117 #
118 # The fingerprint is initially generated by Deployment Manager and changes after every request to modify a deployment. To get the latest fingerprint value, perform a get() request to a deployment.
119 }
120
121
122Returns:
123 An object of the form:
124
125 { # An Operation resource, used to manage asynchronous API requests.
126 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
127 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
128 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
129 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
130 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
131 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
132 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
133 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should monotonically increase as the operation progresses.
134 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
135 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
136 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
137 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
138 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
139 {
140 "message": "A String", # [Output Only] Optional human-readable details for this warning.
141 "code": "A String", # [Output Only] The warning type identifier for this warning.
142 "data": [ # [Output Only] Metadata for this warning in key: value format.
143 {
144 "value": "A String", # [Output Only] A warning data value corresponding to the key.
145 "key": "A String", # [Output Only] A key for the warning data.
146 },
147 ],
148 },
149 ],
150 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
151 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
152 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
153 "name": "A String", # [Output Only] Name of the resource.
154 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
155 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
156 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
157 {
158 "message": "A String", # [Output Only] An optional, human-readable error message.
159 "code": "A String", # [Output Only] The error type identifier for this error.
160 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
161 },
162 ],
163 },
164 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
165 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
166 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
167 }</pre>
168</div>
169
170<div class="method">
171 <code class="details" id="delete">delete(project, deployment)</code>
172 <pre>Deletes a deployment and all of the resources in the deployment.
173
174Args:
175 project: string, The project ID for this request. (required)
176 deployment: string, The name of the deployment for this request. (required)
177
178Returns:
179 An object of the form:
180
181 { # An Operation resource, used to manage asynchronous API requests.
182 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
183 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
184 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
185 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
186 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
187 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
188 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
189 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should monotonically increase as the operation progresses.
190 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
191 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
192 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
193 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
194 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
195 {
196 "message": "A String", # [Output Only] Optional human-readable details for this warning.
197 "code": "A String", # [Output Only] The warning type identifier for this warning.
198 "data": [ # [Output Only] Metadata for this warning in key: value format.
199 {
200 "value": "A String", # [Output Only] A warning data value corresponding to the key.
201 "key": "A String", # [Output Only] A key for the warning data.
202 },
203 ],
204 },
205 ],
206 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
207 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
208 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
209 "name": "A String", # [Output Only] Name of the resource.
210 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
211 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
212 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
213 {
214 "message": "A String", # [Output Only] An optional, human-readable error message.
215 "code": "A String", # [Output Only] The error type identifier for this error.
216 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
217 },
218 ],
219 },
220 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
221 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
222 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
223 }</pre>
224</div>
225
226<div class="method">
227 <code class="details" id="get">get(project, deployment)</code>
228 <pre>Gets information about a specific deployment.
229
230Args:
231 project: string, The project ID for this request. (required)
232 deployment: string, The name of the deployment for this request. (required)
233
234Returns:
235 An object of the form:
236
237 {
238 "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
239 "update": { # [Output Only] If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here.
240 "manifest": "A String", # [Output Only] URL of the manifest representing the update configuration of this deployment.
241 },
242 "manifest": "A String", # [Output Only] URL of the manifest representing the last manifest that was successfully deployed.
243 "insertTime": "A String", # [Output Only] Timestamp when the deployment was created, in RFC3339 text format .
244 "fingerprint": "A String", # Provides a fingerprint to use in requests to modify a deployment, such as update(), stop(), and cancelPreview() requests. A fingerprint is a randomly generated value that must be provided with update(), stop(), and cancelPreview() requests to perform optimistic locking. This ensures optimistic concurrency so that only one request happens at a time.
245 #
246 # The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a get() request to a deployment.
247 "operation": { # An Operation resource, used to manage asynchronous API requests. # [Output Only] The Operation that most recently ran, or is currently running, on this deployment.
248 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
249 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
250 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
251 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
252 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
253 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
254 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
255 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should monotonically increase as the operation progresses.
256 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
257 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
258 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
259 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
260 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
261 {
262 "message": "A String", # [Output Only] Optional human-readable details for this warning.
263 "code": "A String", # [Output Only] The warning type identifier for this warning.
264 "data": [ # [Output Only] Metadata for this warning in key: value format.
265 {
266 "value": "A String", # [Output Only] A warning data value corresponding to the key.
267 "key": "A String", # [Output Only] A key for the warning data.
268 },
269 ],
270 },
271 ],
272 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
273 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
274 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
275 "name": "A String", # [Output Only] Name of the resource.
276 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
277 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
278 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
279 {
280 "message": "A String", # [Output Only] An optional, human-readable error message.
281 "code": "A String", # [Output Only] The error type identifier for this error.
282 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
283 },
284 ],
285 },
286 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
287 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
288 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
289 },
290 "target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.
291 "imports": [ # Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template.
292 {
293 "content": "A String", # The contents of the file.
294 "name": "A String", # The name of the file.
295 },
296 ],
297 "config": { # The configuration to use for this deployment.
298 "content": "A String", # The contents of the file.
299 },
300 },
301 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
302 "description": "A String", # An optional user-provided description of the deployment.
303 }</pre>
304</div>
305
306<div class="method">
307 <code class="details" id="insert">insert(project, body, preview=None)</code>
308 <pre>Creates a deployment and all of the resources described by the deployment manifest.
309
310Args:
311 project: string, The project ID for this request. (required)
312 body: object, The request body. (required)
313 The object takes the form of:
314
315{
316 "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
317 "update": { # [Output Only] If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here.
318 "manifest": "A String", # [Output Only] URL of the manifest representing the update configuration of this deployment.
319 },
320 "manifest": "A String", # [Output Only] URL of the manifest representing the last manifest that was successfully deployed.
321 "insertTime": "A String", # [Output Only] Timestamp when the deployment was created, in RFC3339 text format .
322 "fingerprint": "A String", # Provides a fingerprint to use in requests to modify a deployment, such as update(), stop(), and cancelPreview() requests. A fingerprint is a randomly generated value that must be provided with update(), stop(), and cancelPreview() requests to perform optimistic locking. This ensures optimistic concurrency so that only one request happens at a time.
323 #
324 # The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a get() request to a deployment.
325 "operation": { # An Operation resource, used to manage asynchronous API requests. # [Output Only] The Operation that most recently ran, or is currently running, on this deployment.
326 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
327 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
328 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
329 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
330 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
331 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
332 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
333 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should monotonically increase as the operation progresses.
334 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
335 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
336 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
337 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
338 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
339 {
340 "message": "A String", # [Output Only] Optional human-readable details for this warning.
341 "code": "A String", # [Output Only] The warning type identifier for this warning.
342 "data": [ # [Output Only] Metadata for this warning in key: value format.
343 {
344 "value": "A String", # [Output Only] A warning data value corresponding to the key.
345 "key": "A String", # [Output Only] A key for the warning data.
346 },
347 ],
348 },
349 ],
350 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
351 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
352 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
353 "name": "A String", # [Output Only] Name of the resource.
354 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
355 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
356 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
357 {
358 "message": "A String", # [Output Only] An optional, human-readable error message.
359 "code": "A String", # [Output Only] The error type identifier for this error.
360 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
361 },
362 ],
363 },
364 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
365 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
366 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
367 },
368 "target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.
369 "imports": [ # Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template.
370 {
371 "content": "A String", # The contents of the file.
372 "name": "A String", # The name of the file.
373 },
374 ],
375 "config": { # The configuration to use for this deployment.
376 "content": "A String", # The contents of the file.
377 },
378 },
379 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
380 "description": "A String", # An optional user-provided description of the deployment.
381 }
382
383 preview: boolean, If set to true, creates a deployment and creates "shell" resources but does not actually instantiate these resources. This allows you to preview what your deployment looks like. After previewing a deployment, you can deploy your resources by making a request with the update() method or you can use the cancelPreview() method to cancel the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.
384
385Returns:
386 An object of the form:
387
388 { # An Operation resource, used to manage asynchronous API requests.
389 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
390 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
391 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
392 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
393 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
394 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
395 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
396 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should monotonically increase as the operation progresses.
397 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
398 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
399 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
400 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
401 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
402 {
403 "message": "A String", # [Output Only] Optional human-readable details for this warning.
404 "code": "A String", # [Output Only] The warning type identifier for this warning.
405 "data": [ # [Output Only] Metadata for this warning in key: value format.
406 {
407 "value": "A String", # [Output Only] A warning data value corresponding to the key.
408 "key": "A String", # [Output Only] A key for the warning data.
409 },
410 ],
411 },
412 ],
413 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
414 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
415 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
416 "name": "A String", # [Output Only] Name of the resource.
417 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
418 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
419 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
420 {
421 "message": "A String", # [Output Only] An optional, human-readable error message.
422 "code": "A String", # [Output Only] The error type identifier for this error.
423 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
424 },
425 ],
426 },
427 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
428 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
429 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
430 }</pre>
431</div>
432
433<div class="method">
434 <code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
435 <pre>Lists all deployments for a given project.
436
437Args:
438 project: string, The project ID for this request. (required)
439 maxResults: integer, Maximum count of results to be returned.
440 pageToken: string, Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.
441 filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.
442
443The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
444
445For example, filter=name ne example-instance.
446
447Returns:
448 An object of the form:
449
450 { # A response containing a partial list of deployments and a page token used to build the next request if the request has been truncated.
451 "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
452 "deployments": [ # [Output Only] The deployments contained in this response.
453 {
454 "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
455 "update": { # [Output Only] If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here.
456 "manifest": "A String", # [Output Only] URL of the manifest representing the update configuration of this deployment.
457 },
458 "manifest": "A String", # [Output Only] URL of the manifest representing the last manifest that was successfully deployed.
459 "insertTime": "A String", # [Output Only] Timestamp when the deployment was created, in RFC3339 text format .
460 "fingerprint": "A String", # Provides a fingerprint to use in requests to modify a deployment, such as update(), stop(), and cancelPreview() requests. A fingerprint is a randomly generated value that must be provided with update(), stop(), and cancelPreview() requests to perform optimistic locking. This ensures optimistic concurrency so that only one request happens at a time.
461 #
462 # The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a get() request to a deployment.
463 "operation": { # An Operation resource, used to manage asynchronous API requests. # [Output Only] The Operation that most recently ran, or is currently running, on this deployment.
464 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
465 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
466 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
467 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
468 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
469 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
470 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
471 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should monotonically increase as the operation progresses.
472 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
473 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
474 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
475 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
476 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
477 {
478 "message": "A String", # [Output Only] Optional human-readable details for this warning.
479 "code": "A String", # [Output Only] The warning type identifier for this warning.
480 "data": [ # [Output Only] Metadata for this warning in key: value format.
481 {
482 "value": "A String", # [Output Only] A warning data value corresponding to the key.
483 "key": "A String", # [Output Only] A key for the warning data.
484 },
485 ],
486 },
487 ],
488 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
489 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
490 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
491 "name": "A String", # [Output Only] Name of the resource.
492 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
493 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
494 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
495 {
496 "message": "A String", # [Output Only] An optional, human-readable error message.
497 "code": "A String", # [Output Only] The error type identifier for this error.
498 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
499 },
500 ],
501 },
502 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
503 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
504 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
505 },
506 "target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.
507 "imports": [ # Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template.
508 {
509 "content": "A String", # The contents of the file.
510 "name": "A String", # The name of the file.
511 },
512 ],
513 "config": { # The configuration to use for this deployment.
514 "content": "A String", # The contents of the file.
515 },
516 },
517 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
518 "description": "A String", # An optional user-provided description of the deployment.
519 },
520 ],
521 }</pre>
522</div>
523
524<div class="method">
525 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
526 <pre>Retrieves the next page of results.
527
528Args:
529 previous_request: The request for the previous page. (required)
530 previous_response: The response from the request for the previous page. (required)
531
532Returns:
533 A request object that you can call 'execute()' on to request the next
534 page. Returns None if there are no more items in the collection.
535 </pre>
536</div>
537
538<div class="method">
539 <code class="details" id="patch">patch(project, deployment, body, deletePolicy=None, createPolicy=None, preview=None)</code>
540 <pre>Updates a deployment and all of the resources described by the deployment manifest. This method supports patch semantics.
541
542Args:
543 project: string, The project ID for this request. (required)
544 deployment: string, The name of the deployment for this request. (required)
545 body: object, The request body. (required)
546 The object takes the form of:
547
548{
549 "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
550 "update": { # [Output Only] If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here.
551 "manifest": "A String", # [Output Only] URL of the manifest representing the update configuration of this deployment.
552 },
553 "manifest": "A String", # [Output Only] URL of the manifest representing the last manifest that was successfully deployed.
554 "insertTime": "A String", # [Output Only] Timestamp when the deployment was created, in RFC3339 text format .
555 "fingerprint": "A String", # Provides a fingerprint to use in requests to modify a deployment, such as update(), stop(), and cancelPreview() requests. A fingerprint is a randomly generated value that must be provided with update(), stop(), and cancelPreview() requests to perform optimistic locking. This ensures optimistic concurrency so that only one request happens at a time.
556 #
557 # The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a get() request to a deployment.
558 "operation": { # An Operation resource, used to manage asynchronous API requests. # [Output Only] The Operation that most recently ran, or is currently running, on this deployment.
559 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
560 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
561 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
562 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
563 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
564 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
565 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
566 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should monotonically increase as the operation progresses.
567 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
568 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
569 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
570 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
571 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
572 {
573 "message": "A String", # [Output Only] Optional human-readable details for this warning.
574 "code": "A String", # [Output Only] The warning type identifier for this warning.
575 "data": [ # [Output Only] Metadata for this warning in key: value format.
576 {
577 "value": "A String", # [Output Only] A warning data value corresponding to the key.
578 "key": "A String", # [Output Only] A key for the warning data.
579 },
580 ],
581 },
582 ],
583 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
584 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
585 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
586 "name": "A String", # [Output Only] Name of the resource.
587 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
588 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
589 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
590 {
591 "message": "A String", # [Output Only] An optional, human-readable error message.
592 "code": "A String", # [Output Only] The error type identifier for this error.
593 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
594 },
595 ],
596 },
597 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
598 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
599 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
600 },
601 "target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.
602 "imports": [ # Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template.
603 {
604 "content": "A String", # The contents of the file.
605 "name": "A String", # The name of the file.
606 },
607 ],
608 "config": { # The configuration to use for this deployment.
609 "content": "A String", # The contents of the file.
610 },
611 },
612 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
613 "description": "A String", # An optional user-provided description of the deployment.
614 }
615
616 deletePolicy: string, Sets the policy to use for deleting resources.
617 Allowed values
618 ABANDON -
619 DELETE -
620 createPolicy: string, Sets the policy to use for creating new resources.
621 Allowed values
622 ACQUIRE -
623 CREATE_OR_ACQUIRE -
624 preview: boolean, If set to true, updates the deployment and creates and updates the "shell" resources but does not actually alter or instantiate these resources. This allows you to preview what your deployment looks like. You can use this intent to preview how an update would affect your deployment. You must provide a target.config with a configuration if this is set to true. After previewing a deployment, you can deploy your resources by making a request with the update() or you can cancelPreview() to remove the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.
625
626Returns:
627 An object of the form:
628
629 { # An Operation resource, used to manage asynchronous API requests.
630 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
631 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
632 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
633 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
634 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
635 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
636 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
637 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should monotonically increase as the operation progresses.
638 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
639 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
640 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
641 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
642 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
643 {
644 "message": "A String", # [Output Only] Optional human-readable details for this warning.
645 "code": "A String", # [Output Only] The warning type identifier for this warning.
646 "data": [ # [Output Only] Metadata for this warning in key: value format.
647 {
648 "value": "A String", # [Output Only] A warning data value corresponding to the key.
649 "key": "A String", # [Output Only] A key for the warning data.
650 },
651 ],
652 },
653 ],
654 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
655 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
656 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
657 "name": "A String", # [Output Only] Name of the resource.
658 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
659 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
660 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
661 {
662 "message": "A String", # [Output Only] An optional, human-readable error message.
663 "code": "A String", # [Output Only] The error type identifier for this error.
664 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
665 },
666 ],
667 },
668 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
669 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
670 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
671 }</pre>
672</div>
673
674<div class="method">
675 <code class="details" id="stop">stop(project, deployment, body)</code>
676 <pre>Stops an ongoing operation. This does not roll back any work that has already been completed, but prevents any new work from being started.
677
678Args:
679 project: string, The project ID for this request. (required)
680 deployment: string, The name of the deployment for this request. (required)
681 body: object, The request body. (required)
682 The object takes the form of:
683
684{
685 "fingerprint": "A String", # Specifies a fingerprint for stop() requests. A fingerprint is a randomly generated value that must be provided in stop() requests to perform optimistic locking. This ensures optimistic concurrency so that the deployment does not have conflicting requests (e.g. if someone attempts to make a new update request while another user attempts to stop an ongoing update request, this would prevent a collision).
686 #
687 # The fingerprint is initially generated by Deployment Manager and changes after every request to modify a deployment. To get the latest fingerprint value, perform a get() request to a deployment.
688 }
689
690
691Returns:
692 An object of the form:
693
694 { # An Operation resource, used to manage asynchronous API requests.
695 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
696 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
697 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
698 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
699 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
700 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
701 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
702 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should monotonically increase as the operation progresses.
703 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
704 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
705 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
706 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
707 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
708 {
709 "message": "A String", # [Output Only] Optional human-readable details for this warning.
710 "code": "A String", # [Output Only] The warning type identifier for this warning.
711 "data": [ # [Output Only] Metadata for this warning in key: value format.
712 {
713 "value": "A String", # [Output Only] A warning data value corresponding to the key.
714 "key": "A String", # [Output Only] A key for the warning data.
715 },
716 ],
717 },
718 ],
719 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
720 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
721 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
722 "name": "A String", # [Output Only] Name of the resource.
723 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
724 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
725 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
726 {
727 "message": "A String", # [Output Only] An optional, human-readable error message.
728 "code": "A String", # [Output Only] The error type identifier for this error.
729 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
730 },
731 ],
732 },
733 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
734 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
735 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
736 }</pre>
737</div>
738
739<div class="method">
740 <code class="details" id="update">update(project, deployment, body, deletePolicy=None, createPolicy=None, preview=None)</code>
741 <pre>Updates a deployment and all of the resources described by the deployment manifest.
742
743Args:
744 project: string, The project ID for this request. (required)
745 deployment: string, The name of the deployment for this request. (required)
746 body: object, The request body. (required)
747 The object takes the form of:
748
749{
750 "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
751 "update": { # [Output Only] If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here.
752 "manifest": "A String", # [Output Only] URL of the manifest representing the update configuration of this deployment.
753 },
754 "manifest": "A String", # [Output Only] URL of the manifest representing the last manifest that was successfully deployed.
755 "insertTime": "A String", # [Output Only] Timestamp when the deployment was created, in RFC3339 text format .
756 "fingerprint": "A String", # Provides a fingerprint to use in requests to modify a deployment, such as update(), stop(), and cancelPreview() requests. A fingerprint is a randomly generated value that must be provided with update(), stop(), and cancelPreview() requests to perform optimistic locking. This ensures optimistic concurrency so that only one request happens at a time.
757 #
758 # The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a get() request to a deployment.
759 "operation": { # An Operation resource, used to manage asynchronous API requests. # [Output Only] The Operation that most recently ran, or is currently running, on this deployment.
760 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
761 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
762 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
763 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
764 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
765 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
766 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
767 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should monotonically increase as the operation progresses.
768 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
769 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
770 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
771 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
772 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
773 {
774 "message": "A String", # [Output Only] Optional human-readable details for this warning.
775 "code": "A String", # [Output Only] The warning type identifier for this warning.
776 "data": [ # [Output Only] Metadata for this warning in key: value format.
777 {
778 "value": "A String", # [Output Only] A warning data value corresponding to the key.
779 "key": "A String", # [Output Only] A key for the warning data.
780 },
781 ],
782 },
783 ],
784 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
785 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
786 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
787 "name": "A String", # [Output Only] Name of the resource.
788 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
789 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
790 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
791 {
792 "message": "A String", # [Output Only] An optional, human-readable error message.
793 "code": "A String", # [Output Only] The error type identifier for this error.
794 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
795 },
796 ],
797 },
798 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
799 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
800 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
801 },
802 "target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.
803 "imports": [ # Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template.
804 {
805 "content": "A String", # The contents of the file.
806 "name": "A String", # The name of the file.
807 },
808 ],
809 "config": { # The configuration to use for this deployment.
810 "content": "A String", # The contents of the file.
811 },
812 },
813 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
814 "description": "A String", # An optional user-provided description of the deployment.
815 }
816
817 deletePolicy: string, Sets the policy to use for deleting resources.
818 Allowed values
819 ABANDON -
820 DELETE -
821 createPolicy: string, Sets the policy to use for creating new resources.
822 Allowed values
823 ACQUIRE -
824 CREATE_OR_ACQUIRE -
825 preview: boolean, If set to true, updates the deployment and creates and updates the "shell" resources but does not actually alter or instantiate these resources. This allows you to preview what your deployment looks like. You can use this intent to preview how an update would affect your deployment. You must provide a target.config with a configuration if this is set to true. After previewing a deployment, you can deploy your resources by making a request with the update() or you can cancelPreview() to remove the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.
826
827Returns:
828 An object of the form:
829
830 { # An Operation resource, used to manage asynchronous API requests.
831 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
832 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
833 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
834 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
835 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
836 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
837 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
838 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should monotonically increase as the operation progresses.
839 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
840 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
841 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
842 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
843 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
844 {
845 "message": "A String", # [Output Only] Optional human-readable details for this warning.
846 "code": "A String", # [Output Only] The warning type identifier for this warning.
847 "data": [ # [Output Only] Metadata for this warning in key: value format.
848 {
849 "value": "A String", # [Output Only] A warning data value corresponding to the key.
850 "key": "A String", # [Output Only] A key for the warning data.
851 },
852 ],
853 },
854 ],
855 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
856 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
857 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
858 "name": "A String", # [Output Only] Name of the resource.
859 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
860 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
861 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
862 {
863 "message": "A String", # [Output Only] An optional, human-readable error message.
864 "code": "A String", # [Output Only] The error type identifier for this error.
865 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
866 },
867 ],
868 },
869 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
870 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
871 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
872 }</pre>
873</div>
874
875</body></html>