Debian Codegraph @

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