Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c9b6cec70b2162b98d836f8100bc039f19fe23cb / . / docs / dyn / replicapoolupdater_v1beta1.rollingUpdates.html
blob: 6df9e24a677ec7278d47efffc0f99eced31a82bb [file] [log] [blame]
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="replicapoolupdater_v1beta1.html">Google Compute Engine Instance Group Updater API</a> . <a href="replicapoolupdater_v1beta1.rollingUpdates.html">rollingUpdates</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#cancel">cancel(project, zone, rollingUpdate)</a></code></p>
79<p class="firstline">Cancels an update. The update must be PAUSED before it can be cancelled. This has no effect if the update is already CANCELLED.</p>
80<p class="toc_element">
81 <code><a href="#get">get(project, zone, rollingUpdate)</a></code></p>
82<p class="firstline">Returns information about an update.</p>
83<p class="toc_element">
84 <code><a href="#insert">insert(project, zone, body)</a></code></p>
85<p class="firstline">Inserts and starts a new update.</p>
86<p class="toc_element">
87 <code><a href="#list">list(project, zone, maxResults=None, pageToken=None, instanceGroupManager=None, filter=None)</a></code></p>
88<p class="firstline">Lists recent updates for a given managed instance group, in reverse chronological order and paginated format.</p>
89<p class="toc_element">
90 <code><a href="#listInstanceUpdates">listInstanceUpdates(project, zone, rollingUpdate, maxResults=None, pageToken=None, filter=None)</a></code></p>
91<p class="firstline">Lists the current status for each instance within a given update.</p>
92<p class="toc_element">
93 <code><a href="#listInstanceUpdates_next">listInstanceUpdates_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="#list_next">list_next(previous_request, previous_response)</a></code></p>
97<p class="firstline">Retrieves the next page of results.</p>
98<p class="toc_element">
99 <code><a href="#pause">pause(project, zone, rollingUpdate)</a></code></p>
100<p class="firstline">Pauses the update in state from ROLLING_FORWARD or ROLLING_BACK. Has no effect if invoked when the state of the update is PAUSED.</p>
101<p class="toc_element">
102 <code><a href="#resume">resume(project, zone, rollingUpdate)</a></code></p>
103<p class="firstline">Continues an update in PAUSED state. Has no effect if invoked when the state of the update is ROLLED_OUT.</p>
104<p class="toc_element">
105 <code><a href="#rollback">rollback(project, zone, rollingUpdate)</a></code></p>
106<p class="firstline">Rolls back the update in state from ROLLING_FORWARD or PAUSED. Has no effect if invoked when the state of the update is ROLLED_BACK.</p>
107<h3>Method Details</h3>
108<div class="method">
109 <code class="details" id="cancel">cancel(project, zone, rollingUpdate)</code>
110 <pre>Cancels an update. The update must be PAUSED before it can be cancelled. This has no effect if the update is already CANCELLED.
111
112Args:
113 project: string, The Google Developers Console project name. (required)
114 zone: string, The name of the zone in which the update's target resides. (required)
115 rollingUpdate: string, The name of the update. (required)
116
117Returns:
118 An object of the form:
119
120 { # An operation resource, used to manage asynchronous API requests.
121 "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
122 "clientOperationId": "A String",
123 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
124 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
125 "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
126 "operationType": "A String",
127 "httpErrorMessage": "A String",
128 "progress": 42,
129 "httpErrorStatusCode": 42,
130 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
131 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
132 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
133 "warnings": [
134 {
135 "message": "A String", # [Output only] Optional human-readable details for this warning.
136 "code": "A String", # [Output only] The warning type identifier for this warning.
137 "data": [ # [Output only] Metadata for this warning in key:value format.
138 {
139 "value": "A String", # [Output Only] Metadata value for this warning.
140 "key": "A String", # [Output Only] Metadata key for this warning.
141 },
142 ],
143 },
144 ],
145 "user": "A String",
146 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
147 "kind": "replicapoolupdater#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
148 "name": "A String", # [Output Only] Name of the resource (output only).
149 "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
150 "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
151 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
152 {
153 "message": "A String", # [Output Only] An optional, human-readable error message.
154 "code": "A String", # [Output Only] The error type identifier for this error.
155 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
156 },
157 ],
158 },
159 "endTime": "A String",
160 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
161 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
162 }</pre>
163</div>
164
165<div class="method">
166 <code class="details" id="get">get(project, zone, rollingUpdate)</code>
167 <pre>Returns information about an update.
168
169Args:
170 project: string, The Google Developers Console project name. (required)
171 zone: string, The name of the zone in which the update's target resides. (required)
172 rollingUpdate: string, The name of the update. (required)
173
174Returns:
175 An object of the form:
176
177 { # The following represents a resource describing a single update (rollout) of a group of instances to the given template.
178 "status": "A String", # [Output Only] Status of the update. Possible values are:
179 # - "ROLLING_FORWARD": The update is going forward.
180 # - "ROLLING_BACK": The update is being rolled back.
181 # - "PAUSED": The update is temporarily paused (inactive).
182 # - "ROLLED_OUT": The update is finished, all instances have been updated successfully.
183 # - "ROLLED_BACK": The update is finished, all instances have been reverted to the previous template.
184 # - "CANCELLED": The update is paused and no longer can be resumed, undefined how many instances are running in which template.
185 "kind": "replicapoolupdater#rollingUpdate", # [Output Only] Type of the resource.
186 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
187 "user": "A String", # [Output Only] User who requested the update, for example: user@example.com.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]188 "instanceGroup": "A String", # Fully-qualified URL of an instance group being updated. Exactly one of instanceGroupManager, instanceGroup and instance list must be set.
189 "instances": [ # List of fully-qualified URLs of instances to be updated. Exactly one of instanceGroupManager, instanceGroup and instance list must be set.
190 "A String",
191 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]192 "instanceTemplate": "A String", # Fully-qualified URL of an instance template to apply.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]193 "actionType": "A String", # Specifies the action to take for each instance within the instance group. This can be RECREATE which will recreate each instance and is only available for managed instance groups. It can also be REBOOT which performs a soft reboot for each instance and is only available for regular (non-managed) instance groups and explicit lists of instances.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]194 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the update.
195 "error": { # [Output Only] Errors that occurred during rolling update.
196 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
197 {
198 "message": "A String", # [Output Only] An optional, human-readable error message.
199 "code": "A String", # [Output Only] The error type identifier for this error.
200 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
201 },
202 ],
203 },
204 "policy": { # Parameters of the update process.
205 "instanceStartupTimeoutSec": 42, # Maximum amount of time we will wait after finishing all steps until we receive HEALTHY state for instance. If this deadline is exceeded instance update is considered as failed.
206 "maxNumConcurrentInstances": 42, # Maximum number of instances that can be updated simultaneously (concurrently). An update of an instance starts when the instance is about to be restarted and finishes after the instance has been restarted and the sleep period (defined by sleepAfterInstanceRestartSec) has passed.
207 "minInstanceUpdateTimeSec": 42, # Specifies minimum amount of time we will spend on updating single instance, measuring at the start of the first update action (e.g. Recreate call on Instance Group Manager or Stop call on Instance resource). If actual instance update takes less time we will simply sleep before proceeding with next instance.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]208 "sleepAfterInstanceRestartSec": 42, # Time period after the instance has been restarted but before marking the update of this instance as done. This field is deprecated and ignored by Rolling Updater.
209 "maxNumFailedInstances": 42, # Maximum number of instance updates that can fail without failing the group update. Instance update is considered failed if any of it's update actions (e.g. Stop call on Instance resource in Rolling Reboot) failed with permanent failure, or if after finishing all update actions this instance is in UNHEALTHY state.
210 "autoPauseAfterInstances": 42, # Number of instances updated before the update gets automatically paused.
211 },
212 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the update will be complete. This number should be monotonically increasing as the update progresses.
213 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
214 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
215 "selfLink": "A String", # [Output Only] The fully qualified URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]216 "instanceGroupManager": "A String", # Fully-qualified URL of an instance group manager being updated. Exactly one of instanceGroupManager, instanceGroup and instance list must be set.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]217 }</pre>
218</div>
219
220<div class="method">
221 <code class="details" id="insert">insert(project, zone, body)</code>
222 <pre>Inserts and starts a new update.
223
224Args:
225 project: string, The Google Developers Console project name. (required)
226 zone: string, The name of the zone in which the update's target resides. (required)
227 body: object, The request body. (required)
228 The object takes the form of:
229
230{ # The following represents a resource describing a single update (rollout) of a group of instances to the given template.
231 "status": "A String", # [Output Only] Status of the update. Possible values are:
232 # - "ROLLING_FORWARD": The update is going forward.
233 # - "ROLLING_BACK": The update is being rolled back.
234 # - "PAUSED": The update is temporarily paused (inactive).
235 # - "ROLLED_OUT": The update is finished, all instances have been updated successfully.
236 # - "ROLLED_BACK": The update is finished, all instances have been reverted to the previous template.
237 # - "CANCELLED": The update is paused and no longer can be resumed, undefined how many instances are running in which template.
238 "kind": "replicapoolupdater#rollingUpdate", # [Output Only] Type of the resource.
239 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
240 "user": "A String", # [Output Only] User who requested the update, for example: user@example.com.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]241 "instanceGroup": "A String", # Fully-qualified URL of an instance group being updated. Exactly one of instanceGroupManager, instanceGroup and instance list must be set.
242 "instances": [ # List of fully-qualified URLs of instances to be updated. Exactly one of instanceGroupManager, instanceGroup and instance list must be set.
243 "A String",
244 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]245 "instanceTemplate": "A String", # Fully-qualified URL of an instance template to apply.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]246 "actionType": "A String", # Specifies the action to take for each instance within the instance group. This can be RECREATE which will recreate each instance and is only available for managed instance groups. It can also be REBOOT which performs a soft reboot for each instance and is only available for regular (non-managed) instance groups and explicit lists of instances.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]247 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the update.
248 "error": { # [Output Only] Errors that occurred during rolling update.
249 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
250 {
251 "message": "A String", # [Output Only] An optional, human-readable error message.
252 "code": "A String", # [Output Only] The error type identifier for this error.
253 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
254 },
255 ],
256 },
257 "policy": { # Parameters of the update process.
258 "instanceStartupTimeoutSec": 42, # Maximum amount of time we will wait after finishing all steps until we receive HEALTHY state for instance. If this deadline is exceeded instance update is considered as failed.
259 "maxNumConcurrentInstances": 42, # Maximum number of instances that can be updated simultaneously (concurrently). An update of an instance starts when the instance is about to be restarted and finishes after the instance has been restarted and the sleep period (defined by sleepAfterInstanceRestartSec) has passed.
260 "minInstanceUpdateTimeSec": 42, # Specifies minimum amount of time we will spend on updating single instance, measuring at the start of the first update action (e.g. Recreate call on Instance Group Manager or Stop call on Instance resource). If actual instance update takes less time we will simply sleep before proceeding with next instance.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]261 "sleepAfterInstanceRestartSec": 42, # Time period after the instance has been restarted but before marking the update of this instance as done. This field is deprecated and ignored by Rolling Updater.
262 "maxNumFailedInstances": 42, # Maximum number of instance updates that can fail without failing the group update. Instance update is considered failed if any of it's update actions (e.g. Stop call on Instance resource in Rolling Reboot) failed with permanent failure, or if after finishing all update actions this instance is in UNHEALTHY state.
263 "autoPauseAfterInstances": 42, # Number of instances updated before the update gets automatically paused.
264 },
265 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the update will be complete. This number should be monotonically increasing as the update progresses.
266 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
267 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
268 "selfLink": "A String", # [Output Only] The fully qualified URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]269 "instanceGroupManager": "A String", # Fully-qualified URL of an instance group manager being updated. Exactly one of instanceGroupManager, instanceGroup and instance list must be set.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]270 }
271
272
273Returns:
274 An object of the form:
275
276 { # An operation resource, used to manage asynchronous API requests.
277 "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
278 "clientOperationId": "A String",
279 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
280 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
281 "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
282 "operationType": "A String",
283 "httpErrorMessage": "A String",
284 "progress": 42,
285 "httpErrorStatusCode": 42,
286 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
287 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
288 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
289 "warnings": [
290 {
291 "message": "A String", # [Output only] Optional human-readable details for this warning.
292 "code": "A String", # [Output only] The warning type identifier for this warning.
293 "data": [ # [Output only] Metadata for this warning in key:value format.
294 {
295 "value": "A String", # [Output Only] Metadata value for this warning.
296 "key": "A String", # [Output Only] Metadata key for this warning.
297 },
298 ],
299 },
300 ],
301 "user": "A String",
302 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
303 "kind": "replicapoolupdater#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
304 "name": "A String", # [Output Only] Name of the resource (output only).
305 "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
306 "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
307 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
308 {
309 "message": "A String", # [Output Only] An optional, human-readable error message.
310 "code": "A String", # [Output Only] The error type identifier for this error.
311 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
312 },
313 ],
314 },
315 "endTime": "A String",
316 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
317 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
318 }</pre>
319</div>
320
321<div class="method">
322 <code class="details" id="list">list(project, zone, maxResults=None, pageToken=None, instanceGroupManager=None, filter=None)</code>
323 <pre>Lists recent updates for a given managed instance group, in reverse chronological order and paginated format.
324
325Args:
326 project: string, The Google Developers Console project name. (required)
327 zone: string, The name of the zone in which the update's target resides. (required)
328 maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
329 pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
330 instanceGroupManager: string, The name of the instance group manager used for filtering.
331 filter: string, Optional. Filter expression for filtering listed resources.
332
333Returns:
334 An object of the form:
335
336 { # Response returned by List method.
337 "nextPageToken": "A String", # A token used to continue a truncated list request.
338 "items": [ # Collection of requested updates.
339 { # The following represents a resource describing a single update (rollout) of a group of instances to the given template.
340 "status": "A String", # [Output Only] Status of the update. Possible values are:
341 # - "ROLLING_FORWARD": The update is going forward.
342 # - "ROLLING_BACK": The update is being rolled back.
343 # - "PAUSED": The update is temporarily paused (inactive).
344 # - "ROLLED_OUT": The update is finished, all instances have been updated successfully.
345 # - "ROLLED_BACK": The update is finished, all instances have been reverted to the previous template.
346 # - "CANCELLED": The update is paused and no longer can be resumed, undefined how many instances are running in which template.
347 "kind": "replicapoolupdater#rollingUpdate", # [Output Only] Type of the resource.
348 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
349 "user": "A String", # [Output Only] User who requested the update, for example: user@example.com.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]350 "instanceGroup": "A String", # Fully-qualified URL of an instance group being updated. Exactly one of instanceGroupManager, instanceGroup and instance list must be set.
351 "instances": [ # List of fully-qualified URLs of instances to be updated. Exactly one of instanceGroupManager, instanceGroup and instance list must be set.
352 "A String",
353 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]354 "instanceTemplate": "A String", # Fully-qualified URL of an instance template to apply.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]355 "actionType": "A String", # Specifies the action to take for each instance within the instance group. This can be RECREATE which will recreate each instance and is only available for managed instance groups. It can also be REBOOT which performs a soft reboot for each instance and is only available for regular (non-managed) instance groups and explicit lists of instances.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]356 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the update.
357 "error": { # [Output Only] Errors that occurred during rolling update.
358 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
359 {
360 "message": "A String", # [Output Only] An optional, human-readable error message.
361 "code": "A String", # [Output Only] The error type identifier for this error.
362 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
363 },
364 ],
365 },
366 "policy": { # Parameters of the update process.
367 "instanceStartupTimeoutSec": 42, # Maximum amount of time we will wait after finishing all steps until we receive HEALTHY state for instance. If this deadline is exceeded instance update is considered as failed.
368 "maxNumConcurrentInstances": 42, # Maximum number of instances that can be updated simultaneously (concurrently). An update of an instance starts when the instance is about to be restarted and finishes after the instance has been restarted and the sleep period (defined by sleepAfterInstanceRestartSec) has passed.
369 "minInstanceUpdateTimeSec": 42, # Specifies minimum amount of time we will spend on updating single instance, measuring at the start of the first update action (e.g. Recreate call on Instance Group Manager or Stop call on Instance resource). If actual instance update takes less time we will simply sleep before proceeding with next instance.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]370 "sleepAfterInstanceRestartSec": 42, # Time period after the instance has been restarted but before marking the update of this instance as done. This field is deprecated and ignored by Rolling Updater.
371 "maxNumFailedInstances": 42, # Maximum number of instance updates that can fail without failing the group update. Instance update is considered failed if any of it's update actions (e.g. Stop call on Instance resource in Rolling Reboot) failed with permanent failure, or if after finishing all update actions this instance is in UNHEALTHY state.
372 "autoPauseAfterInstances": 42, # Number of instances updated before the update gets automatically paused.
373 },
374 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the update will be complete. This number should be monotonically increasing as the update progresses.
375 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
376 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
377 "selfLink": "A String", # [Output Only] The fully qualified URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]378 "instanceGroupManager": "A String", # Fully-qualified URL of an instance group manager being updated. Exactly one of instanceGroupManager, instanceGroup and instance list must be set.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]379 },
380 ],
381 "kind": "replicapoolupdater#rollingUpdateList", # [Output Only] Type of the resource.
382 "selfLink": "A String", # [Output Only] The fully qualified URL for the resource.
383 }</pre>
384</div>
385
386<div class="method">
387 <code class="details" id="listInstanceUpdates">listInstanceUpdates(project, zone, rollingUpdate, maxResults=None, pageToken=None, filter=None)</code>
388 <pre>Lists the current status for each instance within a given update.
389
390Args:
391 project: string, The Google Developers Console project name. (required)
392 zone: string, The name of the zone in which the update's target resides. (required)
393 rollingUpdate: string, The name of the update. (required)
394 maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
395 pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
396 filter: string, Optional. Filter expression for filtering listed resources.
397
398Returns:
399 An object of the form:
400
401 { # Response returned by ListInstanceUpdates method.
402 "nextPageToken": "A String", # A token used to continue a truncated list request.
403 "items": [ # Collection of requested instance updates.
404 { # Update of a single instance.
405 "status": "A String", # Status of the instance update. Possible values are:
406 # - "PENDING": The instance update is pending execution.
407 # - "ROLLING_FORWARD": The instance update is going forward.
408 # - "ROLLING_BACK": The instance update is being rolled back.
409 # - "PAUSED": The instance update is temporarily paused (inactive).
410 # - "ROLLED_OUT": The instance update is finished, the instance is running the new template.
411 # - "ROLLED_BACK": The instance update is finished, the instance has been reverted to the previous template.
412 # - "CANCELLED": The instance update is paused and no longer can be resumed, undefined in which template the instance is running.
413 "instance": "A String", # URL of the instance being updated.
414 "error": { # Errors that occurred during the instance update.
415 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
416 {
417 "message": "A String", # [Output Only] An optional, human-readable error message.
418 "code": "A String", # [Output Only] The error type identifier for this error.
419 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
420 },
421 ],
422 },
423 },
424 ],
425 "kind": "replicapoolupdater#instanceUpdateList", # [Output Only] Type of the resource.
426 "selfLink": "A String", # [Output Only] The fully qualified URL for the resource.
427 }</pre>
428</div>
429
430<div class="method">
431 <code class="details" id="listInstanceUpdates_next">listInstanceUpdates_next(previous_request, previous_response)</code>
432 <pre>Retrieves the next page of results.
433
434Args:
435 previous_request: The request for the previous page. (required)
436 previous_response: The response from the request for the previous page. (required)
437
438Returns:
439 A request object that you can call 'execute()' on to request the next
440 page. Returns None if there are no more items in the collection.
441 </pre>
442</div>
443
444<div class="method">
445 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
446 <pre>Retrieves the next page of results.
447
448Args:
449 previous_request: The request for the previous page. (required)
450 previous_response: The response from the request for the previous page. (required)
451
452Returns:
453 A request object that you can call 'execute()' on to request the next
454 page. Returns None if there are no more items in the collection.
455 </pre>
456</div>
457
458<div class="method">
459 <code class="details" id="pause">pause(project, zone, rollingUpdate)</code>
460 <pre>Pauses the update in state from ROLLING_FORWARD or ROLLING_BACK. Has no effect if invoked when the state of the update is PAUSED.
461
462Args:
463 project: string, The Google Developers Console project name. (required)
464 zone: string, The name of the zone in which the update's target resides. (required)
465 rollingUpdate: string, The name of the update. (required)
466
467Returns:
468 An object of the form:
469
470 { # An operation resource, used to manage asynchronous API requests.
471 "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
472 "clientOperationId": "A String",
473 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
474 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
475 "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
476 "operationType": "A String",
477 "httpErrorMessage": "A String",
478 "progress": 42,
479 "httpErrorStatusCode": 42,
480 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
481 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
482 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
483 "warnings": [
484 {
485 "message": "A String", # [Output only] Optional human-readable details for this warning.
486 "code": "A String", # [Output only] The warning type identifier for this warning.
487 "data": [ # [Output only] Metadata for this warning in key:value format.
488 {
489 "value": "A String", # [Output Only] Metadata value for this warning.
490 "key": "A String", # [Output Only] Metadata key for this warning.
491 },
492 ],
493 },
494 ],
495 "user": "A String",
496 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
497 "kind": "replicapoolupdater#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
498 "name": "A String", # [Output Only] Name of the resource (output only).
499 "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
500 "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
501 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
502 {
503 "message": "A String", # [Output Only] An optional, human-readable error message.
504 "code": "A String", # [Output Only] The error type identifier for this error.
505 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
506 },
507 ],
508 },
509 "endTime": "A String",
510 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
511 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
512 }</pre>
513</div>
514
515<div class="method">
516 <code class="details" id="resume">resume(project, zone, rollingUpdate)</code>
517 <pre>Continues an update in PAUSED state. Has no effect if invoked when the state of the update is ROLLED_OUT.
518
519Args:
520 project: string, The Google Developers Console project name. (required)
521 zone: string, The name of the zone in which the update's target resides. (required)
522 rollingUpdate: string, The name of the update. (required)
523
524Returns:
525 An object of the form:
526
527 { # An operation resource, used to manage asynchronous API requests.
528 "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
529 "clientOperationId": "A String",
530 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
531 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
532 "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
533 "operationType": "A String",
534 "httpErrorMessage": "A String",
535 "progress": 42,
536 "httpErrorStatusCode": 42,
537 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
538 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
539 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
540 "warnings": [
541 {
542 "message": "A String", # [Output only] Optional human-readable details for this warning.
543 "code": "A String", # [Output only] The warning type identifier for this warning.
544 "data": [ # [Output only] Metadata for this warning in key:value format.
545 {
546 "value": "A String", # [Output Only] Metadata value for this warning.
547 "key": "A String", # [Output Only] Metadata key for this warning.
548 },
549 ],
550 },
551 ],
552 "user": "A String",
553 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
554 "kind": "replicapoolupdater#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
555 "name": "A String", # [Output Only] Name of the resource (output only).
556 "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
557 "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
558 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
559 {
560 "message": "A String", # [Output Only] An optional, human-readable error message.
561 "code": "A String", # [Output Only] The error type identifier for this error.
562 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
563 },
564 ],
565 },
566 "endTime": "A String",
567 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
568 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
569 }</pre>
570</div>
571
572<div class="method">
573 <code class="details" id="rollback">rollback(project, zone, rollingUpdate)</code>
574 <pre>Rolls back the update in state from ROLLING_FORWARD or PAUSED. Has no effect if invoked when the state of the update is ROLLED_BACK.
575
576Args:
577 project: string, The Google Developers Console project name. (required)
578 zone: string, The name of the zone in which the update's target resides. (required)
579 rollingUpdate: string, The name of the update. (required)
580
581Returns:
582 An object of the form:
583
584 { # An operation resource, used to manage asynchronous API requests.
585 "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
586 "clientOperationId": "A String",
587 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
588 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
589 "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
590 "operationType": "A String",
591 "httpErrorMessage": "A String",
592 "progress": 42,
593 "httpErrorStatusCode": 42,
594 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
595 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
596 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
597 "warnings": [
598 {
599 "message": "A String", # [Output only] Optional human-readable details for this warning.
600 "code": "A String", # [Output only] The warning type identifier for this warning.
601 "data": [ # [Output only] Metadata for this warning in key:value format.
602 {
603 "value": "A String", # [Output Only] Metadata value for this warning.
604 "key": "A String", # [Output Only] Metadata key for this warning.
605 },
606 ],
607 },
608 ],
609 "user": "A String",
610 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
611 "kind": "replicapoolupdater#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
612 "name": "A String", # [Output Only] Name of the resource (output only).
613 "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
614 "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
615 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
616 {
617 "message": "A String", # [Output Only] An optional, human-readable error message.
618 "code": "A String", # [Output Only] The error type identifier for this error.
619 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
620 },
621 ],
622 },
623 "endTime": "A String",
624 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
625 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
626 }</pre>
627</div>
628
629</body></html>