Debian Codegraph @

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