Debian Codegraph @

docs/dyn/compute_beta.rolloutPlans.html

raw
1 <html><body>
2 <style>
3
4 body, 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
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, 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="compute_beta.html">Compute Engine API</a> . <a href="compute_beta.rolloutPlans.html">rolloutPlans</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#delete">delete(project, rolloutPlan, requestId=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Deletes a RolloutPlan.</p>
83 <p class="toc_element">
84 <code><a href="#get">get(project, rolloutPlan, x__xgafv=None)</a></code></p>
85 <p class="firstline">Gets details of a single project-scoped RolloutPlan.</p>
86 <p class="toc_element">
87 <code><a href="#insert">insert(project, body=None, requestId=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Creates a new RolloutPlan in a given project and location.</p>
89 <p class="toc_element">
90 <code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Lists RolloutPlans in a given project and location.</p>
92 <p class="toc_element">
93 <code><a href="#list_next">list_next()</a></code></p>
94 <p class="firstline">Retrieves the next page of results.</p>
95 <h3>Method Details</h3>
96 <div class="method">
97 <code class="details" id="close">close()</code>
98 <pre>Close httplib2 connections.</pre>
99 </div>
100
101 <div class="method">
102 <code class="details" id="delete">delete(project, rolloutPlan, requestId=None, x__xgafv=None)</code>
103 <pre>Deletes a RolloutPlan.
104
105 Args:
106 project: string, Project ID for this request. (required)
107 rolloutPlan: string, Name of the RolloutPlan resource to delete. (required)
108 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
109 that if you must retry your request, the server will know to ignore the
110 request if it has already been completed.
111
112 For example, consider a situation where you make an initial request and
113 the request times out. If you make the request again with the same
114 request ID, the server can check if original operation with the same
115 request ID was received, and if so, will ignore the second request. This
116 prevents clients from accidentally creating duplicate commitments.
117
118 The request ID must be
119 a valid UUID with the exception that zero UUID is not supported
120 (00000000-0000-0000-0000-000000000000).
121 x__xgafv: string, V1 error format.
122 Allowed values
123 1 - v1 error format
124 2 - v2 error format
125
126 Returns:
127 An object of the form:
128
129 { # Represents an Operation resource.
130 #
131 # Google Compute Engine has three Operation resources:
132 #
133 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
134 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
135 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
136 #
137 # You can use an operation resource to manage asynchronous API requests.
138 # For more information, readHandling
139 # API responses.
140 #
141 # Operations can be global, regional or zonal.
142 #
143 # - For global operations, use the `globalOperations`
144 # resource.
145 # - For regional operations, use the
146 # `regionOperations` resource.
147 # - For zonal operations, use
148 # the `zoneOperations` resource.
149 #
150 #
151 #
152 # For more information, read
153 # Global, Regional, and Zonal Resources.
154 #
155 # Note that completed Operation resources have a limited
156 # retention period.
157 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
158 # Not present otherwise.
159 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
160 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
161 # set when the operation is created.
162 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
163 # text format.
164 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
165 # this field will be populated.
166 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
167 # operation.
168 {
169 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
170 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
171 # details. There is a set of defined message types to use for providing
172 # details.The syntax depends on the error code. For example,
173 # QuotaExceededInfo will have details when the error code is
174 # QUOTA_EXCEEDED.
175 {
176 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
177 #
178 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
179 # is not enabled:
180 #
181 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
182 # &quot;domain&quot;: &quot;googleapis.com&quot;
183 # &quot;metadata&quot;: {
184 # &quot;resource&quot;: &quot;projects/123&quot;,
185 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
186 # }
187 # }
188 #
189 # This response indicates that the pubsub.googleapis.com API is not enabled.
190 #
191 # Example of an error that is returned when attempting to create a Spanner
192 # instance in a region that is out of stock:
193 #
194 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
195 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
196 # &quot;metadata&quot;: {
197 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
198 # }
199 # }
200 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
201 # is typically the registered service name of the tool or product that
202 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
203 # generated by some common infrastructure, the error domain must be a
204 # globally unique value that identifies the infrastructure. For Google API
205 # infrastructure, the error domain is &quot;googleapis.com&quot;.
206 &quot;metadatas&quot;: { # Additional structured details about this error.
207 #
208 # Keys must match a regular expression of `a-z+` but should
209 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
210 # length. When identifying the current value of an exceeded limit, the units
211 # should be contained in the key, not the value. For example, rather than
212 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
213 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
214 # instances that can be created in a single (batch) request.
215 &quot;a_key&quot;: &quot;A String&quot;,
216 },
217 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
218 # proximate cause of the error. Error reasons are unique within a particular
219 # domain of errors. This should be at most 63 characters and match a
220 # regular expression of `A-Z+[A-Z0-9]`, which represents
221 # UPPER_SNAKE_CASE.
222 },
223 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
224 #
225 # For example, if a quota check failed with an error indicating the calling
226 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
227 # directly to the right place in the developer console to flip the bit.
228 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
229 { # Describes a URL link.
230 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
231 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
232 },
233 ],
234 },
235 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
236 # which can be attached to an RPC error.
237 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
238 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
239 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
240 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
241 },
242 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
243 &quot;dimensions&quot;: { # The map holding related quota dimensions.
244 &quot;a_key&quot;: &quot;A String&quot;,
245 },
246 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
247 # type or metric.
248 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
249 # or metric.
250 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
251 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
252 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
253 },
254 },
255 ],
256 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
257 # This property is optional.
258 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
259 },
260 ],
261 },
262 &quot;getVersionOperationMetadata&quot;: {
263 &quot;inlineSbomInfo&quot;: {
264 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
265 # appropriate identifiers.
266 &quot;a_key&quot;: &quot;A String&quot;,
267 },
268 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
269 # identifiers.
270 &quot;a_key&quot;: &quot;A String&quot;,
271 },
272 },
273 },
274 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
275 # message that was returned, such as `NOT FOUND`.
276 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
277 # status code that was returned. For example, a `404` means the
278 # resource was not found.
279 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
280 # defined by the server.
281 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
282 # This value is inRFC3339
283 # text format.
284 &quot;instancesBulkInsertOperationMetadata&quot;: {
285 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
286 # Example key: zones/us-central1-a
287 &quot;a_key&quot;: {
288 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
289 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
290 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
291 # error.
292 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
293 # if the flow is rolling forward or rolling back.
294 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
295 },
296 },
297 },
298 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
299 # Operation resources.
300 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
301 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
302 # group of operations results from a `bulkInsert` API request.
303 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
304 # `update`, or `delete`, and so on.
305 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
306 # There is no requirement that this be linear or support any granularity of
307 # operations. This should not be used to guess when the operation will be
308 # complete. This number should monotonically increase as the operation
309 # progresses.
310 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
311 # applicable when performing regional operations.
312 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
313 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
314 # this field will contain information on all underlying zonal actions and
315 # their state.
316 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
317 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
318 # Example key: zones/us-central1-a
319 &quot;a_key&quot;: {
320 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
321 # populated.
322 # different programming environments, including REST APIs and RPC APIs. It is
323 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
324 # three pieces of data: error code, error message, and error details.
325 #
326 # You can find out more about this error model and how to work with it in the
327 # [API Design Guide](https://cloud.google.com/apis/design/errors).
328 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
329 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
330 # message types for APIs to use.
331 {
332 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
333 },
334 ],
335 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
336 # user-facing error message should be localized and sent in the
337 # google.rpc.Status.details field, or localized by the client.
338 },
339 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
340 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
341 },
342 },
343 },
344 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
345 # This value is inRFC3339
346 # text format.
347 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
348 # following:
349 # `PENDING`, `RUNNING`, or `DONE`.
350 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
351 # operation.
352 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
353 # of the target resource.
354 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
355 # operations related to creating a snapshot, this points to the disk
356 # that the snapshot was created from.
357 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
358 # `[email protected]` or
359 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
360 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
361 # operation, this field will be populated.
362 {
363 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
364 # Engine returns NO_RESULTS_ON_PAGE if there
365 # are no results in the response.
366 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
367 # value format. For example:
368 #
369 # &quot;data&quot;: [
370 # {
371 # &quot;key&quot;: &quot;scope&quot;,
372 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
373 # }
374 {
375 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
376 # returned. For example, for warnings where there are no results in a list
377 # request for a particular zone, this key might be scope and
378 # the key value might be the zone name. Other examples might be a key
379 # indicating a deprecated resource and a suggested replacement, or a
380 # warning about invalid network settings (for example, if an instance
381 # attempts to perform IP forwarding but is not enabled for IP forwarding).
382 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
383 },
384 ],
385 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
386 },
387 ],
388 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
389 # applicable when performing per-zone operations.
390 }</pre>
391 </div>
392
393 <div class="method">
394 <code class="details" id="get">get(project, rolloutPlan, x__xgafv=None)</code>
395 <pre>Gets details of a single project-scoped RolloutPlan.
396
397 Args:
398 project: string, Project ID for this request. (required)
399 rolloutPlan: string, Name of the persistent rollout plan to return. (required)
400 x__xgafv: string, V1 error format.
401 Allowed values
402 1 - v1 error format
403 2 - v2 error format
404
405 Returns:
406 An object of the form:
407
408 { # RolloutPlan resource.
409 #
410 # A RolloutPlan is the customer-defined strategy to divide a large-scale change
411 # into smaller increments, referred to as &quot;waves&quot;. Each wave targets a specific
412 # portion of the overall affected area and defines criteria that must be met
413 # before progressing to the subsequent wave.
414 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
415 # text format.
416 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
417 # create the resource.
418 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
419 # defined by the server.
420 &quot;kind&quot;: &quot;compute#rolloutPlan&quot;, # Output only. [Output Only] Type of the resource. Always compute#rolloutPlan
421 # for rolloutPlans.
422 &quot;locationScope&quot;: &quot;A String&quot;, # The location scope of the rollout plan. If not specified, the location
423 # scope is considered as ZONAL.
424 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
425 # The name must be 1-63 characters long, and comply withRFC1035.
426 # Specifically, the name must be 1-63 characters long and match the regular
427 # expression `[a-z]([-a-z0-9]*[a-z0-9])?`
428 # which means the first character must be a lowercase letter, and all
429 # following characters must be a dash, lowercase letter, or digit, except
430 # the last character, which cannot be a dash.
431 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
432 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource&#x27;s resource id.
433 &quot;waves&quot;: [ # Required. The waves included in this rollout plan.
434 { # A single wave in a rollout plan.
435 &quot;displayName&quot;: &quot;A String&quot;, # Optional. The display name of this wave of the rollout plan.
436 &quot;number&quot;: &quot;A String&quot;, # Output only. The wave number.
437 &quot;orchestrationOptions&quot;: { # Options to control the pace of orchestration of a wave. These options are # Optional. The orchestration options for this wave.
438 # required only if the resource being rolled out follows the Orchestrated
439 # pattern.
440 &quot;delays&quot;: [ # Optional. Delays, if any, to be added between batches of projects. We allow
441 # multiple Delays to be specified, letting users set separate delays
442 # between batches of projects corresponding to different locations and
443 # batches of projects corresponding to the same location.
444 { # Options to control the delay, if any, between batches of projects.
445 &quot;delimiter&quot;: &quot;A String&quot;, # Optional. Controls whether the delay should only be added between batches of
446 # projects corresponding to different locations, or also between
447 # batches of projects corresponding to the same location.
448 #
449 # Must be set to DELIMITER_UNSPECIFIED if no delay is to be added.
450 &quot;duration&quot;: &quot;A String&quot;, # Optional. The duration of the delay, if any, to be added between batches of
451 # projects. A zero duration corresponds to no delay.
452 &quot;type&quot;: &quot;A String&quot;, # Optional. Controls whether the specified duration is to be added at the end of
453 # each batch, or if the total processing time for each batch will be
454 # padded if needed to meet the specified duration.
455 #
456 # Must be set to TYPE_UNSPECIFIED if no delay is to be added.
457 },
458 ],
459 &quot;maxConcurrentLocations&quot;: &quot;A String&quot;, # Optional. Maximum number of locations to be orchestrated in parallel.
460 &quot;maxConcurrentResourcesPerLocation&quot;: &quot;A String&quot;, # Optional. Maximum number of resources to be orchestrated per location in
461 # parallel.
462 },
463 &quot;selectors&quot;: [ # Required. The selectors for this wave. There is a logical AND between each selector
464 # defined in a wave, so a resource must satisfy the criteria of *all* the
465 # specified selectors to be in scope for the wave.
466 { # A selector which specifies what resource(s) are included in a given wave.
467 &quot;locationSelector&quot;: { # Roll out to resources by location. # Optional. Roll out to resources by Cloud locations.
468 &quot;includedLocations&quot;: [ # Optional. Example: &quot;us-central1-a&quot;
469 &quot;A String&quot;,
470 ],
471 },
472 &quot;resourceHierarchySelector&quot;: { # Roll out to resources by Cloud Resource Manager resource hierarchy # Optional. Roll out to resources by Cloud Resource Manager resource hierarchy.
473 # nodes such as projects, folders, orgs.
474 &quot;includedFolders&quot;: [ # Optional. Format: &quot;folders/{folder_id}&quot;
475 &quot;A String&quot;,
476 ],
477 &quot;includedOrganizations&quot;: [ # Optional. Format: &quot;organizations/{organization_id}&quot;
478 &quot;A String&quot;,
479 ],
480 &quot;includedProjects&quot;: [ # Optional. Format: &quot;projects/{project_id}&quot;
481 &quot;A String&quot;,
482 ],
483 },
484 },
485 ],
486 &quot;validation&quot;: { # The validation to be performed before progressing to the next wave. # Required. The validation to be performed at the end of this wave.
487 &quot;timeBasedValidationMetadata&quot;: { # Metadata required if type = &quot;time&quot;. # Optional. Metadata required if type = &quot;time&quot;.
488 &quot;waitDuration&quot;: &quot;A String&quot;, # Optional. The duration that the system waits in between waves. This wait starts
489 # after all changes in the wave are rolled out.
490 },
491 &quot;type&quot;: &quot;A String&quot;, # Required. The type of the validation. If a type of validation is associated with
492 # a metadata object, the appropriate metadata field mapping to the
493 # validation type must be provided in the validation message. Possible
494 # values are in quotes below alongside an explanation:
495 # &quot;manual&quot;: The system waits for an end-user approval API before
496 # progressing to the next wave.
497 # &quot;time&quot;: The system waits for a user specified duration before
498 # progressing to the next wave. TimeBasedValidation must be provided.
499 },
500 },
501 ],
502 }</pre>
503 </div>
504
505 <div class="method">
506 <code class="details" id="insert">insert(project, body=None, requestId=None, x__xgafv=None)</code>
507 <pre>Creates a new RolloutPlan in a given project and location.
508
509 Args:
510 project: string, Project ID for this request. (required)
511 body: object, The request body.
512 The object takes the form of:
513
514 { # RolloutPlan resource.
515 #
516 # A RolloutPlan is the customer-defined strategy to divide a large-scale change
517 # into smaller increments, referred to as &quot;waves&quot;. Each wave targets a specific
518 # portion of the overall affected area and defines criteria that must be met
519 # before progressing to the subsequent wave.
520 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
521 # text format.
522 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
523 # create the resource.
524 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
525 # defined by the server.
526 &quot;kind&quot;: &quot;compute#rolloutPlan&quot;, # Output only. [Output Only] Type of the resource. Always compute#rolloutPlan
527 # for rolloutPlans.
528 &quot;locationScope&quot;: &quot;A String&quot;, # The location scope of the rollout plan. If not specified, the location
529 # scope is considered as ZONAL.
530 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
531 # The name must be 1-63 characters long, and comply withRFC1035.
532 # Specifically, the name must be 1-63 characters long and match the regular
533 # expression `[a-z]([-a-z0-9]*[a-z0-9])?`
534 # which means the first character must be a lowercase letter, and all
535 # following characters must be a dash, lowercase letter, or digit, except
536 # the last character, which cannot be a dash.
537 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
538 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource&#x27;s resource id.
539 &quot;waves&quot;: [ # Required. The waves included in this rollout plan.
540 { # A single wave in a rollout plan.
541 &quot;displayName&quot;: &quot;A String&quot;, # Optional. The display name of this wave of the rollout plan.
542 &quot;number&quot;: &quot;A String&quot;, # Output only. The wave number.
543 &quot;orchestrationOptions&quot;: { # Options to control the pace of orchestration of a wave. These options are # Optional. The orchestration options for this wave.
544 # required only if the resource being rolled out follows the Orchestrated
545 # pattern.
546 &quot;delays&quot;: [ # Optional. Delays, if any, to be added between batches of projects. We allow
547 # multiple Delays to be specified, letting users set separate delays
548 # between batches of projects corresponding to different locations and
549 # batches of projects corresponding to the same location.
550 { # Options to control the delay, if any, between batches of projects.
551 &quot;delimiter&quot;: &quot;A String&quot;, # Optional. Controls whether the delay should only be added between batches of
552 # projects corresponding to different locations, or also between
553 # batches of projects corresponding to the same location.
554 #
555 # Must be set to DELIMITER_UNSPECIFIED if no delay is to be added.
556 &quot;duration&quot;: &quot;A String&quot;, # Optional. The duration of the delay, if any, to be added between batches of
557 # projects. A zero duration corresponds to no delay.
558 &quot;type&quot;: &quot;A String&quot;, # Optional. Controls whether the specified duration is to be added at the end of
559 # each batch, or if the total processing time for each batch will be
560 # padded if needed to meet the specified duration.
561 #
562 # Must be set to TYPE_UNSPECIFIED if no delay is to be added.
563 },
564 ],
565 &quot;maxConcurrentLocations&quot;: &quot;A String&quot;, # Optional. Maximum number of locations to be orchestrated in parallel.
566 &quot;maxConcurrentResourcesPerLocation&quot;: &quot;A String&quot;, # Optional. Maximum number of resources to be orchestrated per location in
567 # parallel.
568 },
569 &quot;selectors&quot;: [ # Required. The selectors for this wave. There is a logical AND between each selector
570 # defined in a wave, so a resource must satisfy the criteria of *all* the
571 # specified selectors to be in scope for the wave.
572 { # A selector which specifies what resource(s) are included in a given wave.
573 &quot;locationSelector&quot;: { # Roll out to resources by location. # Optional. Roll out to resources by Cloud locations.
574 &quot;includedLocations&quot;: [ # Optional. Example: &quot;us-central1-a&quot;
575 &quot;A String&quot;,
576 ],
577 },
578 &quot;resourceHierarchySelector&quot;: { # Roll out to resources by Cloud Resource Manager resource hierarchy # Optional. Roll out to resources by Cloud Resource Manager resource hierarchy.
579 # nodes such as projects, folders, orgs.
580 &quot;includedFolders&quot;: [ # Optional. Format: &quot;folders/{folder_id}&quot;
581 &quot;A String&quot;,
582 ],
583 &quot;includedOrganizations&quot;: [ # Optional. Format: &quot;organizations/{organization_id}&quot;
584 &quot;A String&quot;,
585 ],
586 &quot;includedProjects&quot;: [ # Optional. Format: &quot;projects/{project_id}&quot;
587 &quot;A String&quot;,
588 ],
589 },
590 },
591 ],
592 &quot;validation&quot;: { # The validation to be performed before progressing to the next wave. # Required. The validation to be performed at the end of this wave.
593 &quot;timeBasedValidationMetadata&quot;: { # Metadata required if type = &quot;time&quot;. # Optional. Metadata required if type = &quot;time&quot;.
594 &quot;waitDuration&quot;: &quot;A String&quot;, # Optional. The duration that the system waits in between waves. This wait starts
595 # after all changes in the wave are rolled out.
596 },
597 &quot;type&quot;: &quot;A String&quot;, # Required. The type of the validation. If a type of validation is associated with
598 # a metadata object, the appropriate metadata field mapping to the
599 # validation type must be provided in the validation message. Possible
600 # values are in quotes below alongside an explanation:
601 # &quot;manual&quot;: The system waits for an end-user approval API before
602 # progressing to the next wave.
603 # &quot;time&quot;: The system waits for a user specified duration before
604 # progressing to the next wave. TimeBasedValidation must be provided.
605 },
606 },
607 ],
608 }
609
610 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
611 that if you must retry your request, the server will know to ignore the
612 request if it has already been completed.
613
614 For example, consider a situation where you make an initial request and
615 the request times out. If you make the request again with the same
616 request ID, the server can check if original operation with the same
617 request ID was received, and if so, will ignore the second request. This
618 prevents clients from accidentally creating duplicate commitments.
619
620 The request ID must be
621 a valid UUID with the exception that zero UUID is not supported
622 (00000000-0000-0000-0000-000000000000).
623 x__xgafv: string, V1 error format.
624 Allowed values
625 1 - v1 error format
626 2 - v2 error format
627
628 Returns:
629 An object of the form:
630
631 { # Represents an Operation resource.
632 #
633 # Google Compute Engine has three Operation resources:
634 #
635 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
636 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
637 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
638 #
639 # You can use an operation resource to manage asynchronous API requests.
640 # For more information, readHandling
641 # API responses.
642 #
643 # Operations can be global, regional or zonal.
644 #
645 # - For global operations, use the `globalOperations`
646 # resource.
647 # - For regional operations, use the
648 # `regionOperations` resource.
649 # - For zonal operations, use
650 # the `zoneOperations` resource.
651 #
652 #
653 #
654 # For more information, read
655 # Global, Regional, and Zonal Resources.
656 #
657 # Note that completed Operation resources have a limited
658 # retention period.
659 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
660 # Not present otherwise.
661 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
662 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
663 # set when the operation is created.
664 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
665 # text format.
666 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
667 # this field will be populated.
668 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
669 # operation.
670 {
671 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
672 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
673 # details. There is a set of defined message types to use for providing
674 # details.The syntax depends on the error code. For example,
675 # QuotaExceededInfo will have details when the error code is
676 # QUOTA_EXCEEDED.
677 {
678 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
679 #
680 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
681 # is not enabled:
682 #
683 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
684 # &quot;domain&quot;: &quot;googleapis.com&quot;
685 # &quot;metadata&quot;: {
686 # &quot;resource&quot;: &quot;projects/123&quot;,
687 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
688 # }
689 # }
690 #
691 # This response indicates that the pubsub.googleapis.com API is not enabled.
692 #
693 # Example of an error that is returned when attempting to create a Spanner
694 # instance in a region that is out of stock:
695 #
696 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
697 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
698 # &quot;metadata&quot;: {
699 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
700 # }
701 # }
702 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
703 # is typically the registered service name of the tool or product that
704 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
705 # generated by some common infrastructure, the error domain must be a
706 # globally unique value that identifies the infrastructure. For Google API
707 # infrastructure, the error domain is &quot;googleapis.com&quot;.
708 &quot;metadatas&quot;: { # Additional structured details about this error.
709 #
710 # Keys must match a regular expression of `a-z+` but should
711 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
712 # length. When identifying the current value of an exceeded limit, the units
713 # should be contained in the key, not the value. For example, rather than
714 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
715 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
716 # instances that can be created in a single (batch) request.
717 &quot;a_key&quot;: &quot;A String&quot;,
718 },
719 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
720 # proximate cause of the error. Error reasons are unique within a particular
721 # domain of errors. This should be at most 63 characters and match a
722 # regular expression of `A-Z+[A-Z0-9]`, which represents
723 # UPPER_SNAKE_CASE.
724 },
725 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
726 #
727 # For example, if a quota check failed with an error indicating the calling
728 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
729 # directly to the right place in the developer console to flip the bit.
730 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
731 { # Describes a URL link.
732 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
733 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
734 },
735 ],
736 },
737 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
738 # which can be attached to an RPC error.
739 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
740 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
741 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
742 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
743 },
744 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
745 &quot;dimensions&quot;: { # The map holding related quota dimensions.
746 &quot;a_key&quot;: &quot;A String&quot;,
747 },
748 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
749 # type or metric.
750 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
751 # or metric.
752 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
753 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
754 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
755 },
756 },
757 ],
758 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
759 # This property is optional.
760 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
761 },
762 ],
763 },
764 &quot;getVersionOperationMetadata&quot;: {
765 &quot;inlineSbomInfo&quot;: {
766 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
767 # appropriate identifiers.
768 &quot;a_key&quot;: &quot;A String&quot;,
769 },
770 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
771 # identifiers.
772 &quot;a_key&quot;: &quot;A String&quot;,
773 },
774 },
775 },
776 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
777 # message that was returned, such as `NOT FOUND`.
778 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
779 # status code that was returned. For example, a `404` means the
780 # resource was not found.
781 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
782 # defined by the server.
783 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
784 # This value is inRFC3339
785 # text format.
786 &quot;instancesBulkInsertOperationMetadata&quot;: {
787 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
788 # Example key: zones/us-central1-a
789 &quot;a_key&quot;: {
790 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
791 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
792 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
793 # error.
794 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
795 # if the flow is rolling forward or rolling back.
796 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
797 },
798 },
799 },
800 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
801 # Operation resources.
802 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
803 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
804 # group of operations results from a `bulkInsert` API request.
805 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
806 # `update`, or `delete`, and so on.
807 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
808 # There is no requirement that this be linear or support any granularity of
809 # operations. This should not be used to guess when the operation will be
810 # complete. This number should monotonically increase as the operation
811 # progresses.
812 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
813 # applicable when performing regional operations.
814 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
815 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
816 # this field will contain information on all underlying zonal actions and
817 # their state.
818 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
819 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
820 # Example key: zones/us-central1-a
821 &quot;a_key&quot;: {
822 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
823 # populated.
824 # different programming environments, including REST APIs and RPC APIs. It is
825 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
826 # three pieces of data: error code, error message, and error details.
827 #
828 # You can find out more about this error model and how to work with it in the
829 # [API Design Guide](https://cloud.google.com/apis/design/errors).
830 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
831 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
832 # message types for APIs to use.
833 {
834 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
835 },
836 ],
837 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
838 # user-facing error message should be localized and sent in the
839 # google.rpc.Status.details field, or localized by the client.
840 },
841 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
842 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
843 },
844 },
845 },
846 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
847 # This value is inRFC3339
848 # text format.
849 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
850 # following:
851 # `PENDING`, `RUNNING`, or `DONE`.
852 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
853 # operation.
854 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
855 # of the target resource.
856 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
857 # operations related to creating a snapshot, this points to the disk
858 # that the snapshot was created from.
859 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
860 # `[email protected]` or
861 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
862 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
863 # operation, this field will be populated.
864 {
865 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
866 # Engine returns NO_RESULTS_ON_PAGE if there
867 # are no results in the response.
868 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
869 # value format. For example:
870 #
871 # &quot;data&quot;: [
872 # {
873 # &quot;key&quot;: &quot;scope&quot;,
874 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
875 # }
876 {
877 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
878 # returned. For example, for warnings where there are no results in a list
879 # request for a particular zone, this key might be scope and
880 # the key value might be the zone name. Other examples might be a key
881 # indicating a deprecated resource and a suggested replacement, or a
882 # warning about invalid network settings (for example, if an instance
883 # attempts to perform IP forwarding but is not enabled for IP forwarding).
884 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
885 },
886 ],
887 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
888 },
889 ],
890 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
891 # applicable when performing per-zone operations.
892 }</pre>
893 </div>
894
895 <div class="method">
896 <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
897 <pre>Lists RolloutPlans in a given project and location.
898
899 Args:
900 project: string, Project ID for this request. (required)
901 filter: string, A filter expression that filters resources listed in the response. Most
902 Compute resources support two types of filter expressions:
903 expressions that support regular expressions and expressions that follow
904 API improvement proposal AIP-160.
905 These two types of filter expressions cannot be mixed in one request.
906
907 If you want to use AIP-160, your expression must specify the field name, an
908 operator, and the value that you want to use for filtering. The value
909 must be a string, a number, or a boolean. The operator
910 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
911
912 For example, if you are filtering Compute Engine instances, you can
913 exclude instances named `example-instance` by specifying
914 `name != example-instance`.
915
916 The `:*` comparison can be used to test whether a key has been defined.
917 For example, to find all objects with `owner` label use:
918 ```
919 labels.owner:*
920 ```
921
922 You can also filter nested fields. For example, you could specify
923 `scheduling.automaticRestart = false` to include instances only
924 if they are not scheduled for automatic restarts. You can use filtering
925 on nested fields to filter based onresource labels.
926
927 To filter on multiple expressions, provide each separate expression within
928 parentheses. For example:
929 ```
930 (scheduling.automaticRestart = true)
931 (cpuPlatform = &quot;Intel Skylake&quot;)
932 ```
933 By default, each expression is an `AND` expression. However, you
934 can include `AND` and `OR` expressions explicitly.
935 For example:
936 ```
937 (cpuPlatform = &quot;Intel Skylake&quot;) OR
938 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
939 (scheduling.automaticRestart = true)
940 ```
941
942 If you want to use a regular expression, use the `eq` (equal) or `ne`
943 (not equal) operator against a single un-parenthesized expression with or
944 without quotes or against multiple parenthesized expressions. Examples:
945
946 `fieldname eq unquoted literal`
947 `fieldname eq &#x27;single quoted literal&#x27;`
948 `fieldname eq &quot;double quoted literal&quot;`
949 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
950
951 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
952 The literal value must match the entire field.
953
954 For example, to filter for instances that do not end with name &quot;instance&quot;,
955 you would use `name ne .*instance`.
956
957 You cannot combine constraints on multiple fields using regular
958 expressions.
959 maxResults: integer, The maximum number of results per page that should be returned.
960 If the number of available results is larger than `maxResults`,
961 Compute Engine returns a `nextPageToken` that can be used to get
962 the next page of results in subsequent list requests. Acceptable values are
963 `0` to `500`, inclusive. (Default: `500`)
964 orderBy: string, Sorts list results by a certain order. By default, results
965 are returned in alphanumerical order based on the resource name.
966
967 You can also sort results in descending order based on the creation
968 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
969 results based on the `creationTimestamp` field in
970 reverse chronological order (newest result first). Use this to sort
971 resources like operations so that the newest operation is returned first.
972
973 Currently, only sorting by `name` or
974 `creationTimestamp desc` is supported.
975 pageToken: string, Specifies a page token to use. Set `pageToken` to the
976 `nextPageToken` returned by a previous list request to get
977 the next page of results.
978 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
979 of failure. The default value is false.
980
981 For example, when partial success behavior is enabled, aggregatedList for a
982 single zone scope either returns all resources in the zone or no resources,
983 with an error code.
984 x__xgafv: string, V1 error format.
985 Allowed values
986 1 - v1 error format
987 2 - v2 error format
988
989 Returns:
990 An object of the form:
991
992 { # Contains a list of RolloutPlan resources.
993 &quot;etag&quot;: &quot;A String&quot;,
994 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
995 &quot;items&quot;: [ # A list of RolloutPlan resources.
996 { # RolloutPlan resource.
997 #
998 # A RolloutPlan is the customer-defined strategy to divide a large-scale change
999 # into smaller increments, referred to as &quot;waves&quot;. Each wave targets a specific
1000 # portion of the overall affected area and defines criteria that must be met
1001 # before progressing to the subsequent wave.
1002 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1003 # text format.
1004 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
1005 # create the resource.
1006 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
1007 # defined by the server.
1008 &quot;kind&quot;: &quot;compute#rolloutPlan&quot;, # Output only. [Output Only] Type of the resource. Always compute#rolloutPlan
1009 # for rolloutPlans.
1010 &quot;locationScope&quot;: &quot;A String&quot;, # The location scope of the rollout plan. If not specified, the location
1011 # scope is considered as ZONAL.
1012 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
1013 # The name must be 1-63 characters long, and comply withRFC1035.
1014 # Specifically, the name must be 1-63 characters long and match the regular
1015 # expression `[a-z]([-a-z0-9]*[a-z0-9])?`
1016 # which means the first character must be a lowercase letter, and all
1017 # following characters must be a dash, lowercase letter, or digit, except
1018 # the last character, which cannot be a dash.
1019 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
1020 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource&#x27;s resource id.
1021 &quot;waves&quot;: [ # Required. The waves included in this rollout plan.
1022 { # A single wave in a rollout plan.
1023 &quot;displayName&quot;: &quot;A String&quot;, # Optional. The display name of this wave of the rollout plan.
1024 &quot;number&quot;: &quot;A String&quot;, # Output only. The wave number.
1025 &quot;orchestrationOptions&quot;: { # Options to control the pace of orchestration of a wave. These options are # Optional. The orchestration options for this wave.
1026 # required only if the resource being rolled out follows the Orchestrated
1027 # pattern.
1028 &quot;delays&quot;: [ # Optional. Delays, if any, to be added between batches of projects. We allow
1029 # multiple Delays to be specified, letting users set separate delays
1030 # between batches of projects corresponding to different locations and
1031 # batches of projects corresponding to the same location.
1032 { # Options to control the delay, if any, between batches of projects.
1033 &quot;delimiter&quot;: &quot;A String&quot;, # Optional. Controls whether the delay should only be added between batches of
1034 # projects corresponding to different locations, or also between
1035 # batches of projects corresponding to the same location.
1036 #
1037 # Must be set to DELIMITER_UNSPECIFIED if no delay is to be added.
1038 &quot;duration&quot;: &quot;A String&quot;, # Optional. The duration of the delay, if any, to be added between batches of
1039 # projects. A zero duration corresponds to no delay.
1040 &quot;type&quot;: &quot;A String&quot;, # Optional. Controls whether the specified duration is to be added at the end of
1041 # each batch, or if the total processing time for each batch will be
1042 # padded if needed to meet the specified duration.
1043 #
1044 # Must be set to TYPE_UNSPECIFIED if no delay is to be added.
1045 },
1046 ],
1047 &quot;maxConcurrentLocations&quot;: &quot;A String&quot;, # Optional. Maximum number of locations to be orchestrated in parallel.
1048 &quot;maxConcurrentResourcesPerLocation&quot;: &quot;A String&quot;, # Optional. Maximum number of resources to be orchestrated per location in
1049 # parallel.
1050 },
1051 &quot;selectors&quot;: [ # Required. The selectors for this wave. There is a logical AND between each selector
1052 # defined in a wave, so a resource must satisfy the criteria of *all* the
1053 # specified selectors to be in scope for the wave.
1054 { # A selector which specifies what resource(s) are included in a given wave.
1055 &quot;locationSelector&quot;: { # Roll out to resources by location. # Optional. Roll out to resources by Cloud locations.
1056 &quot;includedLocations&quot;: [ # Optional. Example: &quot;us-central1-a&quot;
1057 &quot;A String&quot;,
1058 ],
1059 },
1060 &quot;resourceHierarchySelector&quot;: { # Roll out to resources by Cloud Resource Manager resource hierarchy # Optional. Roll out to resources by Cloud Resource Manager resource hierarchy.
1061 # nodes such as projects, folders, orgs.
1062 &quot;includedFolders&quot;: [ # Optional. Format: &quot;folders/{folder_id}&quot;
1063 &quot;A String&quot;,
1064 ],
1065 &quot;includedOrganizations&quot;: [ # Optional. Format: &quot;organizations/{organization_id}&quot;
1066 &quot;A String&quot;,
1067 ],
1068 &quot;includedProjects&quot;: [ # Optional. Format: &quot;projects/{project_id}&quot;
1069 &quot;A String&quot;,
1070 ],
1071 },
1072 },
1073 ],
1074 &quot;validation&quot;: { # The validation to be performed before progressing to the next wave. # Required. The validation to be performed at the end of this wave.
1075 &quot;timeBasedValidationMetadata&quot;: { # Metadata required if type = &quot;time&quot;. # Optional. Metadata required if type = &quot;time&quot;.
1076 &quot;waitDuration&quot;: &quot;A String&quot;, # Optional. The duration that the system waits in between waves. This wait starts
1077 # after all changes in the wave are rolled out.
1078 },
1079 &quot;type&quot;: &quot;A String&quot;, # Required. The type of the validation. If a type of validation is associated with
1080 # a metadata object, the appropriate metadata field mapping to the
1081 # validation type must be provided in the validation message. Possible
1082 # values are in quotes below alongside an explanation:
1083 # &quot;manual&quot;: The system waits for an end-user approval API before
1084 # progressing to the next wave.
1085 # &quot;time&quot;: The system waits for a user specified duration before
1086 # progressing to the next wave. TimeBasedValidation must be provided.
1087 },
1088 },
1089 ],
1090 },
1091 ],
1092 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
1093 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
1094 # the query parameter pageToken in the next list request.
1095 # Subsequent list requests will have their own nextPageToken to
1096 # continue paging through the results.
1097 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
1098 &quot;unreachables&quot;: [ # Output only. [Output Only] Unreachable resources.
1099 # end_interface: MixerListResponseWithEtagBuilder
1100 &quot;A String&quot;,
1101 ],
1102 &quot;warning&quot;: { # [Output Only] Informational warning message.
1103 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1104 # Engine returns NO_RESULTS_ON_PAGE if there
1105 # are no results in the response.
1106 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1107 # value format. For example:
1108 #
1109 # &quot;data&quot;: [
1110 # {
1111 # &quot;key&quot;: &quot;scope&quot;,
1112 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1113 # }
1114 {
1115 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1116 # returned. For example, for warnings where there are no results in a list
1117 # request for a particular zone, this key might be scope and
1118 # the key value might be the zone name. Other examples might be a key
1119 # indicating a deprecated resource and a suggested replacement, or a
1120 # warning about invalid network settings (for example, if an instance
1121 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1122 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1123 },
1124 ],
1125 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1126 },
1127 }</pre>
1128 </div>
1129
1130 <div class="method">
1131 <code class="details" id="list_next">list_next()</code>
1132 <pre>Retrieves the next page of results.
1133
1134 Args:
1135 previous_request: The request for the previous page. (required)
1136 previous_response: The response from the request for the previous page. (required)
1137
1138 Returns:
1139 A request object that you can call &#x27;execute()&#x27; on to request the next
1140 page. Returns None if there are no more items in the collection.
1141 </pre>
1142 </div>
1143
1144 </body></html>