Debian Codegraph @

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