Debian Codegraph @

docs/dyn/compute_beta.reservationSlots.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="compute_beta.html">Compute Engine API</a> . <a href="compute_beta.reservationSlots.html">reservationSlots</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#get">get(project, zone, parentName, reservationSlot, x__xgafv=None)</a></code></p>
82 <p class="firstline">Retrieves information about the specified reservation slot.</p>
83 <p class="toc_element">
84 <code><a href="#getVersion">getVersion(project, zone, parentName, reservationSlot, body=None, requestId=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Allows customers to get SBOM versions of a reservation slot.</p>
86 <p class="toc_element">
87 <code><a href="#list">list(project, zone, parentName, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Retrieves a list of reservation slots under a single reservation.</p>
89 <p class="toc_element">
90 <code><a href="#list_next">list_next()</a></code></p>
91 <p class="firstline">Retrieves the next page of results.</p>
92 <p class="toc_element">
93 <code><a href="#update">update(project, zone, parentName, reservationSlot, body=None, updateMask=None, x__xgafv=None)</a></code></p>
94 <p class="firstline">Update a reservation slot in the specified sub-block.</p>
95 <h3>Method Details</h3>
96 <div class="method">
97 <code class="details" id="close">close()</code>
98 <pre>Close httplib2 connections.</pre>
99 </div>
100
101 <div class="method">
102 <code class="details" id="get">get(project, zone, parentName, reservationSlot, x__xgafv=None)</code>
103 <pre>Retrieves information about the specified reservation slot.
104
105 Args:
106 project: string, The project ID for this request. (required)
107 zone: string, The name of the zone for this request, formatted as RFC1035. (required)
108 parentName: string, The name of the parent reservation and parent block, formatted as
109 reservations/{reservation_name}/reservationBlocks/{reservation_block_name}/reservationSubBlocks/{reservation_sub_block_name} (required)
110 reservationSlot: string, The name of the reservation slot, formatted as RFC1035 or a resource ID
111 number. (required)
112 x__xgafv: string, V1 error format.
113 Allowed values
114 1 - v1 error format
115 2 - v2 error format
116
117 Returns:
118 An object of the form:
119
120 {
121 &quot;resource&quot;: { # Represents a reservation slot resource.
122 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] The creation timestamp, formatted asRFC3339 text.
123 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for this resource. This identifier is
124 # defined by the server.
125 &quot;kind&quot;: &quot;compute#reservationSlot&quot;, # Output only. [Output Only] The type of resource. Alwayscompute#reservationSlot for reservation slots.
126 &quot;name&quot;: &quot;A String&quot;, # Output only. [Output Only] The name of the reservation slot.
127 &quot;physicalTopology&quot;: { # Output only. [Output Only] The physical topology of the reservation slot.
128 &quot;block&quot;: &quot;A String&quot;, # The unique identifier of the capacity block within the cluster.
129 &quot;cluster&quot;: &quot;A String&quot;, # The cluster name of the reservation sub-block.
130 &quot;host&quot;: &quot;A String&quot;, # The unique identifier of the capacity host within the capacity sub-block.
131 &quot;subBlock&quot;: &quot;A String&quot;, # The unique identifier of the capacity sub-block within the capacity
132 # block.
133 },
134 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] A server-defined fully-qualified URL for this resource.
135 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] A server-defined URL for this resource with the resource ID.
136 &quot;shareSettings&quot;: { # The share setting for reservations and sole tenancy node groups. # Specify share settings to create a shared slot. Set to empty
137 # to inherit the share settings from a parent resource.
138 &quot;folderMap&quot;: { # A map of folder id and folder config to specify consumer projects for this
139 # shared-reservation. This is only valid when share_type&#x27;s value is
140 # DIRECT_PROJECTS_UNDER_SPECIFIC_FOLDERS.
141 # Folder id should be a string of number, and without &quot;folders/&quot; prefix.
142 &quot;a_key&quot;: { # Config for each folder in the share settings.
143 &quot;folderId&quot;: &quot;A String&quot;, # The folder ID, should be same as the key of this folder config in the
144 # parent map.
145 # Folder id should be a string of number, and without &quot;folders/&quot; prefix.
146 },
147 },
148 &quot;projectMap&quot;: { # A map of project id and project config. This is only valid when
149 # share_type&#x27;s value is SPECIFIC_PROJECTS.
150 &quot;a_key&quot;: { # Config for each project in the share settings.
151 &quot;projectId&quot;: &quot;A String&quot;, # The project ID, should be same as the key of this project config in the
152 # parent map.
153 },
154 },
155 &quot;projects&quot;: [ # A List of Project names to specify consumer projects for this
156 # shared-reservation. This is only valid when share_type&#x27;s value is
157 # SPECIFIC_PROJECTS.
158 &quot;A String&quot;,
159 ],
160 &quot;shareType&quot;: &quot;A String&quot;, # Type of sharing for this shared-reservation
161 },
162 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] The state of the reservation slot.
163 &quot;status&quot;: { # Output only. [Output Only] The status of the reservation slot.
164 &quot;physicalTopology&quot;: { # Output only. [Output Only] The physical topology of the reservation sub-block.
165 &quot;block&quot;: &quot;A String&quot;, # The unique identifier of the capacity block within the cluster.
166 &quot;cluster&quot;: &quot;A String&quot;, # The cluster name of the reservation sub-block.
167 &quot;host&quot;: &quot;A String&quot;, # The unique identifier of the capacity host within the capacity sub-block.
168 &quot;subBlock&quot;: &quot;A String&quot;, # The unique identifier of the capacity sub-block within the capacity
169 # block.
170 },
171 &quot;rdmaIpAddresses&quot;: [ # Output only. The RDMA IP address of the physical host.
172 &quot;A String&quot;,
173 ],
174 &quot;runningInstances&quot;: [ # Output only. The URIs of the instances currently running on this slot.
175 &quot;A String&quot;,
176 ],
177 },
178 &quot;zone&quot;: &quot;A String&quot;, # Output only. [Output Only] The zone in which the reservation slot resides.
179 },
180 }</pre>
181 </div>
182
183 <div class="method">
184 <code class="details" id="getVersion">getVersion(project, zone, parentName, reservationSlot, body=None, requestId=None, x__xgafv=None)</code>
185 <pre>Allows customers to get SBOM versions of a reservation slot.
186
187 Args:
188 project: string, Project ID for this request. (required)
189 zone: string, Name of the zone for this request. Zone name should conform to RFC1035. (required)
190 parentName: string, The name of the parent reservation and parent block. In the format of
191 reservations/{reservation_name}/reservationBlocks/{reservation_block_name}/reservationSubBlocks/{reservation_sub_block_name} (required)
192 reservationSlot: string, The name of the reservation slot.
193 Name should conform to RFC1035 or be a resource ID. (required)
194 body: object, The request body.
195 The object takes the form of:
196
197 {
198 &quot;sbomSelections&quot;: [ # The SBOM selection to return. Duplicate values in the list will be ignored.
199 &quot;A String&quot;,
200 ],
201 }
202
203 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
204 that if you must retry your request, the server will know to ignore the
205 request if it has already been completed.
206
207 For example, consider a situation where you make an initial request and
208 the request times out. If you make the request again with the same
209 request ID, the server can check if original operation with the same
210 request ID was received, and if so, will ignore the second request. This
211 prevents clients from accidentally creating duplicate commitments.
212
213 The request ID must be
214 a valid UUID with the exception that zero UUID is not supported
215 (00000000-0000-0000-0000-000000000000).
216 x__xgafv: string, V1 error format.
217 Allowed values
218 1 - v1 error format
219 2 - v2 error format
220
221 Returns:
222 An object of the form:
223
224 { # Represents an Operation resource.
225 #
226 # Google Compute Engine has three Operation resources:
227 #
228 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
229 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
230 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
231 #
232 # You can use an operation resource to manage asynchronous API requests.
233 # For more information, readHandling
234 # API responses.
235 #
236 # Operations can be global, regional or zonal.
237 #
238 # - For global operations, use the `globalOperations`
239 # resource.
240 # - For regional operations, use the
241 # `regionOperations` resource.
242 # - For zonal operations, use
243 # the `zoneOperations` resource.
244 #
245 #
246 #
247 # For more information, read
248 # Global, Regional, and Zonal Resources.
249 #
250 # Note that completed Operation resources have a limited
251 # retention period.
252 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
253 # Not present otherwise.
254 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
255 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
256 # set when the operation is created.
257 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
258 # text format.
259 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
260 # this field will be populated.
261 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
262 # operation.
263 {
264 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
265 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
266 # details. There is a set of defined message types to use for providing
267 # details.The syntax depends on the error code. For example,
268 # QuotaExceededInfo will have details when the error code is
269 # QUOTA_EXCEEDED.
270 {
271 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
272 #
273 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
274 # is not enabled:
275 #
276 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
277 # &quot;domain&quot;: &quot;googleapis.com&quot;
278 # &quot;metadata&quot;: {
279 # &quot;resource&quot;: &quot;projects/123&quot;,
280 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
281 # }
282 # }
283 #
284 # This response indicates that the pubsub.googleapis.com API is not enabled.
285 #
286 # Example of an error that is returned when attempting to create a Spanner
287 # instance in a region that is out of stock:
288 #
289 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
290 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
291 # &quot;metadata&quot;: {
292 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
293 # }
294 # }
295 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
296 # is typically the registered service name of the tool or product that
297 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
298 # generated by some common infrastructure, the error domain must be a
299 # globally unique value that identifies the infrastructure. For Google API
300 # infrastructure, the error domain is &quot;googleapis.com&quot;.
301 &quot;metadatas&quot;: { # Additional structured details about this error.
302 #
303 # Keys must match a regular expression of `a-z+` but should
304 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
305 # length. When identifying the current value of an exceeded limit, the units
306 # should be contained in the key, not the value. For example, rather than
307 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
308 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
309 # instances that can be created in a single (batch) request.
310 &quot;a_key&quot;: &quot;A String&quot;,
311 },
312 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
313 # proximate cause of the error. Error reasons are unique within a particular
314 # domain of errors. This should be at most 63 characters and match a
315 # regular expression of `A-Z+[A-Z0-9]`, which represents
316 # UPPER_SNAKE_CASE.
317 },
318 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
319 #
320 # For example, if a quota check failed with an error indicating the calling
321 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
322 # directly to the right place in the developer console to flip the bit.
323 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
324 { # Describes a URL link.
325 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
326 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
327 },
328 ],
329 },
330 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
331 # which can be attached to an RPC error.
332 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
333 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
334 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
335 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
336 },
337 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
338 &quot;dimensions&quot;: { # The map holding related quota dimensions.
339 &quot;a_key&quot;: &quot;A String&quot;,
340 },
341 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
342 # type or metric.
343 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
344 # or metric.
345 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
346 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
347 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
348 },
349 },
350 ],
351 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
352 # This property is optional.
353 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
354 },
355 ],
356 },
357 &quot;getVersionOperationMetadata&quot;: {
358 &quot;inlineSbomInfo&quot;: {
359 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
360 # appropriate identifiers.
361 &quot;a_key&quot;: &quot;A String&quot;,
362 },
363 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
364 # identifiers.
365 &quot;a_key&quot;: &quot;A String&quot;,
366 },
367 },
368 },
369 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
370 # message that was returned, such as `NOT FOUND`.
371 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
372 # status code that was returned. For example, a `404` means the
373 # resource was not found.
374 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
375 # defined by the server.
376 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
377 # This value is inRFC3339
378 # text format.
379 &quot;instancesBulkInsertOperationMetadata&quot;: {
380 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
381 # Example key: zones/us-central1-a
382 &quot;a_key&quot;: {
383 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
384 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
385 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
386 # error.
387 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
388 # if the flow is rolling forward or rolling back.
389 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
390 },
391 },
392 },
393 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
394 # Operation resources.
395 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
396 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
397 # group of operations results from a `bulkInsert` API request.
398 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
399 # `update`, or `delete`, and so on.
400 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
401 # There is no requirement that this be linear or support any granularity of
402 # operations. This should not be used to guess when the operation will be
403 # complete. This number should monotonically increase as the operation
404 # progresses.
405 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
406 # applicable when performing regional operations.
407 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
408 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
409 # this field will contain information on all underlying zonal actions and
410 # their state.
411 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
412 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
413 # Example key: zones/us-central1-a
414 &quot;a_key&quot;: {
415 &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
416 # populated.
417 # different programming environments, including REST APIs and RPC APIs. It is
418 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
419 # three pieces of data: error code, error message, and error details.
420 #
421 # You can find out more about this error model and how to work with it in the
422 # [API Design Guide](https://cloud.google.com/apis/design/errors).
423 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
424 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
425 # message types for APIs to use.
426 {
427 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
428 },
429 ],
430 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
431 # user-facing error message should be localized and sent in the
432 # google.rpc.Status.details field, or localized by the client.
433 },
434 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
435 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
436 },
437 },
438 },
439 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
440 # This value is inRFC3339
441 # text format.
442 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
443 # following:
444 # `PENDING`, `RUNNING`, or `DONE`.
445 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
446 # operation.
447 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
448 # of the target resource.
449 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
450 # operations related to creating a snapshot, this points to the disk
451 # that the snapshot was created from.
452 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
453 # `[email protected]` or
454 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
455 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
456 # operation, this field will be populated.
457 {
458 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
459 # Engine returns NO_RESULTS_ON_PAGE if there
460 # are no results in the response.
461 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
462 # value format. For example:
463 #
464 # &quot;data&quot;: [
465 # {
466 # &quot;key&quot;: &quot;scope&quot;,
467 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
468 # }
469 {
470 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
471 # returned. For example, for warnings where there are no results in a list
472 # request for a particular zone, this key might be scope and
473 # the key value might be the zone name. Other examples might be a key
474 # indicating a deprecated resource and a suggested replacement, or a
475 # warning about invalid network settings (for example, if an instance
476 # attempts to perform IP forwarding but is not enabled for IP forwarding).
477 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
478 },
479 ],
480 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
481 },
482 ],
483 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
484 # applicable when performing per-zone operations.
485 }</pre>
486 </div>
487
488 <div class="method">
489 <code class="details" id="list">list(project, zone, parentName, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
490 <pre>Retrieves a list of reservation slots under a single reservation.
491
492 Args:
493 project: string, The project ID for this request. (required)
494 zone: string, The name of the zone for this request, formatted as RFC1035. (required)
495 parentName: string, The name of the parent reservation and parent block, formatted as
496 reservations/{reservation_name}/reservationBlocks/{reservation_block_name}/reservationSubBlocks/{reservation_sub_block_name} (required)
497 filter: string, A filter expression that filters resources listed in the response. Most
498 Compute resources support two types of filter expressions:
499 expressions that support regular expressions and expressions that follow
500 API improvement proposal AIP-160.
501 These two types of filter expressions cannot be mixed in one request.
502
503 If you want to use AIP-160, your expression must specify the field name, an
504 operator, and the value that you want to use for filtering. The value
505 must be a string, a number, or a boolean. The operator
506 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
507
508 For example, if you are filtering Compute Engine instances, you can
509 exclude instances named `example-instance` by specifying
510 `name != example-instance`.
511
512 The `:*` comparison can be used to test whether a key has been defined.
513 For example, to find all objects with `owner` label use:
514 ```
515 labels.owner:*
516 ```
517
518 You can also filter nested fields. For example, you could specify
519 `scheduling.automaticRestart = false` to include instances only
520 if they are not scheduled for automatic restarts. You can use filtering
521 on nested fields to filter based onresource labels.
522
523 To filter on multiple expressions, provide each separate expression within
524 parentheses. For example:
525 ```
526 (scheduling.automaticRestart = true)
527 (cpuPlatform = &quot;Intel Skylake&quot;)
528 ```
529 By default, each expression is an `AND` expression. However, you
530 can include `AND` and `OR` expressions explicitly.
531 For example:
532 ```
533 (cpuPlatform = &quot;Intel Skylake&quot;) OR
534 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
535 (scheduling.automaticRestart = true)
536 ```
537
538 If you want to use a regular expression, use the `eq` (equal) or `ne`
539 (not equal) operator against a single un-parenthesized expression with or
540 without quotes or against multiple parenthesized expressions. Examples:
541
542 `fieldname eq unquoted literal`
543 `fieldname eq &#x27;single quoted literal&#x27;`
544 `fieldname eq &quot;double quoted literal&quot;`
545 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
546
547 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
548 The literal value must match the entire field.
549
550 For example, to filter for instances that do not end with name &quot;instance&quot;,
551 you would use `name ne .*instance`.
552
553 You cannot combine constraints on multiple fields using regular
554 expressions.
555 maxResults: integer, The maximum number of results per page that should be returned.
556 If the number of available results is larger than `maxResults`,
557 Compute Engine returns a `nextPageToken` that can be used to get
558 the next page of results in subsequent list requests. Acceptable values are
559 `0` to `500`, inclusive. (Default: `500`)
560 orderBy: string, Sorts list results by a certain order. By default, results
561 are returned in alphanumerical order based on the resource name.
562
563 You can also sort results in descending order based on the creation
564 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
565 results based on the `creationTimestamp` field in
566 reverse chronological order (newest result first). Use this to sort
567 resources like operations so that the newest operation is returned first.
568
569 Currently, only sorting by `name` or
570 `creationTimestamp desc` is supported.
571 pageToken: string, Specifies a page token to use. Set `pageToken` to the
572 `nextPageToken` returned by a previous list request to get
573 the next page of results.
574 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
575 of failure. The default value is false.
576
577 For example, when partial success behavior is enabled, aggregatedList for a
578 single zone scope either returns all resources in the zone or no resources,
579 with an error code.
580 x__xgafv: string, V1 error format.
581 Allowed values
582 1 - v1 error format
583 2 - v2 error format
584
585 Returns:
586 An object of the form:
587
588 { # A list of reservation slots within a single reservation.
589 &quot;id&quot;: &quot;A String&quot;, # The unique identifier for the resource; defined by the server.
590 &quot;items&quot;: [ # A list of reservation slot resources.
591 { # Represents a reservation slot resource.
592 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] The creation timestamp, formatted asRFC3339 text.
593 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for this resource. This identifier is
594 # defined by the server.
595 &quot;kind&quot;: &quot;compute#reservationSlot&quot;, # Output only. [Output Only] The type of resource. Alwayscompute#reservationSlot for reservation slots.
596 &quot;name&quot;: &quot;A String&quot;, # Output only. [Output Only] The name of the reservation slot.
597 &quot;physicalTopology&quot;: { # Output only. [Output Only] The physical topology of the reservation slot.
598 &quot;block&quot;: &quot;A String&quot;, # The unique identifier of the capacity block within the cluster.
599 &quot;cluster&quot;: &quot;A String&quot;, # The cluster name of the reservation sub-block.
600 &quot;host&quot;: &quot;A String&quot;, # The unique identifier of the capacity host within the capacity sub-block.
601 &quot;subBlock&quot;: &quot;A String&quot;, # The unique identifier of the capacity sub-block within the capacity
602 # block.
603 },
604 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] A server-defined fully-qualified URL for this resource.
605 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] A server-defined URL for this resource with the resource ID.
606 &quot;shareSettings&quot;: { # The share setting for reservations and sole tenancy node groups. # Specify share settings to create a shared slot. Set to empty
607 # to inherit the share settings from a parent resource.
608 &quot;folderMap&quot;: { # A map of folder id and folder config to specify consumer projects for this
609 # shared-reservation. This is only valid when share_type&#x27;s value is
610 # DIRECT_PROJECTS_UNDER_SPECIFIC_FOLDERS.
611 # Folder id should be a string of number, and without &quot;folders/&quot; prefix.
612 &quot;a_key&quot;: { # Config for each folder in the share settings.
613 &quot;folderId&quot;: &quot;A String&quot;, # The folder ID, should be same as the key of this folder config in the
614 # parent map.
615 # Folder id should be a string of number, and without &quot;folders/&quot; prefix.
616 },
617 },
618 &quot;projectMap&quot;: { # A map of project id and project config. This is only valid when
619 # share_type&#x27;s value is SPECIFIC_PROJECTS.
620 &quot;a_key&quot;: { # Config for each project in the share settings.
621 &quot;projectId&quot;: &quot;A String&quot;, # The project ID, should be same as the key of this project config in the
622 # parent map.
623 },
624 },
625 &quot;projects&quot;: [ # A List of Project names to specify consumer projects for this
626 # shared-reservation. This is only valid when share_type&#x27;s value is
627 # SPECIFIC_PROJECTS.
628 &quot;A String&quot;,
629 ],
630 &quot;shareType&quot;: &quot;A String&quot;, # Type of sharing for this shared-reservation
631 },
632 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] The state of the reservation slot.
633 &quot;status&quot;: { # Output only. [Output Only] The status of the reservation slot.
634 &quot;physicalTopology&quot;: { # Output only. [Output Only] The physical topology of the reservation sub-block.
635 &quot;block&quot;: &quot;A String&quot;, # The unique identifier of the capacity block within the cluster.
636 &quot;cluster&quot;: &quot;A String&quot;, # The cluster name of the reservation sub-block.
637 &quot;host&quot;: &quot;A String&quot;, # The unique identifier of the capacity host within the capacity sub-block.
638 &quot;subBlock&quot;: &quot;A String&quot;, # The unique identifier of the capacity sub-block within the capacity
639 # block.
640 },
641 &quot;rdmaIpAddresses&quot;: [ # Output only. The RDMA IP address of the physical host.
642 &quot;A String&quot;,
643 ],
644 &quot;runningInstances&quot;: [ # Output only. The URIs of the instances currently running on this slot.
645 &quot;A String&quot;,
646 ],
647 },
648 &quot;zone&quot;: &quot;A String&quot;, # Output only. [Output Only] The zone in which the reservation slot resides.
649 },
650 ],
651 &quot;kind&quot;: &quot;compute#reservationSlot&quot;, # The type of resource. Alwayscompute#reservationSlot for a list of reservation
652 # slots.
653 &quot;nextPageToken&quot;: &quot;A String&quot;, # This token allows you to get the next page of results for
654 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
655 # the query parameter pageToken in the next list request.
656 # Subsequent list requests will have their own nextPageToken to
657 # continue paging through the results.
658 &quot;selfLink&quot;: &quot;A String&quot;, # The server-defined URL for this resource.
659 &quot;warning&quot;: { # An informational warning message.
660 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
661 # Engine returns NO_RESULTS_ON_PAGE if there
662 # are no results in the response.
663 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
664 # value format. For example:
665 #
666 # &quot;data&quot;: [
667 # {
668 # &quot;key&quot;: &quot;scope&quot;,
669 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
670 # }
671 {
672 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
673 # returned. For example, for warnings where there are no results in a list
674 # request for a particular zone, this key might be scope and
675 # the key value might be the zone name. Other examples might be a key
676 # indicating a deprecated resource and a suggested replacement, or a
677 # warning about invalid network settings (for example, if an instance
678 # attempts to perform IP forwarding but is not enabled for IP forwarding).
679 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
680 },
681 ],
682 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
683 },
684 }</pre>
685 </div>
686
687 <div class="method">
688 <code class="details" id="list_next">list_next()</code>
689 <pre>Retrieves the next page of results.
690
691 Args:
692 previous_request: The request for the previous page. (required)
693 previous_response: The response from the request for the previous page. (required)
694
695 Returns:
696 A request object that you can call &#x27;execute()&#x27; on to request the next
697 page. Returns None if there are no more items in the collection.
698 </pre>
699 </div>
700
701 <div class="method">
702 <code class="details" id="update">update(project, zone, parentName, reservationSlot, body=None, updateMask=None, x__xgafv=None)</code>
703 <pre>Update a reservation slot in the specified sub-block.
704
705 Args:
706 project: string, The project ID for this request. (required)
707 zone: string, The name of the zone for this request, formatted as RFC1035. (required)
708 parentName: string, The name of the sub-block resource. (required)
709 reservationSlot: string, The name of the slot resource. (required)
710 body: object, The request body.
711 The object takes the form of:
712
713 { # Represents a reservation slot resource.
714 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] The creation timestamp, formatted asRFC3339 text.
715 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for this resource. This identifier is
716 # defined by the server.
717 &quot;kind&quot;: &quot;compute#reservationSlot&quot;, # Output only. [Output Only] The type of resource. Alwayscompute#reservationSlot for reservation slots.
718 &quot;name&quot;: &quot;A String&quot;, # Output only. [Output Only] The name of the reservation slot.
719 &quot;physicalTopology&quot;: { # Output only. [Output Only] The physical topology of the reservation slot.
720 &quot;block&quot;: &quot;A String&quot;, # The unique identifier of the capacity block within the cluster.
721 &quot;cluster&quot;: &quot;A String&quot;, # The cluster name of the reservation sub-block.
722 &quot;host&quot;: &quot;A String&quot;, # The unique identifier of the capacity host within the capacity sub-block.
723 &quot;subBlock&quot;: &quot;A String&quot;, # The unique identifier of the capacity sub-block within the capacity
724 # block.
725 },
726 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] A server-defined fully-qualified URL for this resource.
727 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] A server-defined URL for this resource with the resource ID.
728 &quot;shareSettings&quot;: { # The share setting for reservations and sole tenancy node groups. # Specify share settings to create a shared slot. Set to empty
729 # to inherit the share settings from a parent resource.
730 &quot;folderMap&quot;: { # A map of folder id and folder config to specify consumer projects for this
731 # shared-reservation. This is only valid when share_type&#x27;s value is
732 # DIRECT_PROJECTS_UNDER_SPECIFIC_FOLDERS.
733 # Folder id should be a string of number, and without &quot;folders/&quot; prefix.
734 &quot;a_key&quot;: { # Config for each folder in the share settings.
735 &quot;folderId&quot;: &quot;A String&quot;, # The folder ID, should be same as the key of this folder config in the
736 # parent map.
737 # Folder id should be a string of number, and without &quot;folders/&quot; prefix.
738 },
739 },
740 &quot;projectMap&quot;: { # A map of project id and project config. This is only valid when
741 # share_type&#x27;s value is SPECIFIC_PROJECTS.
742 &quot;a_key&quot;: { # Config for each project in the share settings.
743 &quot;projectId&quot;: &quot;A String&quot;, # The project ID, should be same as the key of this project config in the
744 # parent map.
745 },
746 },
747 &quot;projects&quot;: [ # A List of Project names to specify consumer projects for this
748 # shared-reservation. This is only valid when share_type&#x27;s value is
749 # SPECIFIC_PROJECTS.
750 &quot;A String&quot;,
751 ],
752 &quot;shareType&quot;: &quot;A String&quot;, # Type of sharing for this shared-reservation
753 },
754 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] The state of the reservation slot.
755 &quot;status&quot;: { # Output only. [Output Only] The status of the reservation slot.
756 &quot;physicalTopology&quot;: { # Output only. [Output Only] The physical topology of the reservation sub-block.
757 &quot;block&quot;: &quot;A String&quot;, # The unique identifier of the capacity block within the cluster.
758 &quot;cluster&quot;: &quot;A String&quot;, # The cluster name of the reservation sub-block.
759 &quot;host&quot;: &quot;A String&quot;, # The unique identifier of the capacity host within the capacity sub-block.
760 &quot;subBlock&quot;: &quot;A String&quot;, # The unique identifier of the capacity sub-block within the capacity
761 # block.
762 },
763 &quot;rdmaIpAddresses&quot;: [ # Output only. The RDMA IP address of the physical host.
764 &quot;A String&quot;,
765 ],
766 &quot;runningInstances&quot;: [ # Output only. The URIs of the instances currently running on this slot.
767 &quot;A String&quot;,
768 ],
769 },
770 &quot;zone&quot;: &quot;A String&quot;, # Output only. [Output Only] The zone in which the reservation slot resides.
771 }
772
773 updateMask: string, The fields to be updated as part of this request.
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/beta/globalOperations)
787 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
788 # * [Zonal](/compute/docs/reference/rest/beta/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;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
967 # this field will contain information on all underlying zonal actions and
968 # their state.
969 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
970 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
971 # Example key: zones/us-central1-a
972 &quot;a_key&quot;: {
973 &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
974 # populated.
975 # different programming environments, including REST APIs and RPC APIs. It is
976 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
977 # three pieces of data: error code, error message, and error details.
978 #
979 # You can find out more about this error model and how to work with it in the
980 # [API Design Guide](https://cloud.google.com/apis/design/errors).
981 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
982 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
983 # message types for APIs to use.
984 {
985 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
986 },
987 ],
988 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
989 # user-facing error message should be localized and sent in the
990 # google.rpc.Status.details field, or localized by the client.
991 },
992 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
993 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
994 },
995 },
996 },
997 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
998 # This value is inRFC3339
999 # text format.
1000 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1001 # following:
1002 # `PENDING`, `RUNNING`, or `DONE`.
1003 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1004 # operation.
1005 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1006 # of the target resource.
1007 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1008 # operations related to creating a snapshot, this points to the disk
1009 # that the snapshot was created from.
1010 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1011 # `[email protected]` or
1012 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1013 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1014 # operation, this field will be populated.
1015 {
1016 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1017 # Engine returns NO_RESULTS_ON_PAGE if there
1018 # are no results in the response.
1019 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1020 # value format. For example:
1021 #
1022 # &quot;data&quot;: [
1023 # {
1024 # &quot;key&quot;: &quot;scope&quot;,
1025 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1026 # }
1027 {
1028 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1029 # returned. For example, for warnings where there are no results in a list
1030 # request for a particular zone, this key might be scope and
1031 # the key value might be the zone name. Other examples might be a key
1032 # indicating a deprecated resource and a suggested replacement, or a
1033 # warning about invalid network settings (for example, if an instance
1034 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1035 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1036 },
1037 ],
1038 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1039 },
1040 ],
1041 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1042 # applicable when performing per-zone operations.
1043 }</pre>
1044 </div>
1045
1046 </body></html>