Debian Codegraph @

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