Debian Codegraph @

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