Debian Codegraph @

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