Debian Codegraph @

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