Debian Codegraph @

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