Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 98b51f044ede8b9b24e584ab9680e3f35f4bd469 / . / docs / dyn / replicapoolupdater_v1beta1.rollingUpdates.html
blob: 827cf29998eb32f6703a47c73a8aed478b704ee2 [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">
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]87 <code><a href="#list">list(project, zone, maxResults=None, pageToken=None, filter=None)</a></code></p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]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",
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]123 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]124 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]125 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]147 "kind": "replicapoolupdater#operation", # [Output Only] Type of the resource. Always replicapoolupdater#operation for Operation resources.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]148 "name": "A String", # [Output Only] Name of the resource.
149 "region": "A String", # [Output Only] URL of the region where the operation resides.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]155 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]156 },
157 ],
158 },
159 "endTime": "A String",
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]160 "selfLink": "A String", # [Output Only] The fully qualified URL for the resource.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]161 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]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 Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]188 "instanceGroup": "A String", # Fully-qualified URL of an instance group being updated. Exactly one of instanceGroupManager and instanceGroup must be set.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]189 "instanceTemplate": "A String", # Fully-qualified URL of an instance template to apply.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]190 "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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]191 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the update.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]192 "error": { # [Output Only] Errors that occurred during the rolling update.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]193 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
194 {
195 "message": "A String", # [Output Only] An optional, human-readable error message.
196 "code": "A String", # [Output Only] The error type identifier for this error.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]197 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]198 },
199 ],
200 },
201 "policy": { # Parameters of the update process.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]202 "autoPauseAfterInstances": 42, # Number of instances to update before the updater pauses the rolling update.
203 "instanceStartupTimeoutSec": 42, # The maximum amount of time that the updater waits for a HEALTHY state after all of the update steps are complete. If the HEALTHY state is not received before the deadline, the instance update is considered a failure.
204 "maxNumConcurrentInstances": 42, # The maximum number of instances that can be updated simultaneously. An instance update is considered complete only after the instance is restarted and initialized.
205 "minInstanceUpdateTimeSec": 42, # The minimum amount of time that the updater spends to update each instance. Update time is the time it takes to complete all update actions (e.g. Stop call on Instance resource in Rolling Reboot), reboot, and initialize. If the instance update finishes early, the updater pauses for the remainder of the time before it starts the next instance update.
206 "maxNumFailedInstances": 42, # The maximum number of instance updates that can fail before the group update is considered a failure. An instance update is considered failed if any of its update actions (e.g. Stop call on Instance resource in Rolling Reboot) failed with permanent failure, or if the instance is in an UNHEALTHY state after it finishes all of the update actions.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]207 },
208 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]209 "oldInstanceTemplate": "A String", # Fully-qualified URL of the instance template encountered while starting the update.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]210 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
211 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
212 "selfLink": "A String", # [Output Only] The fully qualified URL for the resource.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]213 "instanceGroupManager": "A String", # Fully-qualified URL of an instance group manager being updated. Exactly one of instanceGroupManager and instanceGroup must be set.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]214 }</pre>
215</div>
216
217<div class="method">
218 <code class="details" id="insert">insert(project, zone, body)</code>
219 <pre>Inserts and starts a new update.
220
221Args:
222 project: string, The Google Developers Console project name. (required)
223 zone: string, The name of the zone in which the update's target resides. (required)
224 body: object, The request body. (required)
225 The object takes the form of:
226
227{ # The following represents a resource describing a single update (rollout) of a group of instances to the given template.
228 "status": "A String", # [Output Only] Status of the update. Possible values are:
229 # - "ROLLING_FORWARD": The update is going forward.
230 # - "ROLLING_BACK": The update is being rolled back.
231 # - "PAUSED": The update is temporarily paused (inactive).
232 # - "ROLLED_OUT": The update is finished, all instances have been updated successfully.
233 # - "ROLLED_BACK": The update is finished, all instances have been reverted to the previous template.
234 # - "CANCELLED": The update is paused and no longer can be resumed, undefined how many instances are running in which template.
235 "kind": "replicapoolupdater#rollingUpdate", # [Output Only] Type of the resource.
236 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
237 "user": "A String", # [Output Only] User who requested the update, for example: user@example.com.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]238 "instanceGroup": "A String", # Fully-qualified URL of an instance group being updated. Exactly one of instanceGroupManager and instanceGroup must be set.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]239 "instanceTemplate": "A String", # Fully-qualified URL of an instance template to apply.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]240 "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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]241 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the update.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]242 "error": { # [Output Only] Errors that occurred during the rolling update.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]243 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
244 {
245 "message": "A String", # [Output Only] An optional, human-readable error message.
246 "code": "A String", # [Output Only] The error type identifier for this error.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]247 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]248 },
249 ],
250 },
251 "policy": { # Parameters of the update process.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]252 "autoPauseAfterInstances": 42, # Number of instances to update before the updater pauses the rolling update.
253 "instanceStartupTimeoutSec": 42, # The maximum amount of time that the updater waits for a HEALTHY state after all of the update steps are complete. If the HEALTHY state is not received before the deadline, the instance update is considered a failure.
254 "maxNumConcurrentInstances": 42, # The maximum number of instances that can be updated simultaneously. An instance update is considered complete only after the instance is restarted and initialized.
255 "minInstanceUpdateTimeSec": 42, # The minimum amount of time that the updater spends to update each instance. Update time is the time it takes to complete all update actions (e.g. Stop call on Instance resource in Rolling Reboot), reboot, and initialize. If the instance update finishes early, the updater pauses for the remainder of the time before it starts the next instance update.
256 "maxNumFailedInstances": 42, # The maximum number of instance updates that can fail before the group update is considered a failure. An instance update is considered failed if any of its update actions (e.g. Stop call on Instance resource in Rolling Reboot) failed with permanent failure, or if the instance is in an UNHEALTHY state after it finishes all of the update actions.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]257 },
258 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]259 "oldInstanceTemplate": "A String", # Fully-qualified URL of the instance template encountered while starting the update.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]260 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
261 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
262 "selfLink": "A String", # [Output Only] The fully qualified URL for the resource.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]263 "instanceGroupManager": "A String", # Fully-qualified URL of an instance group manager being updated. Exactly one of instanceGroupManager and instanceGroup must be set.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]264 }
265
266
267Returns:
268 An object of the form:
269
270 { # An operation resource, used to manage asynchronous API requests.
271 "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
272 "clientOperationId": "A String",
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]273 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]274 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]275 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]276 "operationType": "A String",
277 "httpErrorMessage": "A String",
278 "progress": 42,
279 "httpErrorStatusCode": 42,
280 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
281 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
282 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
283 "warnings": [
284 {
285 "message": "A String", # [Output only] Optional human-readable details for this warning.
286 "code": "A String", # [Output only] The warning type identifier for this warning.
287 "data": [ # [Output only] Metadata for this warning in key:value format.
288 {
289 "value": "A String", # [Output Only] Metadata value for this warning.
290 "key": "A String", # [Output Only] Metadata key for this warning.
291 },
292 ],
293 },
294 ],
295 "user": "A String",
296 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]297 "kind": "replicapoolupdater#operation", # [Output Only] Type of the resource. Always replicapoolupdater#operation for Operation resources.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]298 "name": "A String", # [Output Only] Name of the resource.
299 "region": "A String", # [Output Only] URL of the region where the operation resides.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]300 "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
301 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
302 {
303 "message": "A String", # [Output Only] An optional, human-readable error message.
304 "code": "A String", # [Output Only] The error type identifier for this error.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]305 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]306 },
307 ],
308 },
309 "endTime": "A String",
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]310 "selfLink": "A String", # [Output Only] The fully qualified URL for the resource.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]311 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]312 }</pre>
313</div>
314
315<div class="method">
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]316 <code class="details" id="list">list(project, zone, maxResults=None, pageToken=None, filter=None)</code>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]317 <pre>Lists recent updates for a given managed instance group, in reverse chronological order and paginated format.
318
319Args:
320 project: string, The Google Developers Console project name. (required)
321 zone: string, The name of the zone in which the update's target resides. (required)
322 maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
323 pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]324 filter: string, Optional. Filter expression for filtering listed resources.
325
326Returns:
327 An object of the form:
328
329 { # Response returned by List method.
330 "nextPageToken": "A String", # A token used to continue a truncated list request.
331 "items": [ # Collection of requested updates.
332 { # The following represents a resource describing a single update (rollout) of a group of instances to the given template.
333 "status": "A String", # [Output Only] Status of the update. Possible values are:
334 # - "ROLLING_FORWARD": The update is going forward.
335 # - "ROLLING_BACK": The update is being rolled back.
336 # - "PAUSED": The update is temporarily paused (inactive).
337 # - "ROLLED_OUT": The update is finished, all instances have been updated successfully.
338 # - "ROLLED_BACK": The update is finished, all instances have been reverted to the previous template.
339 # - "CANCELLED": The update is paused and no longer can be resumed, undefined how many instances are running in which template.
340 "kind": "replicapoolupdater#rollingUpdate", # [Output Only] Type of the resource.
341 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
342 "user": "A String", # [Output Only] User who requested the update, for example: user@example.com.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]343 "instanceGroup": "A String", # Fully-qualified URL of an instance group being updated. Exactly one of instanceGroupManager and instanceGroup must be set.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]344 "instanceTemplate": "A String", # Fully-qualified URL of an instance template to apply.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]345 "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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]346 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the update.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]347 "error": { # [Output Only] Errors that occurred during the rolling update.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]348 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
349 {
350 "message": "A String", # [Output Only] An optional, human-readable error message.
351 "code": "A String", # [Output Only] The error type identifier for this error.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]352 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]353 },
354 ],
355 },
356 "policy": { # Parameters of the update process.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]357 "autoPauseAfterInstances": 42, # Number of instances to update before the updater pauses the rolling update.
358 "instanceStartupTimeoutSec": 42, # The maximum amount of time that the updater waits for a HEALTHY state after all of the update steps are complete. If the HEALTHY state is not received before the deadline, the instance update is considered a failure.
359 "maxNumConcurrentInstances": 42, # The maximum number of instances that can be updated simultaneously. An instance update is considered complete only after the instance is restarted and initialized.
360 "minInstanceUpdateTimeSec": 42, # The minimum amount of time that the updater spends to update each instance. Update time is the time it takes to complete all update actions (e.g. Stop call on Instance resource in Rolling Reboot), reboot, and initialize. If the instance update finishes early, the updater pauses for the remainder of the time before it starts the next instance update.
361 "maxNumFailedInstances": 42, # The maximum number of instance updates that can fail before the group update is considered a failure. An instance update is considered failed if any of its update actions (e.g. Stop call on Instance resource in Rolling Reboot) failed with permanent failure, or if the instance is in an UNHEALTHY state after it finishes all of the update actions.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]362 },
363 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]364 "oldInstanceTemplate": "A String", # Fully-qualified URL of the instance template encountered while starting the update.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]365 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
366 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
367 "selfLink": "A String", # [Output Only] The fully qualified URL for the resource.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]368 "instanceGroupManager": "A String", # Fully-qualified URL of an instance group manager being updated. Exactly one of instanceGroupManager and instanceGroup must be set.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]369 },
370 ],
371 "kind": "replicapoolupdater#rollingUpdateList", # [Output Only] Type of the resource.
372 "selfLink": "A String", # [Output Only] The fully qualified URL for the resource.
373 }</pre>
374</div>
375
376<div class="method">
377 <code class="details" id="listInstanceUpdates">listInstanceUpdates(project, zone, rollingUpdate, maxResults=None, pageToken=None, filter=None)</code>
378 <pre>Lists the current status for each instance within a given update.
379
380Args:
381 project: string, The Google Developers Console project name. (required)
382 zone: string, The name of the zone in which the update's target resides. (required)
383 rollingUpdate: string, The name of the update. (required)
384 maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
385 pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
386 filter: string, Optional. Filter expression for filtering listed resources.
387
388Returns:
389 An object of the form:
390
391 { # Response returned by ListInstanceUpdates method.
392 "nextPageToken": "A String", # A token used to continue a truncated list request.
393 "items": [ # Collection of requested instance updates.
394 { # Update of a single instance.
395 "status": "A String", # Status of the instance update. Possible values are:
396 # - "PENDING": The instance update is pending execution.
397 # - "ROLLING_FORWARD": The instance update is going forward.
398 # - "ROLLING_BACK": The instance update is being rolled back.
399 # - "PAUSED": The instance update is temporarily paused (inactive).
400 # - "ROLLED_OUT": The instance update is finished, the instance is running the new template.
401 # - "ROLLED_BACK": The instance update is finished, the instance has been reverted to the previous template.
402 # - "CANCELLED": The instance update is paused and no longer can be resumed, undefined in which template the instance is running.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]403 "instance": "A String", # Fully-qualified URL of the instance being updated.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]404 "error": { # Errors that occurred during the instance update.
405 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
406 {
407 "message": "A String", # [Output Only] An optional, human-readable error message.
408 "code": "A String", # [Output Only] The error type identifier for this error.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]409 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]410 },
411 ],
412 },
413 },
414 ],
415 "kind": "replicapoolupdater#instanceUpdateList", # [Output Only] Type of the resource.
416 "selfLink": "A String", # [Output Only] The fully qualified URL for the resource.
417 }</pre>
418</div>
419
420<div class="method">
421 <code class="details" id="listInstanceUpdates_next">listInstanceUpdates_next(previous_request, previous_response)</code>
422 <pre>Retrieves the next page of results.
423
424Args:
425 previous_request: The request for the previous page. (required)
426 previous_response: The response from the request for the previous page. (required)
427
428Returns:
429 A request object that you can call 'execute()' on to request the next
430 page. Returns None if there are no more items in the collection.
431 </pre>
432</div>
433
434<div class="method">
435 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
436 <pre>Retrieves the next page of results.
437
438Args:
439 previous_request: The request for the previous page. (required)
440 previous_response: The response from the request for the previous page. (required)
441
442Returns:
443 A request object that you can call 'execute()' on to request the next
444 page. Returns None if there are no more items in the collection.
445 </pre>
446</div>
447
448<div class="method">
449 <code class="details" id="pause">pause(project, zone, rollingUpdate)</code>
450 <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.
451
452Args:
453 project: string, The Google Developers Console project name. (required)
454 zone: string, The name of the zone in which the update's target resides. (required)
455 rollingUpdate: string, The name of the update. (required)
456
457Returns:
458 An object of the form:
459
460 { # An operation resource, used to manage asynchronous API requests.
461 "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
462 "clientOperationId": "A String",
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]463 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]464 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]465 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]466 "operationType": "A String",
467 "httpErrorMessage": "A String",
468 "progress": 42,
469 "httpErrorStatusCode": 42,
470 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
471 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
472 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
473 "warnings": [
474 {
475 "message": "A String", # [Output only] Optional human-readable details for this warning.
476 "code": "A String", # [Output only] The warning type identifier for this warning.
477 "data": [ # [Output only] Metadata for this warning in key:value format.
478 {
479 "value": "A String", # [Output Only] Metadata value for this warning.
480 "key": "A String", # [Output Only] Metadata key for this warning.
481 },
482 ],
483 },
484 ],
485 "user": "A String",
486 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]487 "kind": "replicapoolupdater#operation", # [Output Only] Type of the resource. Always replicapoolupdater#operation for Operation resources.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]488 "name": "A String", # [Output Only] Name of the resource.
489 "region": "A String", # [Output Only] URL of the region where the operation resides.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]490 "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
491 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
492 {
493 "message": "A String", # [Output Only] An optional, human-readable error message.
494 "code": "A String", # [Output Only] The error type identifier for this error.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]495 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]496 },
497 ],
498 },
499 "endTime": "A String",
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]500 "selfLink": "A String", # [Output Only] The fully qualified URL for the resource.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]501 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]502 }</pre>
503</div>
504
505<div class="method">
506 <code class="details" id="resume">resume(project, zone, rollingUpdate)</code>
507 <pre>Continues an update in PAUSED state. Has no effect if invoked when the state of the update is ROLLED_OUT.
508
509Args:
510 project: string, The Google Developers Console project name. (required)
511 zone: string, The name of the zone in which the update's target resides. (required)
512 rollingUpdate: string, The name of the update. (required)
513
514Returns:
515 An object of the form:
516
517 { # An operation resource, used to manage asynchronous API requests.
518 "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
519 "clientOperationId": "A String",
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]520 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]521 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]522 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]523 "operationType": "A String",
524 "httpErrorMessage": "A String",
525 "progress": 42,
526 "httpErrorStatusCode": 42,
527 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
528 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
529 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
530 "warnings": [
531 {
532 "message": "A String", # [Output only] Optional human-readable details for this warning.
533 "code": "A String", # [Output only] The warning type identifier for this warning.
534 "data": [ # [Output only] Metadata for this warning in key:value format.
535 {
536 "value": "A String", # [Output Only] Metadata value for this warning.
537 "key": "A String", # [Output Only] Metadata key for this warning.
538 },
539 ],
540 },
541 ],
542 "user": "A String",
543 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]544 "kind": "replicapoolupdater#operation", # [Output Only] Type of the resource. Always replicapoolupdater#operation for Operation resources.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]545 "name": "A String", # [Output Only] Name of the resource.
546 "region": "A String", # [Output Only] URL of the region where the operation resides.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]547 "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
548 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
549 {
550 "message": "A String", # [Output Only] An optional, human-readable error message.
551 "code": "A String", # [Output Only] The error type identifier for this error.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]552 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]553 },
554 ],
555 },
556 "endTime": "A String",
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]557 "selfLink": "A String", # [Output Only] The fully qualified URL for the resource.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]558 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]559 }</pre>
560</div>
561
562<div class="method">
563 <code class="details" id="rollback">rollback(project, zone, rollingUpdate)</code>
564 <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.
565
566Args:
567 project: string, The Google Developers Console project name. (required)
568 zone: string, The name of the zone in which the update's target resides. (required)
569 rollingUpdate: string, The name of the update. (required)
570
571Returns:
572 An object of the form:
573
574 { # An operation resource, used to manage asynchronous API requests.
575 "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
576 "clientOperationId": "A String",
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]577 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]578 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]579 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]580 "operationType": "A String",
581 "httpErrorMessage": "A String",
582 "progress": 42,
583 "httpErrorStatusCode": 42,
584 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
585 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
586 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
587 "warnings": [
588 {
589 "message": "A String", # [Output only] Optional human-readable details for this warning.
590 "code": "A String", # [Output only] The warning type identifier for this warning.
591 "data": [ # [Output only] Metadata for this warning in key:value format.
592 {
593 "value": "A String", # [Output Only] Metadata value for this warning.
594 "key": "A String", # [Output Only] Metadata key for this warning.
595 },
596 ],
597 },
598 ],
599 "user": "A String",
600 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]601 "kind": "replicapoolupdater#operation", # [Output Only] Type of the resource. Always replicapoolupdater#operation for Operation resources.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]602 "name": "A String", # [Output Only] Name of the resource.
603 "region": "A String", # [Output Only] URL of the region where the operation resides.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]604 "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
605 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
606 {
607 "message": "A String", # [Output Only] An optional, human-readable error message.
608 "code": "A String", # [Output Only] The error type identifier for this error.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]609 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]610 },
611 ],
612 },
613 "endTime": "A String",
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]614 "selfLink": "A String", # [Output Only] The fully qualified URL for the resource.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]615 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]616 }</pre>
617</div>
618
619</body></html>