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