Debian Codegraph @

docs/dyn/compute_alpha.wireGroups.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.wireGroups.html">wireGroups</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, wireGroup, requestId=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Deletes the specified wire group in the given scope.</p>
83 <p class="toc_element">
84 <code><a href="#get">get(project, crossSiteNetwork, wireGroup, x__xgafv=None)</a></code></p>
85 <p class="firstline">Gets the specified wire group resource in the given scope.</p>
86 <p class="toc_element">
87 <code><a href="#insert">insert(project, crossSiteNetwork, body=None, requestId=None, validateOnly=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Creates a wire group in the specified project in the given scope</p>
89 <p class="toc_element">
90 <code><a href="#list">list(project, crossSiteNetwork, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Lists the wire groups 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, wireGroup, body=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None)</a></code></p>
97 <p class="firstline">Updates the specified wire group resource with the data included in the</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, wireGroup, requestId=None, x__xgafv=None)</code>
106 <pre>Deletes the specified wire group in the given scope.
107
108 Args:
109 project: string, Project ID for this request. (required)
110 crossSiteNetwork: string, A parameter (required)
111 wireGroup: string, Name of the wire group resource to delete. (required)
112 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
113 that if you must retry your request, the server will know to ignore the
114 request if it has already been completed.
115
116 For example, consider a situation where you make an initial request and
117 the request times out. If you make the request again with the same
118 request ID, the server can check if original operation with the same
119 request ID was received, and if so, will ignore the second request. This
120 prevents clients from accidentally creating duplicate commitments.
121
122 The request ID must be
123 a valid UUID with the exception that zero UUID is not supported
124 (00000000-0000-0000-0000-000000000000).
125 end_interface: MixerMutationRequestBuilder
126 x__xgafv: string, V1 error format.
127 Allowed values
128 1 - v1 error format
129 2 - v2 error format
130
131 Returns:
132 An object of the form:
133
134 { # Represents an Operation resource.
135 #
136 # Google Compute Engine has three Operation resources:
137 #
138 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
139 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
140 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
141 #
142 # You can use an operation resource to manage asynchronous API requests.
143 # For more information, readHandling
144 # API responses.
145 #
146 # Operations can be global, regional or zonal.
147 #
148 # - For global operations, use the `globalOperations`
149 # resource.
150 # - For regional operations, use the
151 # `regionOperations` resource.
152 # - For zonal operations, use
153 # the `zoneOperations` resource.
154 #
155 #
156 #
157 # For more information, read
158 # Global, Regional, and Zonal Resources.
159 #
160 # Note that completed Operation resources have a limited
161 # retention period.
162 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
163 # Not present otherwise.
164 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
165 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
166 # set when the operation is created.
167 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
168 # text format.
169 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
170 # this field will be populated.
171 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
172 # operation.
173 {
174 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
175 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
176 # details. There is a set of defined message types to use for providing
177 # details.The syntax depends on the error code. For example,
178 # QuotaExceededInfo will have details when the error code is
179 # QUOTA_EXCEEDED.
180 {
181 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
182 #
183 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
184 # is not enabled:
185 #
186 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
187 # &quot;domain&quot;: &quot;googleapis.com&quot;
188 # &quot;metadata&quot;: {
189 # &quot;resource&quot;: &quot;projects/123&quot;,
190 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
191 # }
192 # }
193 #
194 # This response indicates that the pubsub.googleapis.com API is not enabled.
195 #
196 # Example of an error that is returned when attempting to create a Spanner
197 # instance in a region that is out of stock:
198 #
199 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
200 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
201 # &quot;metadata&quot;: {
202 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
203 # }
204 # }
205 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
206 # is typically the registered service name of the tool or product that
207 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
208 # generated by some common infrastructure, the error domain must be a
209 # globally unique value that identifies the infrastructure. For Google API
210 # infrastructure, the error domain is &quot;googleapis.com&quot;.
211 &quot;metadatas&quot;: { # Additional structured details about this error.
212 #
213 # Keys must match a regular expression of `a-z+` but should
214 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
215 # length. When identifying the current value of an exceeded limit, the units
216 # should be contained in the key, not the value. For example, rather than
217 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
218 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
219 # instances that can be created in a single (batch) request.
220 &quot;a_key&quot;: &quot;A String&quot;,
221 },
222 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
223 # proximate cause of the error. Error reasons are unique within a particular
224 # domain of errors. This should be at most 63 characters and match a
225 # regular expression of `A-Z+[A-Z0-9]`, which represents
226 # UPPER_SNAKE_CASE.
227 },
228 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
229 #
230 # For example, if a quota check failed with an error indicating the calling
231 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
232 # directly to the right place in the developer console to flip the bit.
233 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
234 { # Describes a URL link.
235 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
236 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
237 },
238 ],
239 },
240 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
241 # which can be attached to an RPC error.
242 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
243 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
244 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
245 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
246 },
247 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
248 &quot;dimensions&quot;: { # The map holding related quota dimensions.
249 &quot;a_key&quot;: &quot;A String&quot;,
250 },
251 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
252 # type or metric.
253 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
254 # or metric.
255 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
256 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
257 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
258 },
259 },
260 ],
261 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
262 # This property is optional.
263 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
264 },
265 ],
266 },
267 &quot;getVersionOperationMetadata&quot;: {
268 &quot;inlineSbomInfo&quot;: {
269 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
270 # appropriate identifiers.
271 &quot;a_key&quot;: &quot;A String&quot;,
272 },
273 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
274 # identifiers.
275 &quot;a_key&quot;: &quot;A String&quot;,
276 },
277 },
278 },
279 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
280 # message that was returned, such as `NOT FOUND`.
281 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
282 # status code that was returned. For example, a `404` means the
283 # resource was not found.
284 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
285 # defined by the server.
286 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
287 # This value is inRFC3339
288 # text format.
289 &quot;instancesBulkInsertOperationMetadata&quot;: {
290 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
291 # Example key: zones/us-central1-a
292 &quot;a_key&quot;: {
293 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
294 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
295 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
296 # error.
297 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
298 # if the flow is rolling forward or rolling back.
299 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
300 },
301 },
302 },
303 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
304 # Operation resources.
305 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
306 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
307 # group of operations results from a `bulkInsert` API request.
308 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
309 # `update`, or `delete`, and so on.
310 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
311 # There is no requirement that this be linear or support any granularity of
312 # operations. This should not be used to guess when the operation will be
313 # complete. This number should monotonically increase as the operation
314 # progresses.
315 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
316 # applicable when performing regional operations.
317 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
318 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
319 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
320 # this field will contain information on all underlying zonal actions and
321 # their state.
322 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
323 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
324 # Example key: zones/us-central1-a
325 &quot;a_key&quot;: {
326 &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
327 # populated.
328 # different programming environments, including REST APIs and RPC APIs. It is
329 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
330 # three pieces of data: error code, error message, and error details.
331 #
332 # You can find out more about this error model and how to work with it in the
333 # [API Design Guide](https://cloud.google.com/apis/design/errors).
334 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
335 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
336 # message types for APIs to use.
337 {
338 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
339 },
340 ],
341 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
342 # user-facing error message should be localized and sent in the
343 # google.rpc.Status.details field, or localized by the client.
344 },
345 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
346 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
347 },
348 },
349 },
350 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
351 # This value is inRFC3339
352 # text format.
353 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
354 # following:
355 # `PENDING`, `RUNNING`, or `DONE`.
356 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
357 # operation.
358 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
359 # of the target resource.
360 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
361 # operations related to creating a snapshot, this points to the disk
362 # that the snapshot was created from.
363 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
364 # `[email protected]` or
365 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
366 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
367 # operation, this field will be populated.
368 {
369 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
370 # Engine returns NO_RESULTS_ON_PAGE if there
371 # are no results in the response.
372 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
373 # value format. For example:
374 #
375 # &quot;data&quot;: [
376 # {
377 # &quot;key&quot;: &quot;scope&quot;,
378 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
379 # }
380 {
381 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
382 # returned. For example, for warnings where there are no results in a list
383 # request for a particular zone, this key might be scope and
384 # the key value might be the zone name. Other examples might be a key
385 # indicating a deprecated resource and a suggested replacement, or a
386 # warning about invalid network settings (for example, if an instance
387 # attempts to perform IP forwarding but is not enabled for IP forwarding).
388 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
389 },
390 ],
391 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
392 },
393 ],
394 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
395 # applicable when performing per-zone operations.
396 }</pre>
397 </div>
398
399 <div class="method">
400 <code class="details" id="get">get(project, crossSiteNetwork, wireGroup, x__xgafv=None)</code>
401 <pre>Gets the specified wire group resource in the given scope.
402
403 Args:
404 project: string, Project ID for this request. (required)
405 crossSiteNetwork: string, A parameter (required)
406 wireGroup: string, Name of the wire group resource to return. (required)
407 x__xgafv: string, V1 error format.
408 Allowed values
409 1 - v1 error format
410 2 - v2 error format
411
412 Returns:
413 An object of the form:
414
415 { # A resource that represents a group of redundant wires.
416 &quot;adminEnabled&quot;: True or False, # Indicates whether the wires in the wire group are enabled. When false, the
417 # wires in the wire group are disabled. When true and when
418 # there is simultaneously no wire-specific override of `adminEnabled` to
419 # false, a given wire is enabled. Defaults to true.
420 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
421 # text format.
422 &quot;description&quot;: &quot;A String&quot;, # An optional description of the wire group.
423 &quot;endpoints&quot;: { # A map that contains the logical endpoints of the wire group. Specify
424 # key-value pairs for the map as follows:
425 #
426 # - Key: an RFC1035 user-specified label.
427 # - Value: an Endpoint object.
428 &quot;a_key&quot;: { # A logical endpoint for the wire group. An endpoint represents a metro that
429 # contains redundant Interconnect connections. A wire group is created
430 # between two endpoints.
431 &quot;interconnects&quot;: { # A map that contains the redundant Interconnect connections. Specify
432 # key-value pairs for the map as follows:
433 #
434 # - Key: an RFC1035 user-specified label.
435 # - Value: an Interconnect object.
436 &quot;a_key&quot;: { # The redundant Interconnect connections for this endpoint.
437 &quot;interconnect&quot;: &quot;A String&quot;, # Required. An Interconnect connection. You can specify the connection as
438 # a partial or full URL. If the connection is in a different project from
439 # the cross-site network, use a format that specifies the project. See
440 # the following examples of partial and full URLs:
441 #
442 #
443 #
444 # global/interconnects/NAME
445 #
446 #
447 # projects/PROJECT_ID/global/interconnects/NAME
448 #
449 # -
450 # https://compute.googleapis.com/compute/projects/PROJECT_ID/global/interconnects/NAME
451 &quot;vlanTags&quot;: [ # Required. To configure the wire group for VLAN mode, enter a VLAN tag,
452 # which is a number from `2` to `4093`. You can autoallocate a tag by
453 # entering `0`. To configure the wire group for port mode, enter `-1`.
454 # Review the following guidelines:
455 #
456 # - A VLAN tag must be unique for an Interconnect connection across all
457 # attachments and wire groups.
458 # - Both endpoints of a wire must use the same VLAN tag value.
459 # - Single wire and redundant type wire groups must have only one
460 # VLAN tag.
461 # - Port mode pseudowires must have a single VLAN tag with a value of
462 # `-1` for both endpoints.
463 # - Box and cross type wire groups must have two VLAN tags. The first
464 # is for the same-zone pseudowire, and the second is for the cross-zone
465 # pseudowire.
466 42,
467 ],
468 },
469 },
470 },
471 },
472 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource type. The server
473 # generates this identifier.
474 &quot;kind&quot;: &quot;compute#wireGroup&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#wireGroups for wire groups.
475 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
476 # The name must be 1-63 characters long, and comply withRFC1035.
477 # Specifically, the name must be 1-63 characters long and match the regular
478 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
479 # character must be a lowercase letter, and all following characters must
480 # be a dash, lowercase letter, or digit, except the last character, which
481 # cannot be a dash.
482 &quot;reconciling&quot;: True or False, # Output only. [Output Only] Indicates whether there are wire changes yet to be processed.
483 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
484 &quot;selfLinkWithId&quot;: &quot;A String&quot;,
485 &quot;serviceLevel&quot;: { # Service level details determined for the wire group configuration. # Output only. Service level details determined for the wire group configuration.
486 &quot;availabilityClass&quot;: &quot;A String&quot;, # Output only. [Output Only] The availability SLA that the wire group qualifies for. One
487 # of the following: `NO_AVAILABILITY_SLA`, `AVAILABILITY_99`,
488 # `AVAILABILITY_999`, or `AVAILABILITY_9995`.
489 },
490 &quot;topology&quot;: { # Topology details for the wire group. # Output only. Topology details for the wire group configuration.
491 &quot;endpoints&quot;: [ # Output only. Topology details for all endpoints in the wire group.
492 { # Topology details for a single wire group endpoint.
493 &quot;city&quot;: &quot;A String&quot;, # Output only. The InterconnectLocation.city (metropolitan area designator) that all
494 # interconnects are located in.
495 &quot;label&quot;: &quot;A String&quot;, # Output only. Endpoint label from the wire group.
496 },
497 ],
498 },
499 &quot;wireGroupProperties&quot;: { # The properties of a wire group. These properties # Properties of the wire group.
500 # determine how a group of redundant wires are created and managed.
501 &quot;type&quot;: &quot;A String&quot;, # The type of the wire group, one of the following:
502 #
503 # - WIRE: a single pseudowire over two Interconnect connections with no
504 # redundancy.
505 # - REDUNDANT: two pseudowires over four Interconnect connections, with
506 # two connections in one metro and two connections in another metro.
507 # Each redundant pair of Interconnect connections spans both edge
508 # availability domains of the metro. Each pseudowire connects Interconnect
509 # connections in matching edge availability domains of the two metros.
510 # - BOX_AND_CROSS: four pseudowires over four Interconnect connections,
511 # with two connections in one metro and two connections in another metro.
512 # Each redundant pair of Interconnect connections spans both edge
513 # availability domains of the metro. Two pseudowires connect Interconnect
514 # connections in matching edge availability domains of the two metros.
515 # Two additional pseudowires connect the non-matching edge availability
516 # domains of the two metros.
517 },
518 &quot;wireInputs&quot;: { # A map that contains optional settings for individual wires.
519 # Specify key-value pairs for the map as follows:
520 #
521 # - Key: the label of an existing wire. To view a wire label and its
522 # format, see the wires[].label field.
523 # - Value: a WireInputs object.
524 &quot;a_key&quot;: { # Optional settings for individual wires. Allows wire-level control that
525 # can be useful for migration purposes. If you use this field, you opt-out
526 # of the SLA for the wire group.
527 &quot;adminEnabled&quot;: True or False, # Indicates whether the wire is enabled.
528 # When false, the wire is disabled. When true and when the wire group of
529 # the wire is also enabled, the wire is enabled. Defaults to true.
530 &quot;wirePropertyOverrides&quot;: { # The properties of a wire. # The overridden properties for the wire. Any properties that are not
531 # overridden are omitted from the object. Review the following guidelines:
532 #
533 # - If you apply wire overrides to a wire and its wire group bandwidth
534 # configuration is set to `SHARED_WITH_WIRE_GROUP`, the
535 # `meteredBandwidth` and `unmeteredBandwidth` properties must not differ
536 # from the wire group.
537 # - Overrides generate a `configurationNotice`. Ensure that differences
538 # in wire configuration are temporary. An example use case for wire
539 # overrides is slowly rolling out configuration changes to individual wires
540 # in a wire group.
541 &quot;bandwidthAllocation&quot;: &quot;A String&quot;, # The configuration of the bandwidth allocation, one of the following:
542 #
543 # - ALLOCATE_PER_WIRE: configures a separate unmetered bandwidth allocation
544 # (and associated charges) for each wire in the group.
545 # - SHARED_WITH_WIRE_GROUP: this is the default behavior, which configures
546 # one unmetered bandwidth allocation for the wire group. The unmetered
547 # bandwidth is divided equally across each wire in the group, but dynamic
548 # throttling reallocates unused unmetered bandwidth from unused or underused
549 # wires to other wires in the group.
550 &quot;bandwidthMetered&quot;: &quot;A String&quot;, # The metered bandwidth in Gigabits per second, using decimal units. `10` is
551 # 10 Gbps, `100` is 100 Gbps. The default value is `0`. You can specify
552 # unlimited bandwidth by entering `-1`. However, actual data transfer is
553 # limited by the port speed.
554 &quot;bandwidthUnmetered&quot;: &quot;A String&quot;, # The unmetered bandwidth in Gigabits per second, using decimal units. `10`
555 # is 10 Gbps, `100` is 100 Gbps. The bandwidth must be greater than 0.
556 &quot;faultResponse&quot;: &quot;A String&quot;, # Response when a fault is detected in a pseudowire:
557 #
558 # - NONE: default.
559 # - DISABLE_PORT: set the port line protocol down when inline probes
560 # detect a fault. This setting is only permitted on port mode
561 # pseudowires.
562 &quot;networkServiceClass&quot;: &quot;A String&quot;, # The network service class.
563 },
564 },
565 },
566 &quot;wireProperties&quot;: { # The properties of a wire. # Properties for all wires in the wire group.
567 &quot;bandwidthAllocation&quot;: &quot;A String&quot;, # The configuration of the bandwidth allocation, one of the following:
568 #
569 # - ALLOCATE_PER_WIRE: configures a separate unmetered bandwidth allocation
570 # (and associated charges) for each wire in the group.
571 # - SHARED_WITH_WIRE_GROUP: this is the default behavior, which configures
572 # one unmetered bandwidth allocation for the wire group. The unmetered
573 # bandwidth is divided equally across each wire in the group, but dynamic
574 # throttling reallocates unused unmetered bandwidth from unused or underused
575 # wires to other wires in the group.
576 &quot;bandwidthMetered&quot;: &quot;A String&quot;, # The metered bandwidth in Gigabits per second, using decimal units. `10` is
577 # 10 Gbps, `100` is 100 Gbps. The default value is `0`. You can specify
578 # unlimited bandwidth by entering `-1`. However, actual data transfer is
579 # limited by the port speed.
580 &quot;bandwidthUnmetered&quot;: &quot;A String&quot;, # The unmetered bandwidth in Gigabits per second, using decimal units. `10`
581 # is 10 Gbps, `100` is 100 Gbps. The bandwidth must be greater than 0.
582 &quot;faultResponse&quot;: &quot;A String&quot;, # Response when a fault is detected in a pseudowire:
583 #
584 # - NONE: default.
585 # - DISABLE_PORT: set the port line protocol down when inline probes
586 # detect a fault. This setting is only permitted on port mode
587 # pseudowires.
588 &quot;networkServiceClass&quot;: &quot;A String&quot;, # The network service class.
589 },
590 &quot;wires&quot;: [ # Output only. The single/redundant wire(s) managed by the wire group.
591 { # A pseudowire that connects two Interconnect connections.
592 &quot;adminEnabled&quot;: True or False, # Output only. [Output Only] Indicates whether the wire is enabled.
593 # When false, the wire is disabled. When true and when the wire group of
594 # the wire is also enabled, the wire is enabled. Defaults to true.
595 &quot;endpoints&quot;: [ # Output only. Wire endpoints are specific Interconnect connections.
596 { # Wire endpoints are specific Interconnect connections.
597 &quot;interconnect&quot;: &quot;A String&quot;,
598 &quot;vlanTag&quot;: 42,
599 },
600 ],
601 &quot;label&quot;: &quot;A String&quot;, # Output only. [Output Only] A label that identifies the wire. The format of this label
602 # combines the existing labels of the wire group endpoints and Interconnect
603 # connections used by this wire in alphabetical order as follows:
604 # `ENDPOINT_A+CONNECTION_A1,ENDPOINT_B+CONNECTION_B1`, where:
605 #
606 # - ENDPOINT_A and ENDPOINT_B: are the labels
607 # that you entered as map keys when you specified the wire group endpoint
608 # objects.
609 # - CONNECTION_A1 and CONNECTION_B1: are the
610 # labels that you entered as map keys when you specified the wire group
611 # Interconnect objects.
612 &quot;wireProperties&quot;: { # The properties of a wire. # Output only. [Output Only] Properties of the wire.
613 &quot;bandwidthAllocation&quot;: &quot;A String&quot;, # The configuration of the bandwidth allocation, one of the following:
614 #
615 # - ALLOCATE_PER_WIRE: configures a separate unmetered bandwidth allocation
616 # (and associated charges) for each wire in the group.
617 # - SHARED_WITH_WIRE_GROUP: this is the default behavior, which configures
618 # one unmetered bandwidth allocation for the wire group. The unmetered
619 # bandwidth is divided equally across each wire in the group, but dynamic
620 # throttling reallocates unused unmetered bandwidth from unused or underused
621 # wires to other wires in the group.
622 &quot;bandwidthMetered&quot;: &quot;A String&quot;, # The metered bandwidth in Gigabits per second, using decimal units. `10` is
623 # 10 Gbps, `100` is 100 Gbps. The default value is `0`. You can specify
624 # unlimited bandwidth by entering `-1`. However, actual data transfer is
625 # limited by the port speed.
626 &quot;bandwidthUnmetered&quot;: &quot;A String&quot;, # The unmetered bandwidth in Gigabits per second, using decimal units. `10`
627 # is 10 Gbps, `100` is 100 Gbps. The bandwidth must be greater than 0.
628 &quot;faultResponse&quot;: &quot;A String&quot;, # Response when a fault is detected in a pseudowire:
629 #
630 # - NONE: default.
631 # - DISABLE_PORT: set the port line protocol down when inline probes
632 # detect a fault. This setting is only permitted on port mode
633 # pseudowires.
634 &quot;networkServiceClass&quot;: &quot;A String&quot;, # The network service class.
635 },
636 },
637 ],
638 }</pre>
639 </div>
640
641 <div class="method">
642 <code class="details" id="insert">insert(project, crossSiteNetwork, body=None, requestId=None, validateOnly=None, x__xgafv=None)</code>
643 <pre>Creates a wire group in the specified project in the given scope
644 using the parameters that are included in the request.
645
646 Args:
647 project: string, Project ID for this request. (required)
648 crossSiteNetwork: string, A parameter (required)
649 body: object, The request body.
650 The object takes the form of:
651
652 { # A resource that represents a group of redundant wires.
653 &quot;adminEnabled&quot;: True or False, # Indicates whether the wires in the wire group are enabled. When false, the
654 # wires in the wire group are disabled. When true and when
655 # there is simultaneously no wire-specific override of `adminEnabled` to
656 # false, a given wire is enabled. Defaults to true.
657 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
658 # text format.
659 &quot;description&quot;: &quot;A String&quot;, # An optional description of the wire group.
660 &quot;endpoints&quot;: { # A map that contains the logical endpoints of the wire group. Specify
661 # key-value pairs for the map as follows:
662 #
663 # - Key: an RFC1035 user-specified label.
664 # - Value: an Endpoint object.
665 &quot;a_key&quot;: { # A logical endpoint for the wire group. An endpoint represents a metro that
666 # contains redundant Interconnect connections. A wire group is created
667 # between two endpoints.
668 &quot;interconnects&quot;: { # A map that contains the redundant Interconnect connections. Specify
669 # key-value pairs for the map as follows:
670 #
671 # - Key: an RFC1035 user-specified label.
672 # - Value: an Interconnect object.
673 &quot;a_key&quot;: { # The redundant Interconnect connections for this endpoint.
674 &quot;interconnect&quot;: &quot;A String&quot;, # Required. An Interconnect connection. You can specify the connection as
675 # a partial or full URL. If the connection is in a different project from
676 # the cross-site network, use a format that specifies the project. See
677 # the following examples of partial and full URLs:
678 #
679 #
680 #
681 # global/interconnects/NAME
682 #
683 #
684 # projects/PROJECT_ID/global/interconnects/NAME
685 #
686 # -
687 # https://compute.googleapis.com/compute/projects/PROJECT_ID/global/interconnects/NAME
688 &quot;vlanTags&quot;: [ # Required. To configure the wire group for VLAN mode, enter a VLAN tag,
689 # which is a number from `2` to `4093`. You can autoallocate a tag by
690 # entering `0`. To configure the wire group for port mode, enter `-1`.
691 # Review the following guidelines:
692 #
693 # - A VLAN tag must be unique for an Interconnect connection across all
694 # attachments and wire groups.
695 # - Both endpoints of a wire must use the same VLAN tag value.
696 # - Single wire and redundant type wire groups must have only one
697 # VLAN tag.
698 # - Port mode pseudowires must have a single VLAN tag with a value of
699 # `-1` for both endpoints.
700 # - Box and cross type wire groups must have two VLAN tags. The first
701 # is for the same-zone pseudowire, and the second is for the cross-zone
702 # pseudowire.
703 42,
704 ],
705 },
706 },
707 },
708 },
709 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource type. The server
710 # generates this identifier.
711 &quot;kind&quot;: &quot;compute#wireGroup&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#wireGroups for wire groups.
712 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
713 # The name must be 1-63 characters long, and comply withRFC1035.
714 # Specifically, the name must be 1-63 characters long and match the regular
715 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
716 # character must be a lowercase letter, and all following characters must
717 # be a dash, lowercase letter, or digit, except the last character, which
718 # cannot be a dash.
719 &quot;reconciling&quot;: True or False, # Output only. [Output Only] Indicates whether there are wire changes yet to be processed.
720 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
721 &quot;selfLinkWithId&quot;: &quot;A String&quot;,
722 &quot;serviceLevel&quot;: { # Service level details determined for the wire group configuration. # Output only. Service level details determined for the wire group configuration.
723 &quot;availabilityClass&quot;: &quot;A String&quot;, # Output only. [Output Only] The availability SLA that the wire group qualifies for. One
724 # of the following: `NO_AVAILABILITY_SLA`, `AVAILABILITY_99`,
725 # `AVAILABILITY_999`, or `AVAILABILITY_9995`.
726 },
727 &quot;topology&quot;: { # Topology details for the wire group. # Output only. Topology details for the wire group configuration.
728 &quot;endpoints&quot;: [ # Output only. Topology details for all endpoints in the wire group.
729 { # Topology details for a single wire group endpoint.
730 &quot;city&quot;: &quot;A String&quot;, # Output only. The InterconnectLocation.city (metropolitan area designator) that all
731 # interconnects are located in.
732 &quot;label&quot;: &quot;A String&quot;, # Output only. Endpoint label from the wire group.
733 },
734 ],
735 },
736 &quot;wireGroupProperties&quot;: { # The properties of a wire group. These properties # Properties of the wire group.
737 # determine how a group of redundant wires are created and managed.
738 &quot;type&quot;: &quot;A String&quot;, # The type of the wire group, one of the following:
739 #
740 # - WIRE: a single pseudowire over two Interconnect connections with no
741 # redundancy.
742 # - REDUNDANT: two pseudowires over four Interconnect connections, with
743 # two connections in one metro and two connections in another metro.
744 # Each redundant pair of Interconnect connections spans both edge
745 # availability domains of the metro. Each pseudowire connects Interconnect
746 # connections in matching edge availability domains of the two metros.
747 # - BOX_AND_CROSS: four pseudowires over four Interconnect connections,
748 # with two connections in one metro and two connections in another metro.
749 # Each redundant pair of Interconnect connections spans both edge
750 # availability domains of the metro. Two pseudowires connect Interconnect
751 # connections in matching edge availability domains of the two metros.
752 # Two additional pseudowires connect the non-matching edge availability
753 # domains of the two metros.
754 },
755 &quot;wireInputs&quot;: { # A map that contains optional settings for individual wires.
756 # Specify key-value pairs for the map as follows:
757 #
758 # - Key: the label of an existing wire. To view a wire label and its
759 # format, see the wires[].label field.
760 # - Value: a WireInputs object.
761 &quot;a_key&quot;: { # Optional settings for individual wires. Allows wire-level control that
762 # can be useful for migration purposes. If you use this field, you opt-out
763 # of the SLA for the wire group.
764 &quot;adminEnabled&quot;: True or False, # Indicates whether the wire is enabled.
765 # When false, the wire is disabled. When true and when the wire group of
766 # the wire is also enabled, the wire is enabled. Defaults to true.
767 &quot;wirePropertyOverrides&quot;: { # The properties of a wire. # The overridden properties for the wire. Any properties that are not
768 # overridden are omitted from the object. Review the following guidelines:
769 #
770 # - If you apply wire overrides to a wire and its wire group bandwidth
771 # configuration is set to `SHARED_WITH_WIRE_GROUP`, the
772 # `meteredBandwidth` and `unmeteredBandwidth` properties must not differ
773 # from the wire group.
774 # - Overrides generate a `configurationNotice`. Ensure that differences
775 # in wire configuration are temporary. An example use case for wire
776 # overrides is slowly rolling out configuration changes to individual wires
777 # in a wire group.
778 &quot;bandwidthAllocation&quot;: &quot;A String&quot;, # The configuration of the bandwidth allocation, one of the following:
779 #
780 # - ALLOCATE_PER_WIRE: configures a separate unmetered bandwidth allocation
781 # (and associated charges) for each wire in the group.
782 # - SHARED_WITH_WIRE_GROUP: this is the default behavior, which configures
783 # one unmetered bandwidth allocation for the wire group. The unmetered
784 # bandwidth is divided equally across each wire in the group, but dynamic
785 # throttling reallocates unused unmetered bandwidth from unused or underused
786 # wires to other wires in the group.
787 &quot;bandwidthMetered&quot;: &quot;A String&quot;, # The metered bandwidth in Gigabits per second, using decimal units. `10` is
788 # 10 Gbps, `100` is 100 Gbps. The default value is `0`. You can specify
789 # unlimited bandwidth by entering `-1`. However, actual data transfer is
790 # limited by the port speed.
791 &quot;bandwidthUnmetered&quot;: &quot;A String&quot;, # The unmetered bandwidth in Gigabits per second, using decimal units. `10`
792 # is 10 Gbps, `100` is 100 Gbps. The bandwidth must be greater than 0.
793 &quot;faultResponse&quot;: &quot;A String&quot;, # Response when a fault is detected in a pseudowire:
794 #
795 # - NONE: default.
796 # - DISABLE_PORT: set the port line protocol down when inline probes
797 # detect a fault. This setting is only permitted on port mode
798 # pseudowires.
799 &quot;networkServiceClass&quot;: &quot;A String&quot;, # The network service class.
800 },
801 },
802 },
803 &quot;wireProperties&quot;: { # The properties of a wire. # Properties for all wires in the wire group.
804 &quot;bandwidthAllocation&quot;: &quot;A String&quot;, # The configuration of the bandwidth allocation, one of the following:
805 #
806 # - ALLOCATE_PER_WIRE: configures a separate unmetered bandwidth allocation
807 # (and associated charges) for each wire in the group.
808 # - SHARED_WITH_WIRE_GROUP: this is the default behavior, which configures
809 # one unmetered bandwidth allocation for the wire group. The unmetered
810 # bandwidth is divided equally across each wire in the group, but dynamic
811 # throttling reallocates unused unmetered bandwidth from unused or underused
812 # wires to other wires in the group.
813 &quot;bandwidthMetered&quot;: &quot;A String&quot;, # The metered bandwidth in Gigabits per second, using decimal units. `10` is
814 # 10 Gbps, `100` is 100 Gbps. The default value is `0`. You can specify
815 # unlimited bandwidth by entering `-1`. However, actual data transfer is
816 # limited by the port speed.
817 &quot;bandwidthUnmetered&quot;: &quot;A String&quot;, # The unmetered bandwidth in Gigabits per second, using decimal units. `10`
818 # is 10 Gbps, `100` is 100 Gbps. The bandwidth must be greater than 0.
819 &quot;faultResponse&quot;: &quot;A String&quot;, # Response when a fault is detected in a pseudowire:
820 #
821 # - NONE: default.
822 # - DISABLE_PORT: set the port line protocol down when inline probes
823 # detect a fault. This setting is only permitted on port mode
824 # pseudowires.
825 &quot;networkServiceClass&quot;: &quot;A String&quot;, # The network service class.
826 },
827 &quot;wires&quot;: [ # Output only. The single/redundant wire(s) managed by the wire group.
828 { # A pseudowire that connects two Interconnect connections.
829 &quot;adminEnabled&quot;: True or False, # Output only. [Output Only] Indicates whether the wire is enabled.
830 # When false, the wire is disabled. When true and when the wire group of
831 # the wire is also enabled, the wire is enabled. Defaults to true.
832 &quot;endpoints&quot;: [ # Output only. Wire endpoints are specific Interconnect connections.
833 { # Wire endpoints are specific Interconnect connections.
834 &quot;interconnect&quot;: &quot;A String&quot;,
835 &quot;vlanTag&quot;: 42,
836 },
837 ],
838 &quot;label&quot;: &quot;A String&quot;, # Output only. [Output Only] A label that identifies the wire. The format of this label
839 # combines the existing labels of the wire group endpoints and Interconnect
840 # connections used by this wire in alphabetical order as follows:
841 # `ENDPOINT_A+CONNECTION_A1,ENDPOINT_B+CONNECTION_B1`, where:
842 #
843 # - ENDPOINT_A and ENDPOINT_B: are the labels
844 # that you entered as map keys when you specified the wire group endpoint
845 # objects.
846 # - CONNECTION_A1 and CONNECTION_B1: are the
847 # labels that you entered as map keys when you specified the wire group
848 # Interconnect objects.
849 &quot;wireProperties&quot;: { # The properties of a wire. # Output only. [Output Only] Properties of the wire.
850 &quot;bandwidthAllocation&quot;: &quot;A String&quot;, # The configuration of the bandwidth allocation, one of the following:
851 #
852 # - ALLOCATE_PER_WIRE: configures a separate unmetered bandwidth allocation
853 # (and associated charges) for each wire in the group.
854 # - SHARED_WITH_WIRE_GROUP: this is the default behavior, which configures
855 # one unmetered bandwidth allocation for the wire group. The unmetered
856 # bandwidth is divided equally across each wire in the group, but dynamic
857 # throttling reallocates unused unmetered bandwidth from unused or underused
858 # wires to other wires in the group.
859 &quot;bandwidthMetered&quot;: &quot;A String&quot;, # The metered bandwidth in Gigabits per second, using decimal units. `10` is
860 # 10 Gbps, `100` is 100 Gbps. The default value is `0`. You can specify
861 # unlimited bandwidth by entering `-1`. However, actual data transfer is
862 # limited by the port speed.
863 &quot;bandwidthUnmetered&quot;: &quot;A String&quot;, # The unmetered bandwidth in Gigabits per second, using decimal units. `10`
864 # is 10 Gbps, `100` is 100 Gbps. The bandwidth must be greater than 0.
865 &quot;faultResponse&quot;: &quot;A String&quot;, # Response when a fault is detected in a pseudowire:
866 #
867 # - NONE: default.
868 # - DISABLE_PORT: set the port line protocol down when inline probes
869 # detect a fault. This setting is only permitted on port mode
870 # pseudowires.
871 &quot;networkServiceClass&quot;: &quot;A String&quot;, # The network service class.
872 },
873 },
874 ],
875 }
876
877 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
878 that if you must retry your request, the server will know to ignore the
879 request if it has already been completed.
880
881 For example, consider a situation where you make an initial request and
882 the request times out. If you make the request again with the same
883 request ID, the server can check if original operation with the same
884 request ID was received, and if so, will ignore the second request. This
885 prevents clients from accidentally creating duplicate commitments.
886
887 The request ID must be
888 a valid UUID with the exception that zero UUID is not supported
889 (00000000-0000-0000-0000-000000000000).
890 end_interface: MixerMutationRequestBuilder
891 validateOnly: boolean, [Input Only] Validate the new configuration, but don&#x27;t create it.
892 x__xgafv: string, V1 error format.
893 Allowed values
894 1 - v1 error format
895 2 - v2 error format
896
897 Returns:
898 An object of the form:
899
900 { # Represents an Operation resource.
901 #
902 # Google Compute Engine has three Operation resources:
903 #
904 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
905 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
906 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
907 #
908 # You can use an operation resource to manage asynchronous API requests.
909 # For more information, readHandling
910 # API responses.
911 #
912 # Operations can be global, regional or zonal.
913 #
914 # - For global operations, use the `globalOperations`
915 # resource.
916 # - For regional operations, use the
917 # `regionOperations` resource.
918 # - For zonal operations, use
919 # the `zoneOperations` resource.
920 #
921 #
922 #
923 # For more information, read
924 # Global, Regional, and Zonal Resources.
925 #
926 # Note that completed Operation resources have a limited
927 # retention period.
928 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
929 # Not present otherwise.
930 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
931 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
932 # set when the operation is created.
933 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
934 # text format.
935 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
936 # this field will be populated.
937 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
938 # operation.
939 {
940 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
941 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
942 # details. There is a set of defined message types to use for providing
943 # details.The syntax depends on the error code. For example,
944 # QuotaExceededInfo will have details when the error code is
945 # QUOTA_EXCEEDED.
946 {
947 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
948 #
949 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
950 # is not enabled:
951 #
952 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
953 # &quot;domain&quot;: &quot;googleapis.com&quot;
954 # &quot;metadata&quot;: {
955 # &quot;resource&quot;: &quot;projects/123&quot;,
956 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
957 # }
958 # }
959 #
960 # This response indicates that the pubsub.googleapis.com API is not enabled.
961 #
962 # Example of an error that is returned when attempting to create a Spanner
963 # instance in a region that is out of stock:
964 #
965 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
966 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
967 # &quot;metadata&quot;: {
968 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
969 # }
970 # }
971 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
972 # is typically the registered service name of the tool or product that
973 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
974 # generated by some common infrastructure, the error domain must be a
975 # globally unique value that identifies the infrastructure. For Google API
976 # infrastructure, the error domain is &quot;googleapis.com&quot;.
977 &quot;metadatas&quot;: { # Additional structured details about this error.
978 #
979 # Keys must match a regular expression of `a-z+` but should
980 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
981 # length. When identifying the current value of an exceeded limit, the units
982 # should be contained in the key, not the value. For example, rather than
983 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
984 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
985 # instances that can be created in a single (batch) request.
986 &quot;a_key&quot;: &quot;A String&quot;,
987 },
988 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
989 # proximate cause of the error. Error reasons are unique within a particular
990 # domain of errors. This should be at most 63 characters and match a
991 # regular expression of `A-Z+[A-Z0-9]`, which represents
992 # UPPER_SNAKE_CASE.
993 },
994 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
995 #
996 # For example, if a quota check failed with an error indicating the calling
997 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
998 # directly to the right place in the developer console to flip the bit.
999 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1000 { # Describes a URL link.
1001 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1002 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1003 },
1004 ],
1005 },
1006 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1007 # which can be attached to an RPC error.
1008 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1009 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1010 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1011 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1012 },
1013 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1014 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1015 &quot;a_key&quot;: &quot;A String&quot;,
1016 },
1017 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1018 # type or metric.
1019 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1020 # or metric.
1021 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1022 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1023 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1024 },
1025 },
1026 ],
1027 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1028 # This property is optional.
1029 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1030 },
1031 ],
1032 },
1033 &quot;getVersionOperationMetadata&quot;: {
1034 &quot;inlineSbomInfo&quot;: {
1035 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1036 # appropriate identifiers.
1037 &quot;a_key&quot;: &quot;A String&quot;,
1038 },
1039 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1040 # identifiers.
1041 &quot;a_key&quot;: &quot;A String&quot;,
1042 },
1043 },
1044 },
1045 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1046 # message that was returned, such as `NOT FOUND`.
1047 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1048 # status code that was returned. For example, a `404` means the
1049 # resource was not found.
1050 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1051 # defined by the server.
1052 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1053 # This value is inRFC3339
1054 # text format.
1055 &quot;instancesBulkInsertOperationMetadata&quot;: {
1056 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1057 # Example key: zones/us-central1-a
1058 &quot;a_key&quot;: {
1059 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1060 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1061 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1062 # error.
1063 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1064 # if the flow is rolling forward or rolling back.
1065 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1066 },
1067 },
1068 },
1069 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1070 # Operation resources.
1071 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1072 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1073 # group of operations results from a `bulkInsert` API request.
1074 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1075 # `update`, or `delete`, and so on.
1076 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1077 # There is no requirement that this be linear or support any granularity of
1078 # operations. This should not be used to guess when the operation will be
1079 # complete. This number should monotonically increase as the operation
1080 # progresses.
1081 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1082 # applicable when performing regional operations.
1083 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1084 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
1085 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1086 # this field will contain information on all underlying zonal actions and
1087 # their state.
1088 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1089 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1090 # Example key: zones/us-central1-a
1091 &quot;a_key&quot;: {
1092 &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
1093 # populated.
1094 # different programming environments, including REST APIs and RPC APIs. It is
1095 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1096 # three pieces of data: error code, error message, and error details.
1097 #
1098 # You can find out more about this error model and how to work with it in the
1099 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1100 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1101 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1102 # message types for APIs to use.
1103 {
1104 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1105 },
1106 ],
1107 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1108 # user-facing error message should be localized and sent in the
1109 # google.rpc.Status.details field, or localized by the client.
1110 },
1111 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1112 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1113 },
1114 },
1115 },
1116 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1117 # This value is inRFC3339
1118 # text format.
1119 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1120 # following:
1121 # `PENDING`, `RUNNING`, or `DONE`.
1122 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1123 # operation.
1124 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1125 # of the target resource.
1126 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1127 # operations related to creating a snapshot, this points to the disk
1128 # that the snapshot was created from.
1129 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1130 # `[email protected]` or
1131 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1132 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1133 # operation, this field will be populated.
1134 {
1135 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1136 # Engine returns NO_RESULTS_ON_PAGE if there
1137 # are no results in the response.
1138 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1139 # value format. For example:
1140 #
1141 # &quot;data&quot;: [
1142 # {
1143 # &quot;key&quot;: &quot;scope&quot;,
1144 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1145 # }
1146 {
1147 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1148 # returned. For example, for warnings where there are no results in a list
1149 # request for a particular zone, this key might be scope and
1150 # the key value might be the zone name. Other examples might be a key
1151 # indicating a deprecated resource and a suggested replacement, or a
1152 # warning about invalid network settings (for example, if an instance
1153 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1154 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1155 },
1156 ],
1157 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1158 },
1159 ],
1160 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1161 # applicable when performing per-zone operations.
1162 }</pre>
1163 </div>
1164
1165 <div class="method">
1166 <code class="details" id="list">list(project, crossSiteNetwork, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
1167 <pre>Lists the wire groups for a project in the given scope.
1168
1169 Args:
1170 project: string, Project ID for this request. (required)
1171 crossSiteNetwork: string, A parameter (required)
1172 filter: string, A filter expression that filters resources listed in the response. Most
1173 Compute resources support two types of filter expressions:
1174 expressions that support regular expressions and expressions that follow
1175 API improvement proposal AIP-160.
1176 These two types of filter expressions cannot be mixed in one request.
1177
1178 If you want to use AIP-160, your expression must specify the field name, an
1179 operator, and the value that you want to use for filtering. The value
1180 must be a string, a number, or a boolean. The operator
1181 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
1182
1183 For example, if you are filtering Compute Engine instances, you can
1184 exclude instances named `example-instance` by specifying
1185 `name != example-instance`.
1186
1187 The `:*` comparison can be used to test whether a key has been defined.
1188 For example, to find all objects with `owner` label use:
1189 ```
1190 labels.owner:*
1191 ```
1192
1193 You can also filter nested fields. For example, you could specify
1194 `scheduling.automaticRestart = false` to include instances only
1195 if they are not scheduled for automatic restarts. You can use filtering
1196 on nested fields to filter based onresource labels.
1197
1198 To filter on multiple expressions, provide each separate expression within
1199 parentheses. For example:
1200 ```
1201 (scheduling.automaticRestart = true)
1202 (cpuPlatform = &quot;Intel Skylake&quot;)
1203 ```
1204 By default, each expression is an `AND` expression. However, you
1205 can include `AND` and `OR` expressions explicitly.
1206 For example:
1207 ```
1208 (cpuPlatform = &quot;Intel Skylake&quot;) OR
1209 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
1210 (scheduling.automaticRestart = true)
1211 ```
1212
1213 If you want to use a regular expression, use the `eq` (equal) or `ne`
1214 (not equal) operator against a single un-parenthesized expression with or
1215 without quotes or against multiple parenthesized expressions. Examples:
1216
1217 `fieldname eq unquoted literal`
1218 `fieldname eq &#x27;single quoted literal&#x27;`
1219 `fieldname eq &quot;double quoted literal&quot;`
1220 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
1221
1222 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
1223 The literal value must match the entire field.
1224
1225 For example, to filter for instances that do not end with name &quot;instance&quot;,
1226 you would use `name ne .*instance`.
1227
1228 You cannot combine constraints on multiple fields using regular
1229 expressions.
1230 maxResults: integer, The maximum number of results per page that should be returned.
1231 If the number of available results is larger than `maxResults`,
1232 Compute Engine returns a `nextPageToken` that can be used to get
1233 the next page of results in subsequent list requests. Acceptable values are
1234 `0` to `500`, inclusive. (Default: `500`)
1235 orderBy: string, Sorts list results by a certain order. By default, results
1236 are returned in alphanumerical order based on the resource name.
1237
1238 You can also sort results in descending order based on the creation
1239 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
1240 results based on the `creationTimestamp` field in
1241 reverse chronological order (newest result first). Use this to sort
1242 resources like operations so that the newest operation is returned first.
1243
1244 Currently, only sorting by `name` or
1245 `creationTimestamp desc` is supported.
1246 pageToken: string, Specifies a page token to use. Set `pageToken` to the
1247 `nextPageToken` returned by a previous list request to get
1248 the next page of results.
1249 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
1250 of failure. The default value is false.
1251
1252 For example, when partial success behavior is enabled, aggregatedList for a
1253 single zone scope either returns all resources in the zone or no resources,
1254 with an error code.
1255 x__xgafv: string, V1 error format.
1256 Allowed values
1257 1 - v1 error format
1258 2 - v2 error format
1259
1260 Returns:
1261 An object of the form:
1262
1263 { # Response for the list request.
1264 &quot;etag&quot;: &quot;A String&quot;,
1265 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
1266 &quot;items&quot;: [ # A list of wire group resources.
1267 { # A resource that represents a group of redundant wires.
1268 &quot;adminEnabled&quot;: True or False, # Indicates whether the wires in the wire group are enabled. When false, the
1269 # wires in the wire group are disabled. When true and when
1270 # there is simultaneously no wire-specific override of `adminEnabled` to
1271 # false, a given wire is enabled. Defaults to true.
1272 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1273 # text format.
1274 &quot;description&quot;: &quot;A String&quot;, # An optional description of the wire group.
1275 &quot;endpoints&quot;: { # A map that contains the logical endpoints of the wire group. Specify
1276 # key-value pairs for the map as follows:
1277 #
1278 # - Key: an RFC1035 user-specified label.
1279 # - Value: an Endpoint object.
1280 &quot;a_key&quot;: { # A logical endpoint for the wire group. An endpoint represents a metro that
1281 # contains redundant Interconnect connections. A wire group is created
1282 # between two endpoints.
1283 &quot;interconnects&quot;: { # A map that contains the redundant Interconnect connections. Specify
1284 # key-value pairs for the map as follows:
1285 #
1286 # - Key: an RFC1035 user-specified label.
1287 # - Value: an Interconnect object.
1288 &quot;a_key&quot;: { # The redundant Interconnect connections for this endpoint.
1289 &quot;interconnect&quot;: &quot;A String&quot;, # Required. An Interconnect connection. You can specify the connection as
1290 # a partial or full URL. If the connection is in a different project from
1291 # the cross-site network, use a format that specifies the project. See
1292 # the following examples of partial and full URLs:
1293 #
1294 #
1295 #
1296 # global/interconnects/NAME
1297 #
1298 #
1299 # projects/PROJECT_ID/global/interconnects/NAME
1300 #
1301 # -
1302 # https://compute.googleapis.com/compute/projects/PROJECT_ID/global/interconnects/NAME
1303 &quot;vlanTags&quot;: [ # Required. To configure the wire group for VLAN mode, enter a VLAN tag,
1304 # which is a number from `2` to `4093`. You can autoallocate a tag by
1305 # entering `0`. To configure the wire group for port mode, enter `-1`.
1306 # Review the following guidelines:
1307 #
1308 # - A VLAN tag must be unique for an Interconnect connection across all
1309 # attachments and wire groups.
1310 # - Both endpoints of a wire must use the same VLAN tag value.
1311 # - Single wire and redundant type wire groups must have only one
1312 # VLAN tag.
1313 # - Port mode pseudowires must have a single VLAN tag with a value of
1314 # `-1` for both endpoints.
1315 # - Box and cross type wire groups must have two VLAN tags. The first
1316 # is for the same-zone pseudowire, and the second is for the cross-zone
1317 # pseudowire.
1318 42,
1319 ],
1320 },
1321 },
1322 },
1323 },
1324 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource type. The server
1325 # generates this identifier.
1326 &quot;kind&quot;: &quot;compute#wireGroup&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#wireGroups for wire groups.
1327 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
1328 # The name must be 1-63 characters long, and comply withRFC1035.
1329 # Specifically, the name must be 1-63 characters long and match the regular
1330 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
1331 # character must be a lowercase letter, and all following characters must
1332 # be a dash, lowercase letter, or digit, except the last character, which
1333 # cannot be a dash.
1334 &quot;reconciling&quot;: True or False, # Output only. [Output Only] Indicates whether there are wire changes yet to be processed.
1335 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
1336 &quot;selfLinkWithId&quot;: &quot;A String&quot;,
1337 &quot;serviceLevel&quot;: { # Service level details determined for the wire group configuration. # Output only. Service level details determined for the wire group configuration.
1338 &quot;availabilityClass&quot;: &quot;A String&quot;, # Output only. [Output Only] The availability SLA that the wire group qualifies for. One
1339 # of the following: `NO_AVAILABILITY_SLA`, `AVAILABILITY_99`,
1340 # `AVAILABILITY_999`, or `AVAILABILITY_9995`.
1341 },
1342 &quot;topology&quot;: { # Topology details for the wire group. # Output only. Topology details for the wire group configuration.
1343 &quot;endpoints&quot;: [ # Output only. Topology details for all endpoints in the wire group.
1344 { # Topology details for a single wire group endpoint.
1345 &quot;city&quot;: &quot;A String&quot;, # Output only. The InterconnectLocation.city (metropolitan area designator) that all
1346 # interconnects are located in.
1347 &quot;label&quot;: &quot;A String&quot;, # Output only. Endpoint label from the wire group.
1348 },
1349 ],
1350 },
1351 &quot;wireGroupProperties&quot;: { # The properties of a wire group. These properties # Properties of the wire group.
1352 # determine how a group of redundant wires are created and managed.
1353 &quot;type&quot;: &quot;A String&quot;, # The type of the wire group, one of the following:
1354 #
1355 # - WIRE: a single pseudowire over two Interconnect connections with no
1356 # redundancy.
1357 # - REDUNDANT: two pseudowires over four Interconnect connections, with
1358 # two connections in one metro and two connections in another metro.
1359 # Each redundant pair of Interconnect connections spans both edge
1360 # availability domains of the metro. Each pseudowire connects Interconnect
1361 # connections in matching edge availability domains of the two metros.
1362 # - BOX_AND_CROSS: four pseudowires over four Interconnect connections,
1363 # with two connections in one metro and two connections in another metro.
1364 # Each redundant pair of Interconnect connections spans both edge
1365 # availability domains of the metro. Two pseudowires connect Interconnect
1366 # connections in matching edge availability domains of the two metros.
1367 # Two additional pseudowires connect the non-matching edge availability
1368 # domains of the two metros.
1369 },
1370 &quot;wireInputs&quot;: { # A map that contains optional settings for individual wires.
1371 # Specify key-value pairs for the map as follows:
1372 #
1373 # - Key: the label of an existing wire. To view a wire label and its
1374 # format, see the wires[].label field.
1375 # - Value: a WireInputs object.
1376 &quot;a_key&quot;: { # Optional settings for individual wires. Allows wire-level control that
1377 # can be useful for migration purposes. If you use this field, you opt-out
1378 # of the SLA for the wire group.
1379 &quot;adminEnabled&quot;: True or False, # Indicates whether the wire is enabled.
1380 # When false, the wire is disabled. When true and when the wire group of
1381 # the wire is also enabled, the wire is enabled. Defaults to true.
1382 &quot;wirePropertyOverrides&quot;: { # The properties of a wire. # The overridden properties for the wire. Any properties that are not
1383 # overridden are omitted from the object. Review the following guidelines:
1384 #
1385 # - If you apply wire overrides to a wire and its wire group bandwidth
1386 # configuration is set to `SHARED_WITH_WIRE_GROUP`, the
1387 # `meteredBandwidth` and `unmeteredBandwidth` properties must not differ
1388 # from the wire group.
1389 # - Overrides generate a `configurationNotice`. Ensure that differences
1390 # in wire configuration are temporary. An example use case for wire
1391 # overrides is slowly rolling out configuration changes to individual wires
1392 # in a wire group.
1393 &quot;bandwidthAllocation&quot;: &quot;A String&quot;, # The configuration of the bandwidth allocation, one of the following:
1394 #
1395 # - ALLOCATE_PER_WIRE: configures a separate unmetered bandwidth allocation
1396 # (and associated charges) for each wire in the group.
1397 # - SHARED_WITH_WIRE_GROUP: this is the default behavior, which configures
1398 # one unmetered bandwidth allocation for the wire group. The unmetered
1399 # bandwidth is divided equally across each wire in the group, but dynamic
1400 # throttling reallocates unused unmetered bandwidth from unused or underused
1401 # wires to other wires in the group.
1402 &quot;bandwidthMetered&quot;: &quot;A String&quot;, # The metered bandwidth in Gigabits per second, using decimal units. `10` is
1403 # 10 Gbps, `100` is 100 Gbps. The default value is `0`. You can specify
1404 # unlimited bandwidth by entering `-1`. However, actual data transfer is
1405 # limited by the port speed.
1406 &quot;bandwidthUnmetered&quot;: &quot;A String&quot;, # The unmetered bandwidth in Gigabits per second, using decimal units. `10`
1407 # is 10 Gbps, `100` is 100 Gbps. The bandwidth must be greater than 0.
1408 &quot;faultResponse&quot;: &quot;A String&quot;, # Response when a fault is detected in a pseudowire:
1409 #
1410 # - NONE: default.
1411 # - DISABLE_PORT: set the port line protocol down when inline probes
1412 # detect a fault. This setting is only permitted on port mode
1413 # pseudowires.
1414 &quot;networkServiceClass&quot;: &quot;A String&quot;, # The network service class.
1415 },
1416 },
1417 },
1418 &quot;wireProperties&quot;: { # The properties of a wire. # Properties for all wires in the wire group.
1419 &quot;bandwidthAllocation&quot;: &quot;A String&quot;, # The configuration of the bandwidth allocation, one of the following:
1420 #
1421 # - ALLOCATE_PER_WIRE: configures a separate unmetered bandwidth allocation
1422 # (and associated charges) for each wire in the group.
1423 # - SHARED_WITH_WIRE_GROUP: this is the default behavior, which configures
1424 # one unmetered bandwidth allocation for the wire group. The unmetered
1425 # bandwidth is divided equally across each wire in the group, but dynamic
1426 # throttling reallocates unused unmetered bandwidth from unused or underused
1427 # wires to other wires in the group.
1428 &quot;bandwidthMetered&quot;: &quot;A String&quot;, # The metered bandwidth in Gigabits per second, using decimal units. `10` is
1429 # 10 Gbps, `100` is 100 Gbps. The default value is `0`. You can specify
1430 # unlimited bandwidth by entering `-1`. However, actual data transfer is
1431 # limited by the port speed.
1432 &quot;bandwidthUnmetered&quot;: &quot;A String&quot;, # The unmetered bandwidth in Gigabits per second, using decimal units. `10`
1433 # is 10 Gbps, `100` is 100 Gbps. The bandwidth must be greater than 0.
1434 &quot;faultResponse&quot;: &quot;A String&quot;, # Response when a fault is detected in a pseudowire:
1435 #
1436 # - NONE: default.
1437 # - DISABLE_PORT: set the port line protocol down when inline probes
1438 # detect a fault. This setting is only permitted on port mode
1439 # pseudowires.
1440 &quot;networkServiceClass&quot;: &quot;A String&quot;, # The network service class.
1441 },
1442 &quot;wires&quot;: [ # Output only. The single/redundant wire(s) managed by the wire group.
1443 { # A pseudowire that connects two Interconnect connections.
1444 &quot;adminEnabled&quot;: True or False, # Output only. [Output Only] Indicates whether the wire is enabled.
1445 # When false, the wire is disabled. When true and when the wire group of
1446 # the wire is also enabled, the wire is enabled. Defaults to true.
1447 &quot;endpoints&quot;: [ # Output only. Wire endpoints are specific Interconnect connections.
1448 { # Wire endpoints are specific Interconnect connections.
1449 &quot;interconnect&quot;: &quot;A String&quot;,
1450 &quot;vlanTag&quot;: 42,
1451 },
1452 ],
1453 &quot;label&quot;: &quot;A String&quot;, # Output only. [Output Only] A label that identifies the wire. The format of this label
1454 # combines the existing labels of the wire group endpoints and Interconnect
1455 # connections used by this wire in alphabetical order as follows:
1456 # `ENDPOINT_A+CONNECTION_A1,ENDPOINT_B+CONNECTION_B1`, where:
1457 #
1458 # - ENDPOINT_A and ENDPOINT_B: are the labels
1459 # that you entered as map keys when you specified the wire group endpoint
1460 # objects.
1461 # - CONNECTION_A1 and CONNECTION_B1: are the
1462 # labels that you entered as map keys when you specified the wire group
1463 # Interconnect objects.
1464 &quot;wireProperties&quot;: { # The properties of a wire. # Output only. [Output Only] Properties of the wire.
1465 &quot;bandwidthAllocation&quot;: &quot;A String&quot;, # The configuration of the bandwidth allocation, one of the following:
1466 #
1467 # - ALLOCATE_PER_WIRE: configures a separate unmetered bandwidth allocation
1468 # (and associated charges) for each wire in the group.
1469 # - SHARED_WITH_WIRE_GROUP: this is the default behavior, which configures
1470 # one unmetered bandwidth allocation for the wire group. The unmetered
1471 # bandwidth is divided equally across each wire in the group, but dynamic
1472 # throttling reallocates unused unmetered bandwidth from unused or underused
1473 # wires to other wires in the group.
1474 &quot;bandwidthMetered&quot;: &quot;A String&quot;, # The metered bandwidth in Gigabits per second, using decimal units. `10` is
1475 # 10 Gbps, `100` is 100 Gbps. The default value is `0`. You can specify
1476 # unlimited bandwidth by entering `-1`. However, actual data transfer is
1477 # limited by the port speed.
1478 &quot;bandwidthUnmetered&quot;: &quot;A String&quot;, # The unmetered bandwidth in Gigabits per second, using decimal units. `10`
1479 # is 10 Gbps, `100` is 100 Gbps. The bandwidth must be greater than 0.
1480 &quot;faultResponse&quot;: &quot;A String&quot;, # Response when a fault is detected in a pseudowire:
1481 #
1482 # - NONE: default.
1483 # - DISABLE_PORT: set the port line protocol down when inline probes
1484 # detect a fault. This setting is only permitted on port mode
1485 # pseudowires.
1486 &quot;networkServiceClass&quot;: &quot;A String&quot;, # The network service class.
1487 },
1488 },
1489 ],
1490 },
1491 ],
1492 &quot;kind&quot;: &quot;compute#wireGroup&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#wireGroups for wire groups.
1493 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
1494 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
1495 # the query parameter pageToken in the next list request.
1496 # Subsequent list requests will have their own nextPageToken to
1497 # continue paging through the results.
1498 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource.
1499 &quot;unreachables&quot;: [ # Output only. [Output Only] Unreachable resources.
1500 # end_interface: MixerListResponseWithEtagBuilder
1501 &quot;A String&quot;,
1502 ],
1503 &quot;warning&quot;: { # [Output Only] Informational warning message.
1504 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1505 # Engine returns NO_RESULTS_ON_PAGE if there
1506 # are no results in the response.
1507 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1508 # value format. For example:
1509 #
1510 # &quot;data&quot;: [
1511 # {
1512 # &quot;key&quot;: &quot;scope&quot;,
1513 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1514 # }
1515 {
1516 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1517 # returned. For example, for warnings where there are no results in a list
1518 # request for a particular zone, this key might be scope and
1519 # the key value might be the zone name. Other examples might be a key
1520 # indicating a deprecated resource and a suggested replacement, or a
1521 # warning about invalid network settings (for example, if an instance
1522 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1523 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1524 },
1525 ],
1526 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1527 },
1528 }</pre>
1529 </div>
1530
1531 <div class="method">
1532 <code class="details" id="list_next">list_next()</code>
1533 <pre>Retrieves the next page of results.
1534
1535 Args:
1536 previous_request: The request for the previous page. (required)
1537 previous_response: The response from the request for the previous page. (required)
1538
1539 Returns:
1540 A request object that you can call &#x27;execute()&#x27; on to request the next
1541 page. Returns None if there are no more items in the collection.
1542 </pre>
1543 </div>
1544
1545 <div class="method">
1546 <code class="details" id="patch">patch(project, crossSiteNetwork, wireGroup, body=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None)</code>
1547 <pre>Updates the specified wire group resource with the data included in the
1548 request. This method supportsPATCH
1549 semantics and usesJSON merge
1550 patch format and processing rules.
1551
1552 Args:
1553 project: string, Project ID for this request. (required)
1554 crossSiteNetwork: string, A parameter (required)
1555 wireGroup: string, Name of the WireGroups resource to patch. (required)
1556 body: object, The request body.
1557 The object takes the form of:
1558
1559 { # A resource that represents a group of redundant wires.
1560 &quot;adminEnabled&quot;: True or False, # Indicates whether the wires in the wire group are enabled. When false, the
1561 # wires in the wire group are disabled. When true and when
1562 # there is simultaneously no wire-specific override of `adminEnabled` to
1563 # false, a given wire is enabled. Defaults to true.
1564 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1565 # text format.
1566 &quot;description&quot;: &quot;A String&quot;, # An optional description of the wire group.
1567 &quot;endpoints&quot;: { # A map that contains the logical endpoints of the wire group. Specify
1568 # key-value pairs for the map as follows:
1569 #
1570 # - Key: an RFC1035 user-specified label.
1571 # - Value: an Endpoint object.
1572 &quot;a_key&quot;: { # A logical endpoint for the wire group. An endpoint represents a metro that
1573 # contains redundant Interconnect connections. A wire group is created
1574 # between two endpoints.
1575 &quot;interconnects&quot;: { # A map that contains the redundant Interconnect connections. Specify
1576 # key-value pairs for the map as follows:
1577 #
1578 # - Key: an RFC1035 user-specified label.
1579 # - Value: an Interconnect object.
1580 &quot;a_key&quot;: { # The redundant Interconnect connections for this endpoint.
1581 &quot;interconnect&quot;: &quot;A String&quot;, # Required. An Interconnect connection. You can specify the connection as
1582 # a partial or full URL. If the connection is in a different project from
1583 # the cross-site network, use a format that specifies the project. See
1584 # the following examples of partial and full URLs:
1585 #
1586 #
1587 #
1588 # global/interconnects/NAME
1589 #
1590 #
1591 # projects/PROJECT_ID/global/interconnects/NAME
1592 #
1593 # -
1594 # https://compute.googleapis.com/compute/projects/PROJECT_ID/global/interconnects/NAME
1595 &quot;vlanTags&quot;: [ # Required. To configure the wire group for VLAN mode, enter a VLAN tag,
1596 # which is a number from `2` to `4093`. You can autoallocate a tag by
1597 # entering `0`. To configure the wire group for port mode, enter `-1`.
1598 # Review the following guidelines:
1599 #
1600 # - A VLAN tag must be unique for an Interconnect connection across all
1601 # attachments and wire groups.
1602 # - Both endpoints of a wire must use the same VLAN tag value.
1603 # - Single wire and redundant type wire groups must have only one
1604 # VLAN tag.
1605 # - Port mode pseudowires must have a single VLAN tag with a value of
1606 # `-1` for both endpoints.
1607 # - Box and cross type wire groups must have two VLAN tags. The first
1608 # is for the same-zone pseudowire, and the second is for the cross-zone
1609 # pseudowire.
1610 42,
1611 ],
1612 },
1613 },
1614 },
1615 },
1616 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource type. The server
1617 # generates this identifier.
1618 &quot;kind&quot;: &quot;compute#wireGroup&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#wireGroups for wire groups.
1619 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
1620 # The name must be 1-63 characters long, and comply withRFC1035.
1621 # Specifically, the name must be 1-63 characters long and match the regular
1622 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
1623 # character must be a lowercase letter, and all following characters must
1624 # be a dash, lowercase letter, or digit, except the last character, which
1625 # cannot be a dash.
1626 &quot;reconciling&quot;: True or False, # Output only. [Output Only] Indicates whether there are wire changes yet to be processed.
1627 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
1628 &quot;selfLinkWithId&quot;: &quot;A String&quot;,
1629 &quot;serviceLevel&quot;: { # Service level details determined for the wire group configuration. # Output only. Service level details determined for the wire group configuration.
1630 &quot;availabilityClass&quot;: &quot;A String&quot;, # Output only. [Output Only] The availability SLA that the wire group qualifies for. One
1631 # of the following: `NO_AVAILABILITY_SLA`, `AVAILABILITY_99`,
1632 # `AVAILABILITY_999`, or `AVAILABILITY_9995`.
1633 },
1634 &quot;topology&quot;: { # Topology details for the wire group. # Output only. Topology details for the wire group configuration.
1635 &quot;endpoints&quot;: [ # Output only. Topology details for all endpoints in the wire group.
1636 { # Topology details for a single wire group endpoint.
1637 &quot;city&quot;: &quot;A String&quot;, # Output only. The InterconnectLocation.city (metropolitan area designator) that all
1638 # interconnects are located in.
1639 &quot;label&quot;: &quot;A String&quot;, # Output only. Endpoint label from the wire group.
1640 },
1641 ],
1642 },
1643 &quot;wireGroupProperties&quot;: { # The properties of a wire group. These properties # Properties of the wire group.
1644 # determine how a group of redundant wires are created and managed.
1645 &quot;type&quot;: &quot;A String&quot;, # The type of the wire group, one of the following:
1646 #
1647 # - WIRE: a single pseudowire over two Interconnect connections with no
1648 # redundancy.
1649 # - REDUNDANT: two pseudowires over four Interconnect connections, with
1650 # two connections in one metro and two connections in another metro.
1651 # Each redundant pair of Interconnect connections spans both edge
1652 # availability domains of the metro. Each pseudowire connects Interconnect
1653 # connections in matching edge availability domains of the two metros.
1654 # - BOX_AND_CROSS: four pseudowires over four Interconnect connections,
1655 # with two connections in one metro and two connections in another metro.
1656 # Each redundant pair of Interconnect connections spans both edge
1657 # availability domains of the metro. Two pseudowires connect Interconnect
1658 # connections in matching edge availability domains of the two metros.
1659 # Two additional pseudowires connect the non-matching edge availability
1660 # domains of the two metros.
1661 },
1662 &quot;wireInputs&quot;: { # A map that contains optional settings for individual wires.
1663 # Specify key-value pairs for the map as follows:
1664 #
1665 # - Key: the label of an existing wire. To view a wire label and its
1666 # format, see the wires[].label field.
1667 # - Value: a WireInputs object.
1668 &quot;a_key&quot;: { # Optional settings for individual wires. Allows wire-level control that
1669 # can be useful for migration purposes. If you use this field, you opt-out
1670 # of the SLA for the wire group.
1671 &quot;adminEnabled&quot;: True or False, # Indicates whether the wire is enabled.
1672 # When false, the wire is disabled. When true and when the wire group of
1673 # the wire is also enabled, the wire is enabled. Defaults to true.
1674 &quot;wirePropertyOverrides&quot;: { # The properties of a wire. # The overridden properties for the wire. Any properties that are not
1675 # overridden are omitted from the object. Review the following guidelines:
1676 #
1677 # - If you apply wire overrides to a wire and its wire group bandwidth
1678 # configuration is set to `SHARED_WITH_WIRE_GROUP`, the
1679 # `meteredBandwidth` and `unmeteredBandwidth` properties must not differ
1680 # from the wire group.
1681 # - Overrides generate a `configurationNotice`. Ensure that differences
1682 # in wire configuration are temporary. An example use case for wire
1683 # overrides is slowly rolling out configuration changes to individual wires
1684 # in a wire group.
1685 &quot;bandwidthAllocation&quot;: &quot;A String&quot;, # The configuration of the bandwidth allocation, one of the following:
1686 #
1687 # - ALLOCATE_PER_WIRE: configures a separate unmetered bandwidth allocation
1688 # (and associated charges) for each wire in the group.
1689 # - SHARED_WITH_WIRE_GROUP: this is the default behavior, which configures
1690 # one unmetered bandwidth allocation for the wire group. The unmetered
1691 # bandwidth is divided equally across each wire in the group, but dynamic
1692 # throttling reallocates unused unmetered bandwidth from unused or underused
1693 # wires to other wires in the group.
1694 &quot;bandwidthMetered&quot;: &quot;A String&quot;, # The metered bandwidth in Gigabits per second, using decimal units. `10` is
1695 # 10 Gbps, `100` is 100 Gbps. The default value is `0`. You can specify
1696 # unlimited bandwidth by entering `-1`. However, actual data transfer is
1697 # limited by the port speed.
1698 &quot;bandwidthUnmetered&quot;: &quot;A String&quot;, # The unmetered bandwidth in Gigabits per second, using decimal units. `10`
1699 # is 10 Gbps, `100` is 100 Gbps. The bandwidth must be greater than 0.
1700 &quot;faultResponse&quot;: &quot;A String&quot;, # Response when a fault is detected in a pseudowire:
1701 #
1702 # - NONE: default.
1703 # - DISABLE_PORT: set the port line protocol down when inline probes
1704 # detect a fault. This setting is only permitted on port mode
1705 # pseudowires.
1706 &quot;networkServiceClass&quot;: &quot;A String&quot;, # The network service class.
1707 },
1708 },
1709 },
1710 &quot;wireProperties&quot;: { # The properties of a wire. # Properties for all wires in the wire group.
1711 &quot;bandwidthAllocation&quot;: &quot;A String&quot;, # The configuration of the bandwidth allocation, one of the following:
1712 #
1713 # - ALLOCATE_PER_WIRE: configures a separate unmetered bandwidth allocation
1714 # (and associated charges) for each wire in the group.
1715 # - SHARED_WITH_WIRE_GROUP: this is the default behavior, which configures
1716 # one unmetered bandwidth allocation for the wire group. The unmetered
1717 # bandwidth is divided equally across each wire in the group, but dynamic
1718 # throttling reallocates unused unmetered bandwidth from unused or underused
1719 # wires to other wires in the group.
1720 &quot;bandwidthMetered&quot;: &quot;A String&quot;, # The metered bandwidth in Gigabits per second, using decimal units. `10` is
1721 # 10 Gbps, `100` is 100 Gbps. The default value is `0`. You can specify
1722 # unlimited bandwidth by entering `-1`. However, actual data transfer is
1723 # limited by the port speed.
1724 &quot;bandwidthUnmetered&quot;: &quot;A String&quot;, # The unmetered bandwidth in Gigabits per second, using decimal units. `10`
1725 # is 10 Gbps, `100` is 100 Gbps. The bandwidth must be greater than 0.
1726 &quot;faultResponse&quot;: &quot;A String&quot;, # Response when a fault is detected in a pseudowire:
1727 #
1728 # - NONE: default.
1729 # - DISABLE_PORT: set the port line protocol down when inline probes
1730 # detect a fault. This setting is only permitted on port mode
1731 # pseudowires.
1732 &quot;networkServiceClass&quot;: &quot;A String&quot;, # The network service class.
1733 },
1734 &quot;wires&quot;: [ # Output only. The single/redundant wire(s) managed by the wire group.
1735 { # A pseudowire that connects two Interconnect connections.
1736 &quot;adminEnabled&quot;: True or False, # Output only. [Output Only] Indicates whether the wire is enabled.
1737 # When false, the wire is disabled. When true and when the wire group of
1738 # the wire is also enabled, the wire is enabled. Defaults to true.
1739 &quot;endpoints&quot;: [ # Output only. Wire endpoints are specific Interconnect connections.
1740 { # Wire endpoints are specific Interconnect connections.
1741 &quot;interconnect&quot;: &quot;A String&quot;,
1742 &quot;vlanTag&quot;: 42,
1743 },
1744 ],
1745 &quot;label&quot;: &quot;A String&quot;, # Output only. [Output Only] A label that identifies the wire. The format of this label
1746 # combines the existing labels of the wire group endpoints and Interconnect
1747 # connections used by this wire in alphabetical order as follows:
1748 # `ENDPOINT_A+CONNECTION_A1,ENDPOINT_B+CONNECTION_B1`, where:
1749 #
1750 # - ENDPOINT_A and ENDPOINT_B: are the labels
1751 # that you entered as map keys when you specified the wire group endpoint
1752 # objects.
1753 # - CONNECTION_A1 and CONNECTION_B1: are the
1754 # labels that you entered as map keys when you specified the wire group
1755 # Interconnect objects.
1756 &quot;wireProperties&quot;: { # The properties of a wire. # Output only. [Output Only] Properties of the wire.
1757 &quot;bandwidthAllocation&quot;: &quot;A String&quot;, # The configuration of the bandwidth allocation, one of the following:
1758 #
1759 # - ALLOCATE_PER_WIRE: configures a separate unmetered bandwidth allocation
1760 # (and associated charges) for each wire in the group.
1761 # - SHARED_WITH_WIRE_GROUP: this is the default behavior, which configures
1762 # one unmetered bandwidth allocation for the wire group. The unmetered
1763 # bandwidth is divided equally across each wire in the group, but dynamic
1764 # throttling reallocates unused unmetered bandwidth from unused or underused
1765 # wires to other wires in the group.
1766 &quot;bandwidthMetered&quot;: &quot;A String&quot;, # The metered bandwidth in Gigabits per second, using decimal units. `10` is
1767 # 10 Gbps, `100` is 100 Gbps. The default value is `0`. You can specify
1768 # unlimited bandwidth by entering `-1`. However, actual data transfer is
1769 # limited by the port speed.
1770 &quot;bandwidthUnmetered&quot;: &quot;A String&quot;, # The unmetered bandwidth in Gigabits per second, using decimal units. `10`
1771 # is 10 Gbps, `100` is 100 Gbps. The bandwidth must be greater than 0.
1772 &quot;faultResponse&quot;: &quot;A String&quot;, # Response when a fault is detected in a pseudowire:
1773 #
1774 # - NONE: default.
1775 # - DISABLE_PORT: set the port line protocol down when inline probes
1776 # detect a fault. This setting is only permitted on port mode
1777 # pseudowires.
1778 &quot;networkServiceClass&quot;: &quot;A String&quot;, # The network service class.
1779 },
1780 },
1781 ],
1782 }
1783
1784 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1785 that if you must retry your request, the server will know to ignore the
1786 request if it has already been completed.
1787
1788 For example, consider a situation where you make an initial request and
1789 the request times out. If you make the request again with the same
1790 request ID, the server can check if original operation with the same
1791 request ID was received, and if so, will ignore the second request. This
1792 prevents clients from accidentally creating duplicate commitments.
1793
1794 The request ID must be
1795 a valid UUID with the exception that zero UUID is not supported
1796 (00000000-0000-0000-0000-000000000000).
1797 end_interface: MixerMutationRequestBuilder
1798 updateMask: string, update_mask indicates fields to be updated as part of this request.
1799 validateOnly: boolean, [Input Only] Validate the new configuration, but don&#x27;t update it.
1800 x__xgafv: string, V1 error format.
1801 Allowed values
1802 1 - v1 error format
1803 2 - v2 error format
1804
1805 Returns:
1806 An object of the form:
1807
1808 { # Represents an Operation resource.
1809 #
1810 # Google Compute Engine has three Operation resources:
1811 #
1812 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
1813 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
1814 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
1815 #
1816 # You can use an operation resource to manage asynchronous API requests.
1817 # For more information, readHandling
1818 # API responses.
1819 #
1820 # Operations can be global, regional or zonal.
1821 #
1822 # - For global operations, use the `globalOperations`
1823 # resource.
1824 # - For regional operations, use the
1825 # `regionOperations` resource.
1826 # - For zonal operations, use
1827 # the `zoneOperations` resource.
1828 #
1829 #
1830 #
1831 # For more information, read
1832 # Global, Regional, and Zonal Resources.
1833 #
1834 # Note that completed Operation resources have a limited
1835 # retention period.
1836 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1837 # Not present otherwise.
1838 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1839 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1840 # set when the operation is created.
1841 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1842 # text format.
1843 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1844 # this field will be populated.
1845 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1846 # operation.
1847 {
1848 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1849 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1850 # details. There is a set of defined message types to use for providing
1851 # details.The syntax depends on the error code. For example,
1852 # QuotaExceededInfo will have details when the error code is
1853 # QUOTA_EXCEEDED.
1854 {
1855 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1856 #
1857 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1858 # is not enabled:
1859 #
1860 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1861 # &quot;domain&quot;: &quot;googleapis.com&quot;
1862 # &quot;metadata&quot;: {
1863 # &quot;resource&quot;: &quot;projects/123&quot;,
1864 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1865 # }
1866 # }
1867 #
1868 # This response indicates that the pubsub.googleapis.com API is not enabled.
1869 #
1870 # Example of an error that is returned when attempting to create a Spanner
1871 # instance in a region that is out of stock:
1872 #
1873 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1874 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1875 # &quot;metadata&quot;: {
1876 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1877 # }
1878 # }
1879 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1880 # is typically the registered service name of the tool or product that
1881 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1882 # generated by some common infrastructure, the error domain must be a
1883 # globally unique value that identifies the infrastructure. For Google API
1884 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1885 &quot;metadatas&quot;: { # Additional structured details about this error.
1886 #
1887 # Keys must match a regular expression of `a-z+` but should
1888 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1889 # length. When identifying the current value of an exceeded limit, the units
1890 # should be contained in the key, not the value. For example, rather than
1891 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1892 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1893 # instances that can be created in a single (batch) request.
1894 &quot;a_key&quot;: &quot;A String&quot;,
1895 },
1896 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1897 # proximate cause of the error. Error reasons are unique within a particular
1898 # domain of errors. This should be at most 63 characters and match a
1899 # regular expression of `A-Z+[A-Z0-9]`, which represents
1900 # UPPER_SNAKE_CASE.
1901 },
1902 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1903 #
1904 # For example, if a quota check failed with an error indicating the calling
1905 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1906 # directly to the right place in the developer console to flip the bit.
1907 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1908 { # Describes a URL link.
1909 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1910 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1911 },
1912 ],
1913 },
1914 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1915 # which can be attached to an RPC error.
1916 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1917 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1918 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1919 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1920 },
1921 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1922 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1923 &quot;a_key&quot;: &quot;A String&quot;,
1924 },
1925 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1926 # type or metric.
1927 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1928 # or metric.
1929 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1930 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1931 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1932 },
1933 },
1934 ],
1935 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1936 # This property is optional.
1937 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1938 },
1939 ],
1940 },
1941 &quot;getVersionOperationMetadata&quot;: {
1942 &quot;inlineSbomInfo&quot;: {
1943 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1944 # appropriate identifiers.
1945 &quot;a_key&quot;: &quot;A String&quot;,
1946 },
1947 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1948 # identifiers.
1949 &quot;a_key&quot;: &quot;A String&quot;,
1950 },
1951 },
1952 },
1953 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1954 # message that was returned, such as `NOT FOUND`.
1955 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1956 # status code that was returned. For example, a `404` means the
1957 # resource was not found.
1958 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1959 # defined by the server.
1960 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1961 # This value is inRFC3339
1962 # text format.
1963 &quot;instancesBulkInsertOperationMetadata&quot;: {
1964 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1965 # Example key: zones/us-central1-a
1966 &quot;a_key&quot;: {
1967 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1968 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1969 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1970 # error.
1971 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1972 # if the flow is rolling forward or rolling back.
1973 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1974 },
1975 },
1976 },
1977 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1978 # Operation resources.
1979 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1980 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1981 # group of operations results from a `bulkInsert` API request.
1982 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1983 # `update`, or `delete`, and so on.
1984 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1985 # There is no requirement that this be linear or support any granularity of
1986 # operations. This should not be used to guess when the operation will be
1987 # complete. This number should monotonically increase as the operation
1988 # progresses.
1989 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1990 # applicable when performing regional operations.
1991 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1992 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
1993 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1994 # this field will contain information on all underlying zonal actions and
1995 # their state.
1996 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1997 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1998 # Example key: zones/us-central1-a
1999 &quot;a_key&quot;: {
2000 &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
2001 # populated.
2002 # different programming environments, including REST APIs and RPC APIs. It is
2003 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
2004 # three pieces of data: error code, error message, and error details.
2005 #
2006 # You can find out more about this error model and how to work with it in the
2007 # [API Design Guide](https://cloud.google.com/apis/design/errors).
2008 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
2009 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
2010 # message types for APIs to use.
2011 {
2012 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
2013 },
2014 ],
2015 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
2016 # user-facing error message should be localized and sent in the
2017 # google.rpc.Status.details field, or localized by the client.
2018 },
2019 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
2020 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
2021 },
2022 },
2023 },
2024 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
2025 # This value is inRFC3339
2026 # text format.
2027 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
2028 # following:
2029 # `PENDING`, `RUNNING`, or `DONE`.
2030 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
2031 # operation.
2032 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
2033 # of the target resource.
2034 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
2035 # operations related to creating a snapshot, this points to the disk
2036 # that the snapshot was created from.
2037 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
2038 # `[email protected]` or
2039 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
2040 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
2041 # operation, this field will be populated.
2042 {
2043 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2044 # Engine returns NO_RESULTS_ON_PAGE if there
2045 # are no results in the response.
2046 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2047 # value format. For example:
2048 #
2049 # &quot;data&quot;: [
2050 # {
2051 # &quot;key&quot;: &quot;scope&quot;,
2052 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2053 # }
2054 {
2055 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2056 # returned. For example, for warnings where there are no results in a list
2057 # request for a particular zone, this key might be scope and
2058 # the key value might be the zone name. Other examples might be a key
2059 # indicating a deprecated resource and a suggested replacement, or a
2060 # warning about invalid network settings (for example, if an instance
2061 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2062 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2063 },
2064 ],
2065 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2066 },
2067 ],
2068 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
2069 # applicable when performing per-zone operations.
2070 }</pre>
2071 </div>
2072
2073 </body></html>