Debian Codegraph @

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