Debian Codegraph @

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