Debian Codegraph @

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