Debian Codegraph @

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