Debian Codegraph @

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