Debian Codegraph @

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