Debian Codegraph @

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