blob: 4f03ec88286d2211bc779ee6986d98db2ab6b8c8 [file] [log] [blame]
Takashi Matsuo06694102015-09-11 13:55:40 -07001<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 #
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800118 # 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 on the deployment.
Takashi Matsuo06694102015-09-11 13:55:40 -0700119 }
120
121
122Returns:
123 An object of the form:
124
125 { # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800126 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
127 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Takashi Matsuo06694102015-09-11 13:55:40 -0700128 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800129 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
130 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
131 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
132 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Takashi Matsuo06694102015-09-11 13:55:40 -0700133 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800134 "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 when the operation will be complete. This number should monotonically increase as the operation progresses.
135 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
Takashi Matsuo06694102015-09-11 13:55:40 -0700136 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800137 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
138 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Takashi Matsuo06694102015-09-11 13:55:40 -0700139 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
140 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800141 "message": "A String", # [Output Only] A human-readable description of the warning code.
142 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
143 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
144 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Takashi Matsuo06694102015-09-11 13:55:40 -0700145 {
146 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800147 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
Takashi Matsuo06694102015-09-11 13:55:40 -0700148 },
149 ],
150 },
151 ],
152 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800153 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
154 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Takashi Matsuo06694102015-09-11 13:55:40 -0700155 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800156 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Takashi Matsuo06694102015-09-11 13:55:40 -0700157 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
158 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
159 {
160 "message": "A String", # [Output Only] An optional, human-readable error message.
161 "code": "A String", # [Output Only] The error type identifier for this error.
162 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
163 },
164 ],
165 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800166 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700167 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800168 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
Takashi Matsuo06694102015-09-11 13:55:40 -0700169 }</pre>
170</div>
171
172<div class="method">
173 <code class="details" id="delete">delete(project, deployment)</code>
174 <pre>Deletes a deployment and all of the resources in the deployment.
175
176Args:
177 project: string, The project ID for this request. (required)
178 deployment: string, The name of the deployment for this request. (required)
179
180Returns:
181 An object of the form:
182
183 { # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800184 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
185 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Takashi Matsuo06694102015-09-11 13:55:40 -0700186 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800187 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
188 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
189 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
190 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Takashi Matsuo06694102015-09-11 13:55:40 -0700191 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800192 "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 when the operation will be complete. This number should monotonically increase as the operation progresses.
193 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
Takashi Matsuo06694102015-09-11 13:55:40 -0700194 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800195 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
196 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Takashi Matsuo06694102015-09-11 13:55:40 -0700197 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
198 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800199 "message": "A String", # [Output Only] A human-readable description of the warning code.
200 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
201 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
202 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Takashi Matsuo06694102015-09-11 13:55:40 -0700203 {
204 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800205 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
Takashi Matsuo06694102015-09-11 13:55:40 -0700206 },
207 ],
208 },
209 ],
210 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800211 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
212 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Takashi Matsuo06694102015-09-11 13:55:40 -0700213 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800214 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Takashi Matsuo06694102015-09-11 13:55:40 -0700215 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
216 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
217 {
218 "message": "A String", # [Output Only] An optional, human-readable error message.
219 "code": "A String", # [Output Only] The error type identifier for this error.
220 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
221 },
222 ],
223 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800224 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700225 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800226 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
Takashi Matsuo06694102015-09-11 13:55:40 -0700227 }</pre>
228</div>
229
230<div class="method">
231 <code class="details" id="get">get(project, deployment)</code>
232 <pre>Gets information about a specific deployment.
233
234Args:
235 project: string, The project ID for this request. (required)
236 deployment: string, The name of the deployment for this request. (required)
237
238Returns:
239 An object of the form:
240
241 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800242 "description": "A String", # An optional user-provided description of the deployment.
243 "labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?
244 {
245 "value": "A String",
246 "key": "A String",
247 },
248 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700249 "update": { # [Output Only] If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800250 "labels": [ # [Output Only] Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?
251 {
252 "value": "A String",
253 "key": "A String",
254 },
255 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700256 "manifest": "A String", # [Output Only] URL of the manifest representing the update configuration of this deployment.
257 },
258 "manifest": "A String", # [Output Only] URL of the manifest representing the last manifest that was successfully deployed.
259 "insertTime": "A String", # [Output Only] Timestamp when the deployment was created, in RFC3339 text format .
260 "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.
261 #
262 # 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.
263 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800264 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
265 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Takashi Matsuo06694102015-09-11 13:55:40 -0700266 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800267 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
268 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
269 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
270 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Takashi Matsuo06694102015-09-11 13:55:40 -0700271 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800272 "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 when the operation will be complete. This number should monotonically increase as the operation progresses.
273 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
Takashi Matsuo06694102015-09-11 13:55:40 -0700274 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800275 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
276 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Takashi Matsuo06694102015-09-11 13:55:40 -0700277 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
278 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800279 "message": "A String", # [Output Only] A human-readable description of the warning code.
280 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
281 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
282 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Takashi Matsuo06694102015-09-11 13:55:40 -0700283 {
284 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800285 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
Takashi Matsuo06694102015-09-11 13:55:40 -0700286 },
287 ],
288 },
289 ],
290 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800291 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
292 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Takashi Matsuo06694102015-09-11 13:55:40 -0700293 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800294 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Takashi Matsuo06694102015-09-11 13:55:40 -0700295 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
296 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
297 {
298 "message": "A String", # [Output Only] An optional, human-readable error message.
299 "code": "A String", # [Output Only] The error type identifier for this error.
300 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
301 },
302 ],
303 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800304 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700305 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800306 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
Takashi Matsuo06694102015-09-11 13:55:40 -0700307 },
308 "target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.
309 "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.
310 {
311 "content": "A String", # The contents of the file.
312 "name": "A String", # The name of the file.
313 },
314 ],
315 "config": { # The configuration to use for this deployment.
316 "content": "A String", # The contents of the file.
317 },
318 },
319 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800320 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700321 }</pre>
322</div>
323
324<div class="method">
325 <code class="details" id="insert">insert(project, body, preview=None)</code>
326 <pre>Creates a deployment and all of the resources described by the deployment manifest.
327
328Args:
329 project: string, The project ID for this request. (required)
330 body: object, The request body. (required)
331 The object takes the form of:
332
333{
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800334 "description": "A String", # An optional user-provided description of the deployment.
335 "labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?
336 {
337 "value": "A String",
338 "key": "A String",
339 },
340 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700341 "update": { # [Output Only] If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800342 "labels": [ # [Output Only] Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?
343 {
344 "value": "A String",
345 "key": "A String",
346 },
347 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700348 "manifest": "A String", # [Output Only] URL of the manifest representing the update configuration of this deployment.
349 },
350 "manifest": "A String", # [Output Only] URL of the manifest representing the last manifest that was successfully deployed.
351 "insertTime": "A String", # [Output Only] Timestamp when the deployment was created, in RFC3339 text format .
352 "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.
353 #
354 # 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.
355 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800356 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
357 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Takashi Matsuo06694102015-09-11 13:55:40 -0700358 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800359 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
360 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
361 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
362 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Takashi Matsuo06694102015-09-11 13:55:40 -0700363 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800364 "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 when the operation will be complete. This number should monotonically increase as the operation progresses.
365 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
Takashi Matsuo06694102015-09-11 13:55:40 -0700366 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800367 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
368 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Takashi Matsuo06694102015-09-11 13:55:40 -0700369 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
370 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800371 "message": "A String", # [Output Only] A human-readable description of the warning code.
372 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
373 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
374 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Takashi Matsuo06694102015-09-11 13:55:40 -0700375 {
376 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800377 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
Takashi Matsuo06694102015-09-11 13:55:40 -0700378 },
379 ],
380 },
381 ],
382 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800383 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
384 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Takashi Matsuo06694102015-09-11 13:55:40 -0700385 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800386 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Takashi Matsuo06694102015-09-11 13:55:40 -0700387 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
388 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
389 {
390 "message": "A String", # [Output Only] An optional, human-readable error message.
391 "code": "A String", # [Output Only] The error type identifier for this error.
392 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
393 },
394 ],
395 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800396 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700397 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800398 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
Takashi Matsuo06694102015-09-11 13:55:40 -0700399 },
400 "target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.
401 "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.
402 {
403 "content": "A String", # The contents of the file.
404 "name": "A String", # The name of the file.
405 },
406 ],
407 "config": { # The configuration to use for this deployment.
408 "content": "A String", # The contents of the file.
409 },
410 },
411 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800412 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700413 }
414
415 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.
416
417Returns:
418 An object of the form:
419
420 { # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800421 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
422 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Takashi Matsuo06694102015-09-11 13:55:40 -0700423 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800424 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
425 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
426 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
427 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Takashi Matsuo06694102015-09-11 13:55:40 -0700428 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800429 "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 when the operation will be complete. This number should monotonically increase as the operation progresses.
430 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
Takashi Matsuo06694102015-09-11 13:55:40 -0700431 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800432 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
433 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Takashi Matsuo06694102015-09-11 13:55:40 -0700434 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
435 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800436 "message": "A String", # [Output Only] A human-readable description of the warning code.
437 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
438 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
439 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Takashi Matsuo06694102015-09-11 13:55:40 -0700440 {
441 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800442 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
Takashi Matsuo06694102015-09-11 13:55:40 -0700443 },
444 ],
445 },
446 ],
447 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800448 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
449 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Takashi Matsuo06694102015-09-11 13:55:40 -0700450 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800451 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Takashi Matsuo06694102015-09-11 13:55:40 -0700452 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
453 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
454 {
455 "message": "A String", # [Output Only] An optional, human-readable error message.
456 "code": "A String", # [Output Only] The error type identifier for this error.
457 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
458 },
459 ],
460 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800461 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700462 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800463 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
Takashi Matsuo06694102015-09-11 13:55:40 -0700464 }</pre>
465</div>
466
467<div class="method">
468 <code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
469 <pre>Lists all deployments for a given project.
470
471Args:
472 project: string, The project ID for this request. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800473 maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
474 pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
475 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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700476
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800477The 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 you are filtering by (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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700478
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800479For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.
480
481Compute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.
482
483The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions meaning that resources must match all expressions to pass the filters.
Takashi Matsuo06694102015-09-11 13:55:40 -0700484
485Returns:
486 An object of the form:
487
488 { # A response containing a partial list of deployments and a page token used to build the next request if the request has been truncated.
489 "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
490 "deployments": [ # [Output Only] The deployments contained in this response.
491 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800492 "description": "A String", # An optional user-provided description of the deployment.
493 "labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?
494 {
495 "value": "A String",
496 "key": "A String",
497 },
498 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700499 "update": { # [Output Only] If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800500 "labels": [ # [Output Only] Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?
501 {
502 "value": "A String",
503 "key": "A String",
504 },
505 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700506 "manifest": "A String", # [Output Only] URL of the manifest representing the update configuration of this deployment.
507 },
508 "manifest": "A String", # [Output Only] URL of the manifest representing the last manifest that was successfully deployed.
509 "insertTime": "A String", # [Output Only] Timestamp when the deployment was created, in RFC3339 text format .
510 "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.
511 #
512 # 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.
513 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800514 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
515 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Takashi Matsuo06694102015-09-11 13:55:40 -0700516 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800517 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
518 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
519 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
520 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Takashi Matsuo06694102015-09-11 13:55:40 -0700521 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800522 "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 when the operation will be complete. This number should monotonically increase as the operation progresses.
523 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
Takashi Matsuo06694102015-09-11 13:55:40 -0700524 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800525 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
526 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Takashi Matsuo06694102015-09-11 13:55:40 -0700527 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
528 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800529 "message": "A String", # [Output Only] A human-readable description of the warning code.
530 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
531 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
532 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Takashi Matsuo06694102015-09-11 13:55:40 -0700533 {
534 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800535 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
Takashi Matsuo06694102015-09-11 13:55:40 -0700536 },
537 ],
538 },
539 ],
540 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800541 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
542 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Takashi Matsuo06694102015-09-11 13:55:40 -0700543 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800544 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Takashi Matsuo06694102015-09-11 13:55:40 -0700545 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
546 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
547 {
548 "message": "A String", # [Output Only] An optional, human-readable error message.
549 "code": "A String", # [Output Only] The error type identifier for this error.
550 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
551 },
552 ],
553 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800554 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700555 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800556 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
Takashi Matsuo06694102015-09-11 13:55:40 -0700557 },
558 "target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.
559 "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.
560 {
561 "content": "A String", # The contents of the file.
562 "name": "A String", # The name of the file.
563 },
564 ],
565 "config": { # The configuration to use for this deployment.
566 "content": "A String", # The contents of the file.
567 },
568 },
569 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800570 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700571 },
572 ],
573 }</pre>
574</div>
575
576<div class="method">
577 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
578 <pre>Retrieves the next page of results.
579
580Args:
581 previous_request: The request for the previous page. (required)
582 previous_response: The response from the request for the previous page. (required)
583
584Returns:
585 A request object that you can call 'execute()' on to request the next
586 page. Returns None if there are no more items in the collection.
587 </pre>
588</div>
589
590<div class="method">
591 <code class="details" id="patch">patch(project, deployment, body, deletePolicy=None, createPolicy=None, preview=None)</code>
592 <pre>Updates a deployment and all of the resources described by the deployment manifest. This method supports patch semantics.
593
594Args:
595 project: string, The project ID for this request. (required)
596 deployment: string, The name of the deployment for this request. (required)
597 body: object, The request body. (required)
598 The object takes the form of:
599
600{
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800601 "description": "A String", # An optional user-provided description of the deployment.
602 "labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?
603 {
604 "value": "A String",
605 "key": "A String",
606 },
607 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700608 "update": { # [Output Only] If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800609 "labels": [ # [Output Only] Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?
610 {
611 "value": "A String",
612 "key": "A String",
613 },
614 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700615 "manifest": "A String", # [Output Only] URL of the manifest representing the update configuration of this deployment.
616 },
617 "manifest": "A String", # [Output Only] URL of the manifest representing the last manifest that was successfully deployed.
618 "insertTime": "A String", # [Output Only] Timestamp when the deployment was created, in RFC3339 text format .
619 "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.
620 #
621 # 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.
622 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800623 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
624 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Takashi Matsuo06694102015-09-11 13:55:40 -0700625 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800626 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
627 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
628 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
629 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Takashi Matsuo06694102015-09-11 13:55:40 -0700630 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800631 "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 when the operation will be complete. This number should monotonically increase as the operation progresses.
632 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
Takashi Matsuo06694102015-09-11 13:55:40 -0700633 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800634 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
635 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Takashi Matsuo06694102015-09-11 13:55:40 -0700636 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
637 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800638 "message": "A String", # [Output Only] A human-readable description of the warning code.
639 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
640 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
641 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Takashi Matsuo06694102015-09-11 13:55:40 -0700642 {
643 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800644 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
Takashi Matsuo06694102015-09-11 13:55:40 -0700645 },
646 ],
647 },
648 ],
649 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800650 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
651 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Takashi Matsuo06694102015-09-11 13:55:40 -0700652 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800653 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Takashi Matsuo06694102015-09-11 13:55:40 -0700654 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
655 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
656 {
657 "message": "A String", # [Output Only] An optional, human-readable error message.
658 "code": "A String", # [Output Only] The error type identifier for this error.
659 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
660 },
661 ],
662 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800663 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700664 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800665 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
Takashi Matsuo06694102015-09-11 13:55:40 -0700666 },
667 "target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.
668 "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.
669 {
670 "content": "A String", # The contents of the file.
671 "name": "A String", # The name of the file.
672 },
673 ],
674 "config": { # The configuration to use for this deployment.
675 "content": "A String", # The contents of the file.
676 },
677 },
678 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800679 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700680 }
681
682 deletePolicy: string, Sets the policy to use for deleting resources.
683 Allowed values
684 ABANDON -
685 DELETE -
686 createPolicy: string, Sets the policy to use for creating new resources.
687 Allowed values
688 ACQUIRE -
689 CREATE_OR_ACQUIRE -
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800690 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 will look 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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700691
692Returns:
693 An object of the form:
694
695 { # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800696 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
697 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Takashi Matsuo06694102015-09-11 13:55:40 -0700698 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800699 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
700 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
701 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
702 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Takashi Matsuo06694102015-09-11 13:55:40 -0700703 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800704 "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 when the operation will be complete. This number should monotonically increase as the operation progresses.
705 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
Takashi Matsuo06694102015-09-11 13:55:40 -0700706 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800707 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
708 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Takashi Matsuo06694102015-09-11 13:55:40 -0700709 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
710 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800711 "message": "A String", # [Output Only] A human-readable description of the warning code.
712 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
713 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
714 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Takashi Matsuo06694102015-09-11 13:55:40 -0700715 {
716 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800717 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
Takashi Matsuo06694102015-09-11 13:55:40 -0700718 },
719 ],
720 },
721 ],
722 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800723 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
724 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Takashi Matsuo06694102015-09-11 13:55:40 -0700725 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800726 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Takashi Matsuo06694102015-09-11 13:55:40 -0700727 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
728 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
729 {
730 "message": "A String", # [Output Only] An optional, human-readable error message.
731 "code": "A String", # [Output Only] The error type identifier for this error.
732 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
733 },
734 ],
735 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800736 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700737 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800738 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
Takashi Matsuo06694102015-09-11 13:55:40 -0700739 }</pre>
740</div>
741
742<div class="method">
743 <code class="details" id="stop">stop(project, deployment, body)</code>
744 <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.
745
746Args:
747 project: string, The project ID for this request. (required)
748 deployment: string, The name of the deployment for this request. (required)
749 body: object, The request body. (required)
750 The object takes the form of:
751
752{
753 "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).
754 #
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800755 # 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 on the deployment.
Takashi Matsuo06694102015-09-11 13:55:40 -0700756 }
757
758
759Returns:
760 An object of the form:
761
762 { # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800763 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
764 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Takashi Matsuo06694102015-09-11 13:55:40 -0700765 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800766 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
767 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
768 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
769 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Takashi Matsuo06694102015-09-11 13:55:40 -0700770 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800771 "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 when the operation will be complete. This number should monotonically increase as the operation progresses.
772 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
Takashi Matsuo06694102015-09-11 13:55:40 -0700773 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800774 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
775 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Takashi Matsuo06694102015-09-11 13:55:40 -0700776 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
777 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800778 "message": "A String", # [Output Only] A human-readable description of the warning code.
779 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
780 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
781 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Takashi Matsuo06694102015-09-11 13:55:40 -0700782 {
783 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800784 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
Takashi Matsuo06694102015-09-11 13:55:40 -0700785 },
786 ],
787 },
788 ],
789 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800790 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
791 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Takashi Matsuo06694102015-09-11 13:55:40 -0700792 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800793 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Takashi Matsuo06694102015-09-11 13:55:40 -0700794 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
795 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
796 {
797 "message": "A String", # [Output Only] An optional, human-readable error message.
798 "code": "A String", # [Output Only] The error type identifier for this error.
799 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
800 },
801 ],
802 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800803 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700804 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800805 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
Takashi Matsuo06694102015-09-11 13:55:40 -0700806 }</pre>
807</div>
808
809<div class="method">
810 <code class="details" id="update">update(project, deployment, body, deletePolicy=None, createPolicy=None, preview=None)</code>
811 <pre>Updates a deployment and all of the resources described by the deployment manifest.
812
813Args:
814 project: string, The project ID for this request. (required)
815 deployment: string, The name of the deployment for this request. (required)
816 body: object, The request body. (required)
817 The object takes the form of:
818
819{
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800820 "description": "A String", # An optional user-provided description of the deployment.
821 "labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?
822 {
823 "value": "A String",
824 "key": "A String",
825 },
826 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700827 "update": { # [Output Only] If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800828 "labels": [ # [Output Only] Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?
829 {
830 "value": "A String",
831 "key": "A String",
832 },
833 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700834 "manifest": "A String", # [Output Only] URL of the manifest representing the update configuration of this deployment.
835 },
836 "manifest": "A String", # [Output Only] URL of the manifest representing the last manifest that was successfully deployed.
837 "insertTime": "A String", # [Output Only] Timestamp when the deployment was created, in RFC3339 text format .
838 "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.
839 #
840 # 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.
841 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800842 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
843 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Takashi Matsuo06694102015-09-11 13:55:40 -0700844 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800845 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
846 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
847 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
848 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Takashi Matsuo06694102015-09-11 13:55:40 -0700849 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800850 "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 when the operation will be complete. This number should monotonically increase as the operation progresses.
851 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
Takashi Matsuo06694102015-09-11 13:55:40 -0700852 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800853 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
854 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Takashi Matsuo06694102015-09-11 13:55:40 -0700855 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
856 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800857 "message": "A String", # [Output Only] A human-readable description of the warning code.
858 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
859 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
860 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Takashi Matsuo06694102015-09-11 13:55:40 -0700861 {
862 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800863 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
Takashi Matsuo06694102015-09-11 13:55:40 -0700864 },
865 ],
866 },
867 ],
868 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800869 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
870 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Takashi Matsuo06694102015-09-11 13:55:40 -0700871 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800872 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Takashi Matsuo06694102015-09-11 13:55:40 -0700873 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
874 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
875 {
876 "message": "A String", # [Output Only] An optional, human-readable error message.
877 "code": "A String", # [Output Only] The error type identifier for this error.
878 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
879 },
880 ],
881 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800882 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700883 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800884 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
Takashi Matsuo06694102015-09-11 13:55:40 -0700885 },
886 "target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.
887 "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.
888 {
889 "content": "A String", # The contents of the file.
890 "name": "A String", # The name of the file.
891 },
892 ],
893 "config": { # The configuration to use for this deployment.
894 "content": "A String", # The contents of the file.
895 },
896 },
897 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800898 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700899 }
900
901 deletePolicy: string, Sets the policy to use for deleting resources.
902 Allowed values
903 ABANDON -
904 DELETE -
905 createPolicy: string, Sets the policy to use for creating new resources.
906 Allowed values
907 ACQUIRE -
908 CREATE_OR_ACQUIRE -
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800909 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 will look 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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700910
911Returns:
912 An object of the form:
913
914 { # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800915 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
916 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Takashi Matsuo06694102015-09-11 13:55:40 -0700917 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800918 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
919 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
920 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
921 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Takashi Matsuo06694102015-09-11 13:55:40 -0700922 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800923 "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 when the operation will be complete. This number should monotonically increase as the operation progresses.
924 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
Takashi Matsuo06694102015-09-11 13:55:40 -0700925 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800926 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
927 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Takashi Matsuo06694102015-09-11 13:55:40 -0700928 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
929 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800930 "message": "A String", # [Output Only] A human-readable description of the warning code.
931 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
932 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
933 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Takashi Matsuo06694102015-09-11 13:55:40 -0700934 {
935 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800936 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
Takashi Matsuo06694102015-09-11 13:55:40 -0700937 },
938 ],
939 },
940 ],
941 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800942 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
943 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Takashi Matsuo06694102015-09-11 13:55:40 -0700944 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800945 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Takashi Matsuo06694102015-09-11 13:55:40 -0700946 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
947 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
948 {
949 "message": "A String", # [Output Only] An optional, human-readable error message.
950 "code": "A String", # [Output Only] The error type identifier for this error.
951 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
952 },
953 ],
954 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800955 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700956 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800957 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
Takashi Matsuo06694102015-09-11 13:55:40 -0700958 }</pre>
959</div>
960
961</body></html>