Debian Codegraph @

docs/dyn/compute_alpha.networkEdgeSecurityServices.html

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