Debian Codegraph @

docs/dyn/compute_beta.reservations.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.reservations.html">reservations</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 reservations.</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, reservation, requestId=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Deletes the specified reservation.</p>
89 <p class="toc_element">
90 <code><a href="#get">get(project, zone, reservation, x__xgafv=None)</a></code></p>
91 <p class="firstline">Retrieves information about the specified reservation.</p>
92 <p class="toc_element">
93 <code><a href="#getIamPolicy">getIamPolicy(project, zone, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</a></code></p>
94 <p class="firstline">Gets the access control policy for a resource. May be empty if no such</p>
95 <p class="toc_element">
96 <code><a href="#insert">insert(project, zone, body=None, requestId=None, x__xgafv=None)</a></code></p>
97 <p class="firstline">Creates a new reservation. For more information, readReserving zonal</p>
98 <p class="toc_element">
99 <code><a href="#list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
100 <p class="firstline">A list of all the reservations that have been configured for the</p>
101 <p class="toc_element">
102 <code><a href="#list_next">list_next()</a></code></p>
103 <p class="firstline">Retrieves the next page of results.</p>
104 <p class="toc_element">
105 <code><a href="#performMaintenance">performMaintenance(project, zone, reservation, body=None, requestId=None, x__xgafv=None)</a></code></p>
106 <p class="firstline">Perform maintenance on an extended reservation</p>
107 <p class="toc_element">
108 <code><a href="#resize">resize(project, zone, reservation, body=None, requestId=None, x__xgafv=None)</a></code></p>
109 <p class="firstline">Resizes the reservation (applicable to standalone reservations only). For</p>
110 <p class="toc_element">
111 <code><a href="#setIamPolicy">setIamPolicy(project, zone, resource, body=None, x__xgafv=None)</a></code></p>
112 <p class="firstline">Sets the access control policy on the specified resource.</p>
113 <p class="toc_element">
114 <code><a href="#testIamPermissions">testIamPermissions(project, zone, resource, body=None, x__xgafv=None)</a></code></p>
115 <p class="firstline">Returns permissions that a caller has on the specified resource.</p>
116 <p class="toc_element">
117 <code><a href="#update">update(project, zone, reservation, body=None, paths=None, requestId=None, updateMask=None, x__xgafv=None)</a></code></p>
118 <p class="firstline">Update share settings of the reservation.</p>
119 <h3>Method Details</h3>
120 <div class="method">
121 <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>
122 <pre>Retrieves an aggregated list of reservations.
123
124 To prevent failure, it is recommended that you set the
125 `returnPartialSuccess` parameter to `true`.
126
127 Args:
128 project: string, Project ID for this request. (required)
129 filter: string, A filter expression that filters resources listed in the response. Most
130 Compute resources support two types of filter expressions:
131 expressions that support regular expressions and expressions that follow
132 API improvement proposal AIP-160.
133 These two types of filter expressions cannot be mixed in one request.
134
135 If you want to use AIP-160, your expression must specify the field name, an
136 operator, and the value that you want to use for filtering. The value
137 must be a string, a number, or a boolean. The operator
138 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
139
140 For example, if you are filtering Compute Engine instances, you can
141 exclude instances named `example-instance` by specifying
142 `name != example-instance`.
143
144 The `:*` comparison can be used to test whether a key has been defined.
145 For example, to find all objects with `owner` label use:
146 ```
147 labels.owner:*
148 ```
149
150 You can also filter nested fields. For example, you could specify
151 `scheduling.automaticRestart = false` to include instances only
152 if they are not scheduled for automatic restarts. You can use filtering
153 on nested fields to filter based onresource labels.
154
155 To filter on multiple expressions, provide each separate expression within
156 parentheses. For example:
157 ```
158 (scheduling.automaticRestart = true)
159 (cpuPlatform = &quot;Intel Skylake&quot;)
160 ```
161 By default, each expression is an `AND` expression. However, you
162 can include `AND` and `OR` expressions explicitly.
163 For example:
164 ```
165 (cpuPlatform = &quot;Intel Skylake&quot;) OR
166 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
167 (scheduling.automaticRestart = true)
168 ```
169
170 If you want to use a regular expression, use the `eq` (equal) or `ne`
171 (not equal) operator against a single un-parenthesized expression with or
172 without quotes or against multiple parenthesized expressions. Examples:
173
174 `fieldname eq unquoted literal`
175 `fieldname eq &#x27;single quoted literal&#x27;`
176 `fieldname eq &quot;double quoted literal&quot;`
177 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
178
179 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
180 The literal value must match the entire field.
181
182 For example, to filter for instances that do not end with name &quot;instance&quot;,
183 you would use `name ne .*instance`.
184
185 You cannot combine constraints on multiple fields using regular
186 expressions.
187 includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region,
188 global) should be included in the response. For new resource types added
189 after this field, the flag has no effect as new resource types will always
190 include every visible scope for each scope type in response. For resource
191 types which predate this field, if this flag is omitted or false, only
192 scopes of the scope types where the resource type is expected to be found
193 will be included.
194 maxResults: integer, The maximum number of results per page that should be returned.
195 If the number of available results is larger than `maxResults`,
196 Compute Engine returns a `nextPageToken` that can be used to get
197 the next page of results in subsequent list requests. Acceptable values are
198 `0` to `500`, inclusive. (Default: `500`)
199 orderBy: string, Sorts list results by a certain order. By default, results
200 are returned in alphanumerical order based on the resource name.
201
202 You can also sort results in descending order based on the creation
203 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
204 results based on the `creationTimestamp` field in
205 reverse chronological order (newest result first). Use this to sort
206 resources like operations so that the newest operation is returned first.
207
208 Currently, only sorting by `name` or
209 `creationTimestamp desc` is supported.
210 pageToken: string, Specifies a page token to use. Set `pageToken` to the
211 `nextPageToken` returned by a previous list request to get
212 the next page of results.
213 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
214 of failure. The default value is false.
215
216 For example, when partial success behavior is enabled, aggregatedList for a
217 single zone scope either returns all resources in the zone or no resources,
218 with an error code.
219 serviceProjectNumber: string, The Shared VPC service project id or service project number for which
220 aggregated list request is invoked for subnetworks list-usable api.
221 x__xgafv: string, V1 error format.
222 Allowed values
223 1 - v1 error format
224 2 - v2 error format
225
226 Returns:
227 An object of the form:
228
229 { # Contains a list of reservations.
230 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
231 &quot;items&quot;: { # A list of Allocation resources.
232 &quot;a_key&quot;: { # Name of the scope containing this set of reservations.
233 &quot;reservations&quot;: [ # A list of reservations contained in this scope.
234 { # Represents a reservation resource. A reservation ensures that capacity is
235 # held in a specific zone even if the reserved VMs are not running. For more
236 # information, read Reserving zonal
237 # resources.
238 &quot;advancedDeploymentControl&quot;: { # Advance control for cluster management, applicable only to DENSE deployment # Advanced control for cluster management, applicable only to DENSE
239 # deployment type reservations.
240 # type reservations.
241 &quot;reservationOperationalMode&quot;: &quot;A String&quot;, # Indicates chosen reservation operational mode for the reservation.
242 },
243 &quot;aggregateReservation&quot;: { # This reservation type is specified by total resource amounts (e.g. total # Reservation for aggregated resources, providing shape flexibility.
244 # count of CPUs) and can account for multiple instance SKUs. In other words,
245 # one can create instances of varying shapes against this reservation.
246 &quot;hostCount&quot;: 42, # Count of reserved hosts of specified VM family. The host has fixed number
247 # of accelerators based on the accelerator/vm-family selected.
248 &quot;inUseHostCount&quot;: 42, # Output only. Number of hosts currently in use. If there is one or more Instances
249 # running on the host, it is considered in use.
250 &quot;inUseInstanceCount&quot;: 42, # Output only. Number of instances currently in use in this reservation.
251 &quot;inUseResources&quot;: [ # Output only. [Output only] List of resources currently in use.
252 {
253 &quot;accelerator&quot;: { # Properties of accelerator resources in this reservation.
254 &quot;acceleratorCount&quot;: 42, # Number of accelerators of specified type.
255 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL to accelerator type. e.g.
256 # &quot;projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l&quot;
257 },
258 },
259 ],
260 &quot;reservedResources&quot;: [ # List of reserved resources (CPUs, memory, accelerators).
261 {
262 &quot;accelerator&quot;: { # Properties of accelerator resources in this reservation.
263 &quot;acceleratorCount&quot;: 42, # Number of accelerators of specified type.
264 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL to accelerator type. e.g.
265 # &quot;projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l&quot;
266 },
267 },
268 ],
269 &quot;vmFamily&quot;: &quot;A String&quot;, # The VM family that all instances scheduled against this reservation must
270 # belong to.
271 &quot;workloadType&quot;: &quot;A String&quot;, # The workload type of the instances that will target this reservation.
272 },
273 &quot;commitment&quot;: &quot;A String&quot;, # Output only. [Output Only] Full or partial URL to a parent commitment. This field
274 # displays for reservations that are tied to a commitment.
275 &quot;confidentialComputeType&quot;: &quot;A String&quot;,
276 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
277 # text format.
278 &quot;deleteAfterDuration&quot;: { # A Duration represents a fixed-length span of time represented # Duration time relative to reservation creation when Compute Engine will
279 # automatically delete this resource.
280 # as a count of seconds and fractions of seconds at nanosecond
281 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
282 # or &quot;month&quot;. Range is approximately 10,000 years.
283 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
284 # Durations less than one second are represented with a 0
285 # `seconds` field and a positive `nanos` field. Must be from 0
286 # to 999,999,999 inclusive.
287 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
288 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
289 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
290 },
291 &quot;deleteAtTime&quot;: &quot;A String&quot;, # Absolute time in future when the reservation will be
292 # auto-deleted by Compute Engine. Timestamp is represented inRFC3339 text format.
293 &quot;deploymentType&quot;: &quot;A String&quot;, # Specifies the deployment strategy for this reservation.
294 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
295 # create the resource.
296 &quot;earlyAccessMaintenance&quot;: &quot;A String&quot;, # Indicates the early access maintenance for the reservation.
297 # If this field is absent or set to NO_EARLY_ACCESS, the reservation is not
298 # enrolled in early access maintenance and the standard notice applies.
299 &quot;enableEmergentMaintenance&quot;: True or False, # Indicates whether Compute Engine allows unplanned maintenance for your VMs;
300 # for example, to fix hardware errors.
301 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
302 # defined by the server.
303 &quot;kind&quot;: &quot;compute#reservation&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#reservations for reservations.
304 &quot;linkedCommitments&quot;: [ # Output only. [Output Only] Full or partial URL to parent commitments. This field
305 # displays for reservations that are tied to multiple commitments.
306 &quot;A String&quot;,
307 ],
308 &quot;name&quot;: &quot;A String&quot;, # The name of the resource, provided by the client when initially creating
309 # the resource. The resource name must be 1-63 characters long, and comply
310 # withRFC1035.
311 # Specifically, the name must be 1-63 characters long and match the regular
312 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
313 # character must be a lowercase letter, and all following characters must be
314 # a dash, lowercase letter, or digit, except the last character, which cannot
315 # be a dash.
316 &quot;params&quot;: { # Additional reservation params. # Input only. Additional params passed with the request, but not persisted
317 # as part of resource payload.
318 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the reservation. Tag keys and
319 # values have the same definition as resource
320 # manager tags. Keys and values can be either in numeric format,
321 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
322 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
323 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
324 # PATCH) when empty.
325 &quot;a_key&quot;: &quot;A String&quot;,
326 },
327 },
328 &quot;protectionTier&quot;: &quot;A String&quot;, # Protection tier for the workload which specifies the workload expectations
329 # in the event of infrastructure failures at data center (e.g. power
330 # and/or cooling failures).
331 &quot;reservationMode&quot;: &quot;A String&quot;, # Output only. [Output only] Indicates the reservation mode of the reservation.
332 &quot;reservationSharingPolicy&quot;: { # Specify the reservation sharing policy. If unspecified, the reservation
333 # will not be shared with Google Cloud managed services.
334 &quot;serviceShareType&quot;: &quot;A String&quot;, # Sharing config for all Google Cloud services.
335 },
336 &quot;resourcePolicies&quot;: { # Resource policies to be added to this reservation. The key is defined by
337 # user, and the value is resource policy url. This is to define placement
338 # policy with reservation.
339 &quot;a_key&quot;: &quot;A String&quot;,
340 },
341 &quot;resourceStatus&quot;: { # [Output Only] Contains output only fields. # Output only. [Output Only] Status information for Reservation resource.
342 &quot;healthInfo&quot;: { # Health information for the reservation. # [Output only] Health information for the reservation.
343 &quot;degradedBlockCount&quot;: 42, # The number of reservation blocks that are degraded.
344 &quot;healthStatus&quot;: &quot;A String&quot;, # The health status of the reservation.
345 &quot;healthyBlockCount&quot;: 42, # The number of reservation blocks that are healthy.
346 },
347 &quot;reservationBlockCount&quot;: 42, # The number of reservation blocks associated with this reservation.
348 &quot;reservationMaintenance&quot;: { # Maintenance Info for ReservationBlocks. # Maintenance information for this reservation
349 &quot;instanceMaintenanceOngoingCount&quot;: 42, # Describes number of instances that have ongoing maintenance.
350 &quot;instanceMaintenancePendingCount&quot;: 42, # Describes number of instances that have pending maintenance.
351 &quot;maintenanceOngoingCount&quot;: 42, # Progress for ongoing maintenance for this group of VMs/hosts.
352 # Describes number of hosts in the block that have ongoing maintenance.
353 &quot;maintenancePendingCount&quot;: 42, # Progress for ongoing maintenance for this group of VMs/hosts.
354 # Describes number of hosts in the block that have pending maintenance.
355 &quot;schedulingType&quot;: &quot;A String&quot;, # The type of maintenance for the reservation.
356 &quot;subblockInfraMaintenanceOngoingCount&quot;: 42, # Describes number of subblock Infrastructure that has ongoing maintenance.
357 # Here, Subblock Infrastructure Maintenance pertains to upstream hardware
358 # contained in the Subblock that is necessary for a VM Family(e.g. NVLink
359 # Domains). Not all VM Families will support this field.
360 &quot;subblockInfraMaintenancePendingCount&quot;: 42, # Describes number of subblock Infrastructure that has pending maintenance.
361 # Here, Subblock Infrastructure Maintenance pertains to upstream hardware
362 # contained in the Subblock that is necessary for a VM Family (e.g. NVLink
363 # Domains). Not all VM Families will support this field.
364 &quot;upcomingGroupMaintenance&quot;: { # Upcoming Maintenance notification information. # Maintenance information on this group of VMs.
365 &quot;canReschedule&quot;: True or False, # Indicates if the maintenance can be customer triggered.
366 &quot;latestWindowStartTime&quot;: &quot;A String&quot;, # The latest time for the planned maintenance window to start.
367 # This timestamp value is in RFC3339 text format.
368 &quot;maintenanceOnShutdown&quot;: True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown.
369 &quot;maintenanceReasons&quot;: [ # The reasons for the maintenance. Only valid for vms.
370 &quot;A String&quot;,
371 ],
372 &quot;maintenanceStatus&quot;: &quot;A String&quot;,
373 &quot;type&quot;: &quot;A String&quot;, # Defines the type of maintenance.
374 &quot;windowEndTime&quot;: &quot;A String&quot;, # The time by which the maintenance disruption will be completed.
375 # This timestamp value is in RFC3339 text format.
376 &quot;windowStartTime&quot;: &quot;A String&quot;, # The current start time of the maintenance window.
377 # This timestamp value is in RFC3339 text format.
378 },
379 },
380 &quot;specificSkuAllocation&quot;: { # Contains Properties set for the reservation. # Allocation Properties of this reservation.
381 &quot;sourceInstanceTemplateId&quot;: &quot;A String&quot;, # ID of the instance template used to populate reservation properties.
382 &quot;utilizations&quot;: { # Per service utilization breakdown. The Key is the Google Cloud managed
383 # service name.
384 &quot;a_key&quot;: &quot;A String&quot;,
385 },
386 },
387 },
388 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
389 &quot;schedulingType&quot;: &quot;A String&quot;, # The type of maintenance for the reservation.
390 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
391 &quot;shareSettings&quot;: { # The share setting for reservations and sole tenancy node groups. # Specify share-settings to create a shared reservation. This property is
392 # optional. For more information about the syntax and options for this
393 # field and its subfields, see the guide for creating
394 # a shared reservation.
395 &quot;folderMap&quot;: { # A map of folder id and folder config to specify consumer projects for this
396 # shared-reservation. This is only valid when share_type&#x27;s value is
397 # DIRECT_PROJECTS_UNDER_SPECIFIC_FOLDERS.
398 # Folder id should be a string of number, and without &quot;folders/&quot; prefix.
399 &quot;a_key&quot;: { # Config for each folder in the share settings.
400 &quot;folderId&quot;: &quot;A String&quot;, # The folder ID, should be same as the key of this folder config in the
401 # parent map.
402 # Folder id should be a string of number, and without &quot;folders/&quot; prefix.
403 },
404 },
405 &quot;projectMap&quot;: { # A map of project id and project config. This is only valid when
406 # share_type&#x27;s value is SPECIFIC_PROJECTS.
407 &quot;a_key&quot;: { # Config for each project in the share settings.
408 &quot;projectId&quot;: &quot;A String&quot;, # The project ID, should be same as the key of this project config in the
409 # parent map.
410 },
411 },
412 &quot;projects&quot;: [ # A List of Project names to specify consumer projects for this
413 # shared-reservation. This is only valid when share_type&#x27;s value is
414 # SPECIFIC_PROJECTS.
415 &quot;A String&quot;,
416 ],
417 &quot;shareType&quot;: &quot;A String&quot;, # Type of sharing for this shared-reservation
418 },
419 &quot;specificReservation&quot;: { # This reservation type allows to pre allocate specific instance # Reservation for instances with specific machine shapes.
420 # configuration.
421 &quot;assuredCount&quot;: &quot;A String&quot;, # Output only. [Output Only] Indicates how many instances are actually usable currently.
422 &quot;count&quot;: &quot;A String&quot;, # Specifies the number of resources that are allocated.
423 &quot;inUseCount&quot;: &quot;A String&quot;, # Output only. [Output Only] Indicates how many instances are in use.
424 &quot;instanceProperties&quot;: { # Properties of the SKU instances being reserved. # The instance properties for the reservation.
425 # Next ID: 10
426 &quot;guestAccelerators&quot;: [ # Specifies accelerator type and count.
427 { # A specification of the type and number of accelerator cards attached to the
428 # instance.
429 &quot;acceleratorCount&quot;: 42, # The number of the guest accelerator cards exposed to this instance.
430 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL of the accelerator type resource to attach to this
431 # instance. For example:projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100
432 # If you are creating an instance template, specify only the
433 # accelerator name.
434 # See GPUs on Compute Engine
435 # for a full list of accelerator types.
436 },
437 ],
438 &quot;localSsds&quot;: [ # Specifies amount of local ssd to reserve with each instance. The type
439 # of disk is local-ssd.
440 {
441 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Specifies the size of the disk in base-2 GB.
442 &quot;interface&quot;: &quot;A String&quot;, # Specifies the disk interface to use for attaching this disk, which is
443 # either SCSI or NVME. The default isSCSI.
444 # For performance characteristics of SCSI over NVMe, seeLocal SSD performance.
445 },
446 ],
447 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the allocation close to other
448 # resources.
449 # This field is for use by internal tools that use the public API.
450 &quot;machineType&quot;: &quot;A String&quot;, # Specifies type of machine (name only) which has fixed number of vCPUs
451 # and fixed amount of memory. This also includes specifying custom
452 # machine type following custom-NUMBER_OF_CPUS-AMOUNT_OF_MEMORY pattern.
453 &quot;maintenanceFreezeDurationHours&quot;: 42, # Specifies the number of hours after reservation creation where
454 # instances using the reservation won&#x27;t be scheduled for maintenance.
455 &quot;maintenanceInterval&quot;: &quot;A String&quot;, # Specifies the frequency of planned maintenance events. The accepted
456 # values are: `PERIODIC`.
457 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Minimum cpu platform the reservation.
458 },
459 &quot;sourceInstanceTemplate&quot;: &quot;A String&quot;, # Specifies the instance template to create the reservation. If you use
460 # this field, you must exclude the instanceProperties field.
461 #
462 # This field is optional, and it can be a full or partial URL. For example,
463 # the following are all valid URLs to an instance template:
464 #
465 #
466 # - https://www.googleapis.com/compute/v1/projects/project/global/instanceTemplates/instanceTemplate
467 # - projects/project/global/instanceTemplates/instanceTemplate
468 # - global/instanceTemplates/instanceTemplate
469 },
470 &quot;specificReservationRequired&quot;: True or False, # Indicates whether the reservation can be consumed by VMs with affinity
471 # for &quot;any&quot; reservation. If the field is set, then only VMs that target
472 # the reservation by name can consume from this reservation.
473 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of the reservation.
474 #
475 #
476 # - CREATING: Reservation resources are being
477 # allocated.
478 # - READY: Reservation resources have been allocated,
479 # and the reservation is ready for use.
480 # - DELETING: Reservation deletion is in progress.
481 # - UPDATING: Reservation update is in progress.
482 &quot;zone&quot;: &quot;A String&quot;, # Zone in which the reservation resides. A zone must be provided if the
483 # reservation is created within a commitment.
484 },
485 ],
486 &quot;warning&quot;: { # Informational warning which replaces the list of reservations when
487 # the list is empty.
488 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
489 # Engine returns NO_RESULTS_ON_PAGE if there
490 # are no results in the response.
491 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
492 # value format. For example:
493 #
494 # &quot;data&quot;: [
495 # {
496 # &quot;key&quot;: &quot;scope&quot;,
497 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
498 # }
499 {
500 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
501 # returned. For example, for warnings where there are no results in a list
502 # request for a particular zone, this key might be scope and
503 # the key value might be the zone name. Other examples might be a key
504 # indicating a deprecated resource and a suggested replacement, or a
505 # warning about invalid network settings (for example, if an instance
506 # attempts to perform IP forwarding but is not enabled for IP forwarding).
507 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
508 },
509 ],
510 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
511 },
512 },
513 },
514 &quot;kind&quot;: &quot;compute#reservationAggregatedList&quot;, # Output only. Type of resource.
515 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
516 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
517 # the query parameter pageToken in the next list request.
518 # Subsequent list requests will have their own nextPageToken to
519 # continue paging through the results.
520 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
521 &quot;unreachables&quot;: [ # Output only. [Output Only] Unreachable resources.
522 &quot;A String&quot;,
523 ],
524 &quot;warning&quot;: { # [Output Only] Informational warning message.
525 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
526 # Engine returns NO_RESULTS_ON_PAGE if there
527 # are no results in the response.
528 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
529 # value format. For example:
530 #
531 # &quot;data&quot;: [
532 # {
533 # &quot;key&quot;: &quot;scope&quot;,
534 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
535 # }
536 {
537 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
538 # returned. For example, for warnings where there are no results in a list
539 # request for a particular zone, this key might be scope and
540 # the key value might be the zone name. Other examples might be a key
541 # indicating a deprecated resource and a suggested replacement, or a
542 # warning about invalid network settings (for example, if an instance
543 # attempts to perform IP forwarding but is not enabled for IP forwarding).
544 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
545 },
546 ],
547 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
548 },
549 }</pre>
550 </div>
551
552 <div class="method">
553 <code class="details" id="aggregatedList_next">aggregatedList_next()</code>
554 <pre>Retrieves the next page of results.
555
556 Args:
557 previous_request: The request for the previous page. (required)
558 previous_response: The response from the request for the previous page. (required)
559
560 Returns:
561 A request object that you can call &#x27;execute()&#x27; on to request the next
562 page. Returns None if there are no more items in the collection.
563 </pre>
564 </div>
565
566 <div class="method">
567 <code class="details" id="close">close()</code>
568 <pre>Close httplib2 connections.</pre>
569 </div>
570
571 <div class="method">
572 <code class="details" id="delete">delete(project, zone, reservation, requestId=None, x__xgafv=None)</code>
573 <pre>Deletes the specified reservation.
574
575 Args:
576 project: string, Project ID for this request. (required)
577 zone: string, Name of the zone for this request. (required)
578 reservation: string, Name of the reservation to delete. (required)
579 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
580 that if you must retry your request, the server will know to ignore the
581 request if it has already been completed.
582
583 For example, consider a situation where you make an initial request and
584 the request times out. If you make the request again with the same
585 request ID, the server can check if original operation with the same
586 request ID was received, and if so, will ignore the second request. This
587 prevents clients from accidentally creating duplicate commitments.
588
589 The request ID must be
590 a valid UUID with the exception that zero UUID is not supported
591 (00000000-0000-0000-0000-000000000000).
592 x__xgafv: string, V1 error format.
593 Allowed values
594 1 - v1 error format
595 2 - v2 error format
596
597 Returns:
598 An object of the form:
599
600 { # Represents an Operation resource.
601 #
602 # Google Compute Engine has three Operation resources:
603 #
604 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
605 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
606 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
607 #
608 # You can use an operation resource to manage asynchronous API requests.
609 # For more information, readHandling
610 # API responses.
611 #
612 # Operations can be global, regional or zonal.
613 #
614 # - For global operations, use the `globalOperations`
615 # resource.
616 # - For regional operations, use the
617 # `regionOperations` resource.
618 # - For zonal operations, use
619 # the `zoneOperations` resource.
620 #
621 #
622 #
623 # For more information, read
624 # Global, Regional, and Zonal Resources.
625 #
626 # Note that completed Operation resources have a limited
627 # retention period.
628 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
629 # Not present otherwise.
630 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
631 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
632 # set when the operation is created.
633 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
634 # text format.
635 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
636 # this field will be populated.
637 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
638 # operation.
639 {
640 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
641 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
642 # details. There is a set of defined message types to use for providing
643 # details.The syntax depends on the error code. For example,
644 # QuotaExceededInfo will have details when the error code is
645 # QUOTA_EXCEEDED.
646 {
647 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
648 #
649 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
650 # is not enabled:
651 #
652 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
653 # &quot;domain&quot;: &quot;googleapis.com&quot;
654 # &quot;metadata&quot;: {
655 # &quot;resource&quot;: &quot;projects/123&quot;,
656 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
657 # }
658 # }
659 #
660 # This response indicates that the pubsub.googleapis.com API is not enabled.
661 #
662 # Example of an error that is returned when attempting to create a Spanner
663 # instance in a region that is out of stock:
664 #
665 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
666 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
667 # &quot;metadata&quot;: {
668 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
669 # }
670 # }
671 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
672 # is typically the registered service name of the tool or product that
673 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
674 # generated by some common infrastructure, the error domain must be a
675 # globally unique value that identifies the infrastructure. For Google API
676 # infrastructure, the error domain is &quot;googleapis.com&quot;.
677 &quot;metadatas&quot;: { # Additional structured details about this error.
678 #
679 # Keys must match a regular expression of `a-z+` but should
680 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
681 # length. When identifying the current value of an exceeded limit, the units
682 # should be contained in the key, not the value. For example, rather than
683 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
684 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
685 # instances that can be created in a single (batch) request.
686 &quot;a_key&quot;: &quot;A String&quot;,
687 },
688 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
689 # proximate cause of the error. Error reasons are unique within a particular
690 # domain of errors. This should be at most 63 characters and match a
691 # regular expression of `A-Z+[A-Z0-9]`, which represents
692 # UPPER_SNAKE_CASE.
693 },
694 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
695 #
696 # For example, if a quota check failed with an error indicating the calling
697 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
698 # directly to the right place in the developer console to flip the bit.
699 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
700 { # Describes a URL link.
701 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
702 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
703 },
704 ],
705 },
706 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
707 # which can be attached to an RPC error.
708 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
709 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
710 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
711 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
712 },
713 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
714 &quot;dimensions&quot;: { # The map holding related quota dimensions.
715 &quot;a_key&quot;: &quot;A String&quot;,
716 },
717 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
718 # type or metric.
719 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
720 # or metric.
721 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
722 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
723 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
724 },
725 },
726 ],
727 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
728 # This property is optional.
729 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
730 },
731 ],
732 },
733 &quot;getVersionOperationMetadata&quot;: {
734 &quot;inlineSbomInfo&quot;: {
735 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
736 # appropriate identifiers.
737 &quot;a_key&quot;: &quot;A String&quot;,
738 },
739 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
740 # identifiers.
741 &quot;a_key&quot;: &quot;A String&quot;,
742 },
743 },
744 },
745 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
746 # message that was returned, such as `NOT FOUND`.
747 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
748 # status code that was returned. For example, a `404` means the
749 # resource was not found.
750 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
751 # defined by the server.
752 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
753 # This value is inRFC3339
754 # text format.
755 &quot;instancesBulkInsertOperationMetadata&quot;: {
756 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
757 # Example key: zones/us-central1-a
758 &quot;a_key&quot;: {
759 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
760 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
761 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
762 # error.
763 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
764 # if the flow is rolling forward or rolling back.
765 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
766 },
767 },
768 },
769 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
770 # Operation resources.
771 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
772 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
773 # group of operations results from a `bulkInsert` API request.
774 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
775 # `update`, or `delete`, and so on.
776 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
777 # There is no requirement that this be linear or support any granularity of
778 # operations. This should not be used to guess when the operation will be
779 # complete. This number should monotonically increase as the operation
780 # progresses.
781 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
782 # applicable when performing regional operations.
783 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
784 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
785 # this field will contain information on all underlying zonal actions and
786 # their state.
787 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
788 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
789 # Example key: zones/us-central1-a
790 &quot;a_key&quot;: {
791 &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
792 # populated.
793 # different programming environments, including REST APIs and RPC APIs. It is
794 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
795 # three pieces of data: error code, error message, and error details.
796 #
797 # You can find out more about this error model and how to work with it in the
798 # [API Design Guide](https://cloud.google.com/apis/design/errors).
799 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
800 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
801 # message types for APIs to use.
802 {
803 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
804 },
805 ],
806 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
807 # user-facing error message should be localized and sent in the
808 # google.rpc.Status.details field, or localized by the client.
809 },
810 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
811 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
812 },
813 },
814 },
815 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
816 # This value is inRFC3339
817 # text format.
818 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
819 # following:
820 # `PENDING`, `RUNNING`, or `DONE`.
821 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
822 # operation.
823 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
824 # of the target resource.
825 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
826 # operations related to creating a snapshot, this points to the disk
827 # that the snapshot was created from.
828 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
829 # `[email protected]` or
830 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
831 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
832 # operation, this field will be populated.
833 {
834 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
835 # Engine returns NO_RESULTS_ON_PAGE if there
836 # are no results in the response.
837 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
838 # value format. For example:
839 #
840 # &quot;data&quot;: [
841 # {
842 # &quot;key&quot;: &quot;scope&quot;,
843 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
844 # }
845 {
846 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
847 # returned. For example, for warnings where there are no results in a list
848 # request for a particular zone, this key might be scope and
849 # the key value might be the zone name. Other examples might be a key
850 # indicating a deprecated resource and a suggested replacement, or a
851 # warning about invalid network settings (for example, if an instance
852 # attempts to perform IP forwarding but is not enabled for IP forwarding).
853 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
854 },
855 ],
856 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
857 },
858 ],
859 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
860 # applicable when performing per-zone operations.
861 }</pre>
862 </div>
863
864 <div class="method">
865 <code class="details" id="get">get(project, zone, reservation, x__xgafv=None)</code>
866 <pre>Retrieves information about the specified reservation.
867
868 Args:
869 project: string, Project ID for this request. (required)
870 zone: string, Name of the zone for this request. (required)
871 reservation: string, Name of the reservation to retrieve. (required)
872 x__xgafv: string, V1 error format.
873 Allowed values
874 1 - v1 error format
875 2 - v2 error format
876
877 Returns:
878 An object of the form:
879
880 { # Represents a reservation resource. A reservation ensures that capacity is
881 # held in a specific zone even if the reserved VMs are not running. For more
882 # information, read Reserving zonal
883 # resources.
884 &quot;advancedDeploymentControl&quot;: { # Advance control for cluster management, applicable only to DENSE deployment # Advanced control for cluster management, applicable only to DENSE
885 # deployment type reservations.
886 # type reservations.
887 &quot;reservationOperationalMode&quot;: &quot;A String&quot;, # Indicates chosen reservation operational mode for the reservation.
888 },
889 &quot;aggregateReservation&quot;: { # This reservation type is specified by total resource amounts (e.g. total # Reservation for aggregated resources, providing shape flexibility.
890 # count of CPUs) and can account for multiple instance SKUs. In other words,
891 # one can create instances of varying shapes against this reservation.
892 &quot;hostCount&quot;: 42, # Count of reserved hosts of specified VM family. The host has fixed number
893 # of accelerators based on the accelerator/vm-family selected.
894 &quot;inUseHostCount&quot;: 42, # Output only. Number of hosts currently in use. If there is one or more Instances
895 # running on the host, it is considered in use.
896 &quot;inUseInstanceCount&quot;: 42, # Output only. Number of instances currently in use in this reservation.
897 &quot;inUseResources&quot;: [ # Output only. [Output only] List of resources currently in use.
898 {
899 &quot;accelerator&quot;: { # Properties of accelerator resources in this reservation.
900 &quot;acceleratorCount&quot;: 42, # Number of accelerators of specified type.
901 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL to accelerator type. e.g.
902 # &quot;projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l&quot;
903 },
904 },
905 ],
906 &quot;reservedResources&quot;: [ # List of reserved resources (CPUs, memory, accelerators).
907 {
908 &quot;accelerator&quot;: { # Properties of accelerator resources in this reservation.
909 &quot;acceleratorCount&quot;: 42, # Number of accelerators of specified type.
910 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL to accelerator type. e.g.
911 # &quot;projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l&quot;
912 },
913 },
914 ],
915 &quot;vmFamily&quot;: &quot;A String&quot;, # The VM family that all instances scheduled against this reservation must
916 # belong to.
917 &quot;workloadType&quot;: &quot;A String&quot;, # The workload type of the instances that will target this reservation.
918 },
919 &quot;commitment&quot;: &quot;A String&quot;, # Output only. [Output Only] Full or partial URL to a parent commitment. This field
920 # displays for reservations that are tied to a commitment.
921 &quot;confidentialComputeType&quot;: &quot;A String&quot;,
922 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
923 # text format.
924 &quot;deleteAfterDuration&quot;: { # A Duration represents a fixed-length span of time represented # Duration time relative to reservation creation when Compute Engine will
925 # automatically delete this resource.
926 # as a count of seconds and fractions of seconds at nanosecond
927 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
928 # or &quot;month&quot;. Range is approximately 10,000 years.
929 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
930 # Durations less than one second are represented with a 0
931 # `seconds` field and a positive `nanos` field. Must be from 0
932 # to 999,999,999 inclusive.
933 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
934 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
935 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
936 },
937 &quot;deleteAtTime&quot;: &quot;A String&quot;, # Absolute time in future when the reservation will be
938 # auto-deleted by Compute Engine. Timestamp is represented inRFC3339 text format.
939 &quot;deploymentType&quot;: &quot;A String&quot;, # Specifies the deployment strategy for this reservation.
940 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
941 # create the resource.
942 &quot;earlyAccessMaintenance&quot;: &quot;A String&quot;, # Indicates the early access maintenance for the reservation.
943 # If this field is absent or set to NO_EARLY_ACCESS, the reservation is not
944 # enrolled in early access maintenance and the standard notice applies.
945 &quot;enableEmergentMaintenance&quot;: True or False, # Indicates whether Compute Engine allows unplanned maintenance for your VMs;
946 # for example, to fix hardware errors.
947 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
948 # defined by the server.
949 &quot;kind&quot;: &quot;compute#reservation&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#reservations for reservations.
950 &quot;linkedCommitments&quot;: [ # Output only. [Output Only] Full or partial URL to parent commitments. This field
951 # displays for reservations that are tied to multiple commitments.
952 &quot;A String&quot;,
953 ],
954 &quot;name&quot;: &quot;A String&quot;, # The name of the resource, provided by the client when initially creating
955 # the resource. The resource name must be 1-63 characters long, and comply
956 # withRFC1035.
957 # Specifically, the name must be 1-63 characters long and match the regular
958 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
959 # character must be a lowercase letter, and all following characters must be
960 # a dash, lowercase letter, or digit, except the last character, which cannot
961 # be a dash.
962 &quot;params&quot;: { # Additional reservation params. # Input only. Additional params passed with the request, but not persisted
963 # as part of resource payload.
964 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the reservation. Tag keys and
965 # values have the same definition as resource
966 # manager tags. Keys and values can be either in numeric format,
967 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
968 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
969 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
970 # PATCH) when empty.
971 &quot;a_key&quot;: &quot;A String&quot;,
972 },
973 },
974 &quot;protectionTier&quot;: &quot;A String&quot;, # Protection tier for the workload which specifies the workload expectations
975 # in the event of infrastructure failures at data center (e.g. power
976 # and/or cooling failures).
977 &quot;reservationMode&quot;: &quot;A String&quot;, # Output only. [Output only] Indicates the reservation mode of the reservation.
978 &quot;reservationSharingPolicy&quot;: { # Specify the reservation sharing policy. If unspecified, the reservation
979 # will not be shared with Google Cloud managed services.
980 &quot;serviceShareType&quot;: &quot;A String&quot;, # Sharing config for all Google Cloud services.
981 },
982 &quot;resourcePolicies&quot;: { # Resource policies to be added to this reservation. The key is defined by
983 # user, and the value is resource policy url. This is to define placement
984 # policy with reservation.
985 &quot;a_key&quot;: &quot;A String&quot;,
986 },
987 &quot;resourceStatus&quot;: { # [Output Only] Contains output only fields. # Output only. [Output Only] Status information for Reservation resource.
988 &quot;healthInfo&quot;: { # Health information for the reservation. # [Output only] Health information for the reservation.
989 &quot;degradedBlockCount&quot;: 42, # The number of reservation blocks that are degraded.
990 &quot;healthStatus&quot;: &quot;A String&quot;, # The health status of the reservation.
991 &quot;healthyBlockCount&quot;: 42, # The number of reservation blocks that are healthy.
992 },
993 &quot;reservationBlockCount&quot;: 42, # The number of reservation blocks associated with this reservation.
994 &quot;reservationMaintenance&quot;: { # Maintenance Info for ReservationBlocks. # Maintenance information for this reservation
995 &quot;instanceMaintenanceOngoingCount&quot;: 42, # Describes number of instances that have ongoing maintenance.
996 &quot;instanceMaintenancePendingCount&quot;: 42, # Describes number of instances that have pending maintenance.
997 &quot;maintenanceOngoingCount&quot;: 42, # Progress for ongoing maintenance for this group of VMs/hosts.
998 # Describes number of hosts in the block that have ongoing maintenance.
999 &quot;maintenancePendingCount&quot;: 42, # Progress for ongoing maintenance for this group of VMs/hosts.
1000 # Describes number of hosts in the block that have pending maintenance.
1001 &quot;schedulingType&quot;: &quot;A String&quot;, # The type of maintenance for the reservation.
1002 &quot;subblockInfraMaintenanceOngoingCount&quot;: 42, # Describes number of subblock Infrastructure that has ongoing maintenance.
1003 # Here, Subblock Infrastructure Maintenance pertains to upstream hardware
1004 # contained in the Subblock that is necessary for a VM Family(e.g. NVLink
1005 # Domains). Not all VM Families will support this field.
1006 &quot;subblockInfraMaintenancePendingCount&quot;: 42, # Describes number of subblock Infrastructure that has pending maintenance.
1007 # Here, Subblock Infrastructure Maintenance pertains to upstream hardware
1008 # contained in the Subblock that is necessary for a VM Family (e.g. NVLink
1009 # Domains). Not all VM Families will support this field.
1010 &quot;upcomingGroupMaintenance&quot;: { # Upcoming Maintenance notification information. # Maintenance information on this group of VMs.
1011 &quot;canReschedule&quot;: True or False, # Indicates if the maintenance can be customer triggered.
1012 &quot;latestWindowStartTime&quot;: &quot;A String&quot;, # The latest time for the planned maintenance window to start.
1013 # This timestamp value is in RFC3339 text format.
1014 &quot;maintenanceOnShutdown&quot;: True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown.
1015 &quot;maintenanceReasons&quot;: [ # The reasons for the maintenance. Only valid for vms.
1016 &quot;A String&quot;,
1017 ],
1018 &quot;maintenanceStatus&quot;: &quot;A String&quot;,
1019 &quot;type&quot;: &quot;A String&quot;, # Defines the type of maintenance.
1020 &quot;windowEndTime&quot;: &quot;A String&quot;, # The time by which the maintenance disruption will be completed.
1021 # This timestamp value is in RFC3339 text format.
1022 &quot;windowStartTime&quot;: &quot;A String&quot;, # The current start time of the maintenance window.
1023 # This timestamp value is in RFC3339 text format.
1024 },
1025 },
1026 &quot;specificSkuAllocation&quot;: { # Contains Properties set for the reservation. # Allocation Properties of this reservation.
1027 &quot;sourceInstanceTemplateId&quot;: &quot;A String&quot;, # ID of the instance template used to populate reservation properties.
1028 &quot;utilizations&quot;: { # Per service utilization breakdown. The Key is the Google Cloud managed
1029 # service name.
1030 &quot;a_key&quot;: &quot;A String&quot;,
1031 },
1032 },
1033 },
1034 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
1035 &quot;schedulingType&quot;: &quot;A String&quot;, # The type of maintenance for the reservation.
1036 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
1037 &quot;shareSettings&quot;: { # The share setting for reservations and sole tenancy node groups. # Specify share-settings to create a shared reservation. This property is
1038 # optional. For more information about the syntax and options for this
1039 # field and its subfields, see the guide for creating
1040 # a shared reservation.
1041 &quot;folderMap&quot;: { # A map of folder id and folder config to specify consumer projects for this
1042 # shared-reservation. This is only valid when share_type&#x27;s value is
1043 # DIRECT_PROJECTS_UNDER_SPECIFIC_FOLDERS.
1044 # Folder id should be a string of number, and without &quot;folders/&quot; prefix.
1045 &quot;a_key&quot;: { # Config for each folder in the share settings.
1046 &quot;folderId&quot;: &quot;A String&quot;, # The folder ID, should be same as the key of this folder config in the
1047 # parent map.
1048 # Folder id should be a string of number, and without &quot;folders/&quot; prefix.
1049 },
1050 },
1051 &quot;projectMap&quot;: { # A map of project id and project config. This is only valid when
1052 # share_type&#x27;s value is SPECIFIC_PROJECTS.
1053 &quot;a_key&quot;: { # Config for each project in the share settings.
1054 &quot;projectId&quot;: &quot;A String&quot;, # The project ID, should be same as the key of this project config in the
1055 # parent map.
1056 },
1057 },
1058 &quot;projects&quot;: [ # A List of Project names to specify consumer projects for this
1059 # shared-reservation. This is only valid when share_type&#x27;s value is
1060 # SPECIFIC_PROJECTS.
1061 &quot;A String&quot;,
1062 ],
1063 &quot;shareType&quot;: &quot;A String&quot;, # Type of sharing for this shared-reservation
1064 },
1065 &quot;specificReservation&quot;: { # This reservation type allows to pre allocate specific instance # Reservation for instances with specific machine shapes.
1066 # configuration.
1067 &quot;assuredCount&quot;: &quot;A String&quot;, # Output only. [Output Only] Indicates how many instances are actually usable currently.
1068 &quot;count&quot;: &quot;A String&quot;, # Specifies the number of resources that are allocated.
1069 &quot;inUseCount&quot;: &quot;A String&quot;, # Output only. [Output Only] Indicates how many instances are in use.
1070 &quot;instanceProperties&quot;: { # Properties of the SKU instances being reserved. # The instance properties for the reservation.
1071 # Next ID: 10
1072 &quot;guestAccelerators&quot;: [ # Specifies accelerator type and count.
1073 { # A specification of the type and number of accelerator cards attached to the
1074 # instance.
1075 &quot;acceleratorCount&quot;: 42, # The number of the guest accelerator cards exposed to this instance.
1076 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL of the accelerator type resource to attach to this
1077 # instance. For example:projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100
1078 # If you are creating an instance template, specify only the
1079 # accelerator name.
1080 # See GPUs on Compute Engine
1081 # for a full list of accelerator types.
1082 },
1083 ],
1084 &quot;localSsds&quot;: [ # Specifies amount of local ssd to reserve with each instance. The type
1085 # of disk is local-ssd.
1086 {
1087 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Specifies the size of the disk in base-2 GB.
1088 &quot;interface&quot;: &quot;A String&quot;, # Specifies the disk interface to use for attaching this disk, which is
1089 # either SCSI or NVME. The default isSCSI.
1090 # For performance characteristics of SCSI over NVMe, seeLocal SSD performance.
1091 },
1092 ],
1093 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the allocation close to other
1094 # resources.
1095 # This field is for use by internal tools that use the public API.
1096 &quot;machineType&quot;: &quot;A String&quot;, # Specifies type of machine (name only) which has fixed number of vCPUs
1097 # and fixed amount of memory. This also includes specifying custom
1098 # machine type following custom-NUMBER_OF_CPUS-AMOUNT_OF_MEMORY pattern.
1099 &quot;maintenanceFreezeDurationHours&quot;: 42, # Specifies the number of hours after reservation creation where
1100 # instances using the reservation won&#x27;t be scheduled for maintenance.
1101 &quot;maintenanceInterval&quot;: &quot;A String&quot;, # Specifies the frequency of planned maintenance events. The accepted
1102 # values are: `PERIODIC`.
1103 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Minimum cpu platform the reservation.
1104 },
1105 &quot;sourceInstanceTemplate&quot;: &quot;A String&quot;, # Specifies the instance template to create the reservation. If you use
1106 # this field, you must exclude the instanceProperties field.
1107 #
1108 # This field is optional, and it can be a full or partial URL. For example,
1109 # the following are all valid URLs to an instance template:
1110 #
1111 #
1112 # - https://www.googleapis.com/compute/v1/projects/project/global/instanceTemplates/instanceTemplate
1113 # - projects/project/global/instanceTemplates/instanceTemplate
1114 # - global/instanceTemplates/instanceTemplate
1115 },
1116 &quot;specificReservationRequired&quot;: True or False, # Indicates whether the reservation can be consumed by VMs with affinity
1117 # for &quot;any&quot; reservation. If the field is set, then only VMs that target
1118 # the reservation by name can consume from this reservation.
1119 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of the reservation.
1120 #
1121 #
1122 # - CREATING: Reservation resources are being
1123 # allocated.
1124 # - READY: Reservation resources have been allocated,
1125 # and the reservation is ready for use.
1126 # - DELETING: Reservation deletion is in progress.
1127 # - UPDATING: Reservation update is in progress.
1128 &quot;zone&quot;: &quot;A String&quot;, # Zone in which the reservation resides. A zone must be provided if the
1129 # reservation is created within a commitment.
1130 }</pre>
1131 </div>
1132
1133 <div class="method">
1134 <code class="details" id="getIamPolicy">getIamPolicy(project, zone, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</code>
1135 <pre>Gets the access control policy for a resource. May be empty if no such
1136 policy or resource exists.
1137
1138 Args:
1139 project: string, Project ID for this request. (required)
1140 zone: string, The name of the zone for this request. (required)
1141 resource: string, Name or id of the resource for this request. (required)
1142 optionsRequestedPolicyVersion: integer, Requested IAM Policy version.
1143 x__xgafv: string, V1 error format.
1144 Allowed values
1145 1 - v1 error format
1146 2 - v2 error format
1147
1148 Returns:
1149 An object of the form:
1150
1151 { # An Identity and Access Management (IAM) policy, which specifies access
1152 # controls for Google Cloud resources.
1153 #
1154 #
1155 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
1156 # `members`, or principals, to a single `role`. Principals can be user
1157 # accounts, service accounts, Google groups, and domains (such as G Suite). A
1158 # `role` is a named list of permissions; each `role` can be an IAM predefined
1159 # role or a user-created custom role.
1160 #
1161 # For some types of Google Cloud resources, a `binding` can also specify a
1162 # `condition`, which is a logical expression that allows access to a resource
1163 # only if the expression evaluates to `true`. A condition can add constraints
1164 # based on attributes of the request, the resource, or both. To learn which
1165 # resources support conditions in their IAM policies, see the
1166 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
1167 #
1168 # **JSON example:**
1169 #
1170 # ```
1171 # {
1172 # &quot;bindings&quot;: [
1173 # {
1174 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
1175 # &quot;members&quot;: [
1176 # &quot;user:[email protected]&quot;,
1177 # &quot;group:[email protected]&quot;,
1178 # &quot;domain:google.com&quot;,
1179 # &quot;serviceAccount:[email protected]&quot;
1180 # ]
1181 # },
1182 # {
1183 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
1184 # &quot;members&quot;: [
1185 # &quot;user:[email protected]&quot;
1186 # ],
1187 # &quot;condition&quot;: {
1188 # &quot;title&quot;: &quot;expirable access&quot;,
1189 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
1190 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
1191 # }
1192 # }
1193 # ],
1194 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
1195 # &quot;version&quot;: 3
1196 # }
1197 # ```
1198 #
1199 # **YAML example:**
1200 #
1201 # ```
1202 # bindings:
1203 # - members:
1204 # - user:[email protected]
1205 # - group:[email protected]
1206 # - domain:google.com
1207 # - serviceAccount:[email protected]
1208 # role: roles/resourcemanager.organizationAdmin
1209 # - members:
1210 # - user:[email protected]
1211 # role: roles/resourcemanager.organizationViewer
1212 # condition:
1213 # title: expirable access
1214 # description: Does not grant access after Sep 2020
1215 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
1216 # etag: BwWWja0YfJA=
1217 # version: 3
1218 # ```
1219 #
1220 # For a description of IAM and its features, see the
1221 # [IAM documentation](https://cloud.google.com/iam/docs/).
1222 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
1223 { # Specifies the audit configuration for a service.
1224 # The configuration determines which permission types are logged, and what
1225 # identities, if any, are exempted from logging.
1226 # An AuditConfig must have one or more AuditLogConfigs.
1227 #
1228 # If there are AuditConfigs for both `allServices` and a specific service,
1229 # the union of the two AuditConfigs is used for that service: the log_types
1230 # specified in each AuditConfig are enabled, and the exempted_members in each
1231 # AuditLogConfig are exempted.
1232 #
1233 # Example Policy with multiple AuditConfigs:
1234 #
1235 # {
1236 # &quot;audit_configs&quot;: [
1237 # {
1238 # &quot;service&quot;: &quot;allServices&quot;,
1239 # &quot;audit_log_configs&quot;: [
1240 # {
1241 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
1242 # &quot;exempted_members&quot;: [
1243 # &quot;user:[email protected]&quot;
1244 # ]
1245 # },
1246 # {
1247 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
1248 # },
1249 # {
1250 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
1251 # }
1252 # ]
1253 # },
1254 # {
1255 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
1256 # &quot;audit_log_configs&quot;: [
1257 # {
1258 # &quot;log_type&quot;: &quot;DATA_READ&quot;
1259 # },
1260 # {
1261 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
1262 # &quot;exempted_members&quot;: [
1263 # &quot;user:[email protected]&quot;
1264 # ]
1265 # }
1266 # ]
1267 # }
1268 # ]
1269 # }
1270 #
1271 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
1272 # logging. It also exempts `[email protected]` from DATA_READ logging, and
1273 # `[email protected]` from DATA_WRITE logging.
1274 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
1275 { # Provides the configuration for logging a type of permissions.
1276 # Example:
1277 #
1278 # {
1279 # &quot;audit_log_configs&quot;: [
1280 # {
1281 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
1282 # &quot;exempted_members&quot;: [
1283 # &quot;user:[email protected]&quot;
1284 # ]
1285 # },
1286 # {
1287 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
1288 # }
1289 # ]
1290 # }
1291 #
1292 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
1293 # [email protected] from DATA_READ logging.
1294 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
1295 # permission.
1296 # Follows the same format of Binding.members.
1297 &quot;A String&quot;,
1298 ],
1299 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
1300 },
1301 ],
1302 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
1303 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
1304 # `allServices` is a special value that covers all services.
1305 },
1306 ],
1307 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
1308 # may specify a `condition` that determines how and when the `bindings` are
1309 # applied. Each of the `bindings` must contain at least one principal.
1310 #
1311 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
1312 # of these principals can be Google groups. Each occurrence of a principal
1313 # counts towards these limits. For example, if the `bindings` grant 50
1314 # different roles to `user:[email protected]`, and not to any other
1315 # principal, then you can add another 1,450 principals to the `bindings` in
1316 # the `Policy`.
1317 { # Associates `members`, or principals, with a `role`.
1318 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
1319 #
1320 # If the condition evaluates to `true`, then this binding applies to the
1321 # current request.
1322 #
1323 # If the condition evaluates to `false`, then this binding does not apply to
1324 # the current request. However, a different role binding might grant the same
1325 # role to one or more of the principals in this binding.
1326 #
1327 # To learn which resources support conditions in their IAM policies, see the
1328 # [IAM
1329 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
1330 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
1331 # are documented at https://github.com/google/cel-spec.
1332 #
1333 # Example (Comparison):
1334 #
1335 # title: &quot;Summary size limit&quot;
1336 # description: &quot;Determines if a summary is less than 100 chars&quot;
1337 # expression: &quot;document.summary.size() &lt; 100&quot;
1338 #
1339 # Example (Equality):
1340 #
1341 # title: &quot;Requestor is owner&quot;
1342 # description: &quot;Determines if requestor is the document owner&quot;
1343 # expression: &quot;document.owner == request.auth.claims.email&quot;
1344 #
1345 # Example (Logic):
1346 #
1347 # title: &quot;Public documents&quot;
1348 # description: &quot;Determine whether the document should be publicly visible&quot;
1349 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
1350 #
1351 # Example (Data Manipulation):
1352 #
1353 # title: &quot;Notification string&quot;
1354 # description: &quot;Create a notification string with a timestamp.&quot;
1355 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
1356 #
1357 # The exact variables and functions that may be referenced within an expression
1358 # are determined by the service that evaluates it. See the service
1359 # documentation for additional information.
1360 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
1361 # describes the expression, e.g. when hovered over it in a UI.
1362 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
1363 # syntax.
1364 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
1365 # reporting, e.g. a file name and a position in the file.
1366 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
1367 # its purpose. This can be used e.g. in UIs which allow to enter the
1368 # expression.
1369 },
1370 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
1371 # `members` can have the following values:
1372 #
1373 # * `allUsers`: A special identifier that represents anyone who is
1374 # on the internet; with or without a Google account.
1375 #
1376 # * `allAuthenticatedUsers`: A special identifier that represents anyone
1377 # who is authenticated with a Google account or a service account.
1378 # Does not include identities that come from external identity providers
1379 # (IdPs) through identity federation.
1380 #
1381 # * `user:{emailid}`: An email address that represents a specific Google
1382 # account. For example, `[email protected]` .
1383 #
1384 #
1385 # * `serviceAccount:{emailid}`: An email address that represents a Google
1386 # service account. For example,
1387 # `[email protected]`.
1388 #
1389 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
1390 # identifier for a
1391 # [Kubernetes service
1392 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
1393 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
1394 #
1395 # * `group:{emailid}`: An email address that represents a Google group.
1396 # For example, `[email protected]`.
1397 #
1398 #
1399 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
1400 # users of that domain. For example, `google.com` or `example.com`.
1401 #
1402 #
1403 #
1404 #
1405 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
1406 # A single identity in a workforce identity pool.
1407 #
1408 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
1409 # All workforce identities in a group.
1410 #
1411 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
1412 # All workforce identities with a specific attribute value.
1413 #
1414 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
1415 # All identities in a workforce identity pool.
1416 #
1417 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
1418 # A single identity in a workload identity pool.
1419 #
1420 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
1421 # A workload identity pool group.
1422 #
1423 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
1424 # All identities in a workload identity pool with a certain attribute.
1425 #
1426 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
1427 # All identities in a workload identity pool.
1428 #
1429 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
1430 # identifier) representing a user that has been recently deleted. For
1431 # example, `[email protected]?uid=123456789012345678901`. If the user is
1432 # recovered, this value reverts to `user:{emailid}` and the recovered user
1433 # retains the role in the binding.
1434 #
1435 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
1436 # unique identifier) representing a service account that has been recently
1437 # deleted. For example,
1438 # `[email protected]?uid=123456789012345678901`.
1439 # If the service account is undeleted, this value reverts to
1440 # `serviceAccount:{emailid}` and the undeleted service account retains the
1441 # role in the binding.
1442 #
1443 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
1444 # identifier) representing a Google group that has been recently
1445 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
1446 # the group is recovered, this value reverts to `group:{emailid}` and the
1447 # recovered group retains the role in the binding.
1448 #
1449 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
1450 # Deleted single identity in a workforce identity pool. For example,
1451 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
1452 &quot;A String&quot;,
1453 ],
1454 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
1455 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
1456 #
1457 # For an overview of the IAM roles and permissions, see the
1458 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
1459 # a list of the available pre-defined roles, see
1460 # [here](https://cloud.google.com/iam/docs/understanding-roles).
1461 },
1462 ],
1463 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
1464 # prevent simultaneous updates of a policy from overwriting each other.
1465 # It is strongly suggested that systems make use of the `etag` in the
1466 # read-modify-write cycle to perform policy updates in order to avoid race
1467 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
1468 # systems are expected to put that etag in the request to `setIamPolicy` to
1469 # ensure that their change will be applied to the same version of the policy.
1470 #
1471 # **Important:** If you use IAM Conditions, you must include the `etag` field
1472 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
1473 # you to overwrite a version `3` policy with a version `1` policy, and all of
1474 # the conditions in the version `3` policy are lost.
1475 &quot;version&quot;: 42, # Specifies the format of the policy.
1476 #
1477 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
1478 # are rejected.
1479 #
1480 # Any operation that affects conditional role bindings must specify version
1481 # `3`. This requirement applies to the following operations:
1482 #
1483 # * Getting a policy that includes a conditional role binding
1484 # * Adding a conditional role binding to a policy
1485 # * Changing a conditional role binding in a policy
1486 # * Removing any role binding, with or without a condition, from a policy
1487 # that includes conditions
1488 #
1489 # **Important:** If you use IAM Conditions, you must include the `etag` field
1490 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
1491 # you to overwrite a version `3` policy with a version `1` policy, and all of
1492 # the conditions in the version `3` policy are lost.
1493 #
1494 # If a policy does not include any conditions, operations on that policy may
1495 # specify any valid version or leave the field unset.
1496 #
1497 # To learn which resources support conditions in their IAM policies, see the
1498 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
1499 }</pre>
1500 </div>
1501
1502 <div class="method">
1503 <code class="details" id="insert">insert(project, zone, body=None, requestId=None, x__xgafv=None)</code>
1504 <pre>Creates a new reservation. For more information, readReserving zonal
1505 resources.
1506
1507 Args:
1508 project: string, Project ID for this request. (required)
1509 zone: string, Name of the zone for this request. (required)
1510 body: object, The request body.
1511 The object takes the form of:
1512
1513 { # Represents a reservation resource. A reservation ensures that capacity is
1514 # held in a specific zone even if the reserved VMs are not running. For more
1515 # information, read Reserving zonal
1516 # resources.
1517 &quot;advancedDeploymentControl&quot;: { # Advance control for cluster management, applicable only to DENSE deployment # Advanced control for cluster management, applicable only to DENSE
1518 # deployment type reservations.
1519 # type reservations.
1520 &quot;reservationOperationalMode&quot;: &quot;A String&quot;, # Indicates chosen reservation operational mode for the reservation.
1521 },
1522 &quot;aggregateReservation&quot;: { # This reservation type is specified by total resource amounts (e.g. total # Reservation for aggregated resources, providing shape flexibility.
1523 # count of CPUs) and can account for multiple instance SKUs. In other words,
1524 # one can create instances of varying shapes against this reservation.
1525 &quot;hostCount&quot;: 42, # Count of reserved hosts of specified VM family. The host has fixed number
1526 # of accelerators based on the accelerator/vm-family selected.
1527 &quot;inUseHostCount&quot;: 42, # Output only. Number of hosts currently in use. If there is one or more Instances
1528 # running on the host, it is considered in use.
1529 &quot;inUseInstanceCount&quot;: 42, # Output only. Number of instances currently in use in this reservation.
1530 &quot;inUseResources&quot;: [ # Output only. [Output only] List of resources currently in use.
1531 {
1532 &quot;accelerator&quot;: { # Properties of accelerator resources in this reservation.
1533 &quot;acceleratorCount&quot;: 42, # Number of accelerators of specified type.
1534 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL to accelerator type. e.g.
1535 # &quot;projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l&quot;
1536 },
1537 },
1538 ],
1539 &quot;reservedResources&quot;: [ # List of reserved resources (CPUs, memory, accelerators).
1540 {
1541 &quot;accelerator&quot;: { # Properties of accelerator resources in this reservation.
1542 &quot;acceleratorCount&quot;: 42, # Number of accelerators of specified type.
1543 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL to accelerator type. e.g.
1544 # &quot;projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l&quot;
1545 },
1546 },
1547 ],
1548 &quot;vmFamily&quot;: &quot;A String&quot;, # The VM family that all instances scheduled against this reservation must
1549 # belong to.
1550 &quot;workloadType&quot;: &quot;A String&quot;, # The workload type of the instances that will target this reservation.
1551 },
1552 &quot;commitment&quot;: &quot;A String&quot;, # Output only. [Output Only] Full or partial URL to a parent commitment. This field
1553 # displays for reservations that are tied to a commitment.
1554 &quot;confidentialComputeType&quot;: &quot;A String&quot;,
1555 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1556 # text format.
1557 &quot;deleteAfterDuration&quot;: { # A Duration represents a fixed-length span of time represented # Duration time relative to reservation creation when Compute Engine will
1558 # automatically delete this resource.
1559 # as a count of seconds and fractions of seconds at nanosecond
1560 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
1561 # or &quot;month&quot;. Range is approximately 10,000 years.
1562 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
1563 # Durations less than one second are represented with a 0
1564 # `seconds` field and a positive `nanos` field. Must be from 0
1565 # to 999,999,999 inclusive.
1566 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
1567 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
1568 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
1569 },
1570 &quot;deleteAtTime&quot;: &quot;A String&quot;, # Absolute time in future when the reservation will be
1571 # auto-deleted by Compute Engine. Timestamp is represented inRFC3339 text format.
1572 &quot;deploymentType&quot;: &quot;A String&quot;, # Specifies the deployment strategy for this reservation.
1573 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
1574 # create the resource.
1575 &quot;earlyAccessMaintenance&quot;: &quot;A String&quot;, # Indicates the early access maintenance for the reservation.
1576 # If this field is absent or set to NO_EARLY_ACCESS, the reservation is not
1577 # enrolled in early access maintenance and the standard notice applies.
1578 &quot;enableEmergentMaintenance&quot;: True or False, # Indicates whether Compute Engine allows unplanned maintenance for your VMs;
1579 # for example, to fix hardware errors.
1580 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
1581 # defined by the server.
1582 &quot;kind&quot;: &quot;compute#reservation&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#reservations for reservations.
1583 &quot;linkedCommitments&quot;: [ # Output only. [Output Only] Full or partial URL to parent commitments. This field
1584 # displays for reservations that are tied to multiple commitments.
1585 &quot;A String&quot;,
1586 ],
1587 &quot;name&quot;: &quot;A String&quot;, # The name of the resource, provided by the client when initially creating
1588 # the resource. The resource name must be 1-63 characters long, and comply
1589 # withRFC1035.
1590 # Specifically, the name must be 1-63 characters long and match the regular
1591 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
1592 # character must be a lowercase letter, and all following characters must be
1593 # a dash, lowercase letter, or digit, except the last character, which cannot
1594 # be a dash.
1595 &quot;params&quot;: { # Additional reservation params. # Input only. Additional params passed with the request, but not persisted
1596 # as part of resource payload.
1597 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the reservation. Tag keys and
1598 # values have the same definition as resource
1599 # manager tags. Keys and values can be either in numeric format,
1600 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
1601 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
1602 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
1603 # PATCH) when empty.
1604 &quot;a_key&quot;: &quot;A String&quot;,
1605 },
1606 },
1607 &quot;protectionTier&quot;: &quot;A String&quot;, # Protection tier for the workload which specifies the workload expectations
1608 # in the event of infrastructure failures at data center (e.g. power
1609 # and/or cooling failures).
1610 &quot;reservationMode&quot;: &quot;A String&quot;, # Output only. [Output only] Indicates the reservation mode of the reservation.
1611 &quot;reservationSharingPolicy&quot;: { # Specify the reservation sharing policy. If unspecified, the reservation
1612 # will not be shared with Google Cloud managed services.
1613 &quot;serviceShareType&quot;: &quot;A String&quot;, # Sharing config for all Google Cloud services.
1614 },
1615 &quot;resourcePolicies&quot;: { # Resource policies to be added to this reservation. The key is defined by
1616 # user, and the value is resource policy url. This is to define placement
1617 # policy with reservation.
1618 &quot;a_key&quot;: &quot;A String&quot;,
1619 },
1620 &quot;resourceStatus&quot;: { # [Output Only] Contains output only fields. # Output only. [Output Only] Status information for Reservation resource.
1621 &quot;healthInfo&quot;: { # Health information for the reservation. # [Output only] Health information for the reservation.
1622 &quot;degradedBlockCount&quot;: 42, # The number of reservation blocks that are degraded.
1623 &quot;healthStatus&quot;: &quot;A String&quot;, # The health status of the reservation.
1624 &quot;healthyBlockCount&quot;: 42, # The number of reservation blocks that are healthy.
1625 },
1626 &quot;reservationBlockCount&quot;: 42, # The number of reservation blocks associated with this reservation.
1627 &quot;reservationMaintenance&quot;: { # Maintenance Info for ReservationBlocks. # Maintenance information for this reservation
1628 &quot;instanceMaintenanceOngoingCount&quot;: 42, # Describes number of instances that have ongoing maintenance.
1629 &quot;instanceMaintenancePendingCount&quot;: 42, # Describes number of instances that have pending maintenance.
1630 &quot;maintenanceOngoingCount&quot;: 42, # Progress for ongoing maintenance for this group of VMs/hosts.
1631 # Describes number of hosts in the block that have ongoing maintenance.
1632 &quot;maintenancePendingCount&quot;: 42, # Progress for ongoing maintenance for this group of VMs/hosts.
1633 # Describes number of hosts in the block that have pending maintenance.
1634 &quot;schedulingType&quot;: &quot;A String&quot;, # The type of maintenance for the reservation.
1635 &quot;subblockInfraMaintenanceOngoingCount&quot;: 42, # Describes number of subblock Infrastructure that has ongoing maintenance.
1636 # Here, Subblock Infrastructure Maintenance pertains to upstream hardware
1637 # contained in the Subblock that is necessary for a VM Family(e.g. NVLink
1638 # Domains). Not all VM Families will support this field.
1639 &quot;subblockInfraMaintenancePendingCount&quot;: 42, # Describes number of subblock Infrastructure that has pending maintenance.
1640 # Here, Subblock Infrastructure Maintenance pertains to upstream hardware
1641 # contained in the Subblock that is necessary for a VM Family (e.g. NVLink
1642 # Domains). Not all VM Families will support this field.
1643 &quot;upcomingGroupMaintenance&quot;: { # Upcoming Maintenance notification information. # Maintenance information on this group of VMs.
1644 &quot;canReschedule&quot;: True or False, # Indicates if the maintenance can be customer triggered.
1645 &quot;latestWindowStartTime&quot;: &quot;A String&quot;, # The latest time for the planned maintenance window to start.
1646 # This timestamp value is in RFC3339 text format.
1647 &quot;maintenanceOnShutdown&quot;: True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown.
1648 &quot;maintenanceReasons&quot;: [ # The reasons for the maintenance. Only valid for vms.
1649 &quot;A String&quot;,
1650 ],
1651 &quot;maintenanceStatus&quot;: &quot;A String&quot;,
1652 &quot;type&quot;: &quot;A String&quot;, # Defines the type of maintenance.
1653 &quot;windowEndTime&quot;: &quot;A String&quot;, # The time by which the maintenance disruption will be completed.
1654 # This timestamp value is in RFC3339 text format.
1655 &quot;windowStartTime&quot;: &quot;A String&quot;, # The current start time of the maintenance window.
1656 # This timestamp value is in RFC3339 text format.
1657 },
1658 },
1659 &quot;specificSkuAllocation&quot;: { # Contains Properties set for the reservation. # Allocation Properties of this reservation.
1660 &quot;sourceInstanceTemplateId&quot;: &quot;A String&quot;, # ID of the instance template used to populate reservation properties.
1661 &quot;utilizations&quot;: { # Per service utilization breakdown. The Key is the Google Cloud managed
1662 # service name.
1663 &quot;a_key&quot;: &quot;A String&quot;,
1664 },
1665 },
1666 },
1667 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
1668 &quot;schedulingType&quot;: &quot;A String&quot;, # The type of maintenance for the reservation.
1669 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
1670 &quot;shareSettings&quot;: { # The share setting for reservations and sole tenancy node groups. # Specify share-settings to create a shared reservation. This property is
1671 # optional. For more information about the syntax and options for this
1672 # field and its subfields, see the guide for creating
1673 # a shared reservation.
1674 &quot;folderMap&quot;: { # A map of folder id and folder config to specify consumer projects for this
1675 # shared-reservation. This is only valid when share_type&#x27;s value is
1676 # DIRECT_PROJECTS_UNDER_SPECIFIC_FOLDERS.
1677 # Folder id should be a string of number, and without &quot;folders/&quot; prefix.
1678 &quot;a_key&quot;: { # Config for each folder in the share settings.
1679 &quot;folderId&quot;: &quot;A String&quot;, # The folder ID, should be same as the key of this folder config in the
1680 # parent map.
1681 # Folder id should be a string of number, and without &quot;folders/&quot; prefix.
1682 },
1683 },
1684 &quot;projectMap&quot;: { # A map of project id and project config. This is only valid when
1685 # share_type&#x27;s value is SPECIFIC_PROJECTS.
1686 &quot;a_key&quot;: { # Config for each project in the share settings.
1687 &quot;projectId&quot;: &quot;A String&quot;, # The project ID, should be same as the key of this project config in the
1688 # parent map.
1689 },
1690 },
1691 &quot;projects&quot;: [ # A List of Project names to specify consumer projects for this
1692 # shared-reservation. This is only valid when share_type&#x27;s value is
1693 # SPECIFIC_PROJECTS.
1694 &quot;A String&quot;,
1695 ],
1696 &quot;shareType&quot;: &quot;A String&quot;, # Type of sharing for this shared-reservation
1697 },
1698 &quot;specificReservation&quot;: { # This reservation type allows to pre allocate specific instance # Reservation for instances with specific machine shapes.
1699 # configuration.
1700 &quot;assuredCount&quot;: &quot;A String&quot;, # Output only. [Output Only] Indicates how many instances are actually usable currently.
1701 &quot;count&quot;: &quot;A String&quot;, # Specifies the number of resources that are allocated.
1702 &quot;inUseCount&quot;: &quot;A String&quot;, # Output only. [Output Only] Indicates how many instances are in use.
1703 &quot;instanceProperties&quot;: { # Properties of the SKU instances being reserved. # The instance properties for the reservation.
1704 # Next ID: 10
1705 &quot;guestAccelerators&quot;: [ # Specifies accelerator type and count.
1706 { # A specification of the type and number of accelerator cards attached to the
1707 # instance.
1708 &quot;acceleratorCount&quot;: 42, # The number of the guest accelerator cards exposed to this instance.
1709 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL of the accelerator type resource to attach to this
1710 # instance. For example:projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100
1711 # If you are creating an instance template, specify only the
1712 # accelerator name.
1713 # See GPUs on Compute Engine
1714 # for a full list of accelerator types.
1715 },
1716 ],
1717 &quot;localSsds&quot;: [ # Specifies amount of local ssd to reserve with each instance. The type
1718 # of disk is local-ssd.
1719 {
1720 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Specifies the size of the disk in base-2 GB.
1721 &quot;interface&quot;: &quot;A String&quot;, # Specifies the disk interface to use for attaching this disk, which is
1722 # either SCSI or NVME. The default isSCSI.
1723 # For performance characteristics of SCSI over NVMe, seeLocal SSD performance.
1724 },
1725 ],
1726 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the allocation close to other
1727 # resources.
1728 # This field is for use by internal tools that use the public API.
1729 &quot;machineType&quot;: &quot;A String&quot;, # Specifies type of machine (name only) which has fixed number of vCPUs
1730 # and fixed amount of memory. This also includes specifying custom
1731 # machine type following custom-NUMBER_OF_CPUS-AMOUNT_OF_MEMORY pattern.
1732 &quot;maintenanceFreezeDurationHours&quot;: 42, # Specifies the number of hours after reservation creation where
1733 # instances using the reservation won&#x27;t be scheduled for maintenance.
1734 &quot;maintenanceInterval&quot;: &quot;A String&quot;, # Specifies the frequency of planned maintenance events. The accepted
1735 # values are: `PERIODIC`.
1736 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Minimum cpu platform the reservation.
1737 },
1738 &quot;sourceInstanceTemplate&quot;: &quot;A String&quot;, # Specifies the instance template to create the reservation. If you use
1739 # this field, you must exclude the instanceProperties field.
1740 #
1741 # This field is optional, and it can be a full or partial URL. For example,
1742 # the following are all valid URLs to an instance template:
1743 #
1744 #
1745 # - https://www.googleapis.com/compute/v1/projects/project/global/instanceTemplates/instanceTemplate
1746 # - projects/project/global/instanceTemplates/instanceTemplate
1747 # - global/instanceTemplates/instanceTemplate
1748 },
1749 &quot;specificReservationRequired&quot;: True or False, # Indicates whether the reservation can be consumed by VMs with affinity
1750 # for &quot;any&quot; reservation. If the field is set, then only VMs that target
1751 # the reservation by name can consume from this reservation.
1752 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of the reservation.
1753 #
1754 #
1755 # - CREATING: Reservation resources are being
1756 # allocated.
1757 # - READY: Reservation resources have been allocated,
1758 # and the reservation is ready for use.
1759 # - DELETING: Reservation deletion is in progress.
1760 # - UPDATING: Reservation update is in progress.
1761 &quot;zone&quot;: &quot;A String&quot;, # Zone in which the reservation resides. A zone must be provided if the
1762 # reservation is created within a commitment.
1763 }
1764
1765 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1766 that if you must retry your request, the server will know to ignore the
1767 request if it has already been completed.
1768
1769 For example, consider a situation where you make an initial request and
1770 the request times out. If you make the request again with the same
1771 request ID, the server can check if original operation with the same
1772 request ID was received, and if so, will ignore the second request. This
1773 prevents clients from accidentally creating duplicate commitments.
1774
1775 The request ID must be
1776 a valid UUID with the exception that zero UUID is not supported
1777 (00000000-0000-0000-0000-000000000000).
1778 x__xgafv: string, V1 error format.
1779 Allowed values
1780 1 - v1 error format
1781 2 - v2 error format
1782
1783 Returns:
1784 An object of the form:
1785
1786 { # Represents an Operation resource.
1787 #
1788 # Google Compute Engine has three Operation resources:
1789 #
1790 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
1791 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
1792 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
1793 #
1794 # You can use an operation resource to manage asynchronous API requests.
1795 # For more information, readHandling
1796 # API responses.
1797 #
1798 # Operations can be global, regional or zonal.
1799 #
1800 # - For global operations, use the `globalOperations`
1801 # resource.
1802 # - For regional operations, use the
1803 # `regionOperations` resource.
1804 # - For zonal operations, use
1805 # the `zoneOperations` resource.
1806 #
1807 #
1808 #
1809 # For more information, read
1810 # Global, Regional, and Zonal Resources.
1811 #
1812 # Note that completed Operation resources have a limited
1813 # retention period.
1814 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1815 # Not present otherwise.
1816 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1817 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1818 # set when the operation is created.
1819 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1820 # text format.
1821 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1822 # this field will be populated.
1823 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1824 # operation.
1825 {
1826 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1827 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1828 # details. There is a set of defined message types to use for providing
1829 # details.The syntax depends on the error code. For example,
1830 # QuotaExceededInfo will have details when the error code is
1831 # QUOTA_EXCEEDED.
1832 {
1833 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1834 #
1835 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1836 # is not enabled:
1837 #
1838 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1839 # &quot;domain&quot;: &quot;googleapis.com&quot;
1840 # &quot;metadata&quot;: {
1841 # &quot;resource&quot;: &quot;projects/123&quot;,
1842 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1843 # }
1844 # }
1845 #
1846 # This response indicates that the pubsub.googleapis.com API is not enabled.
1847 #
1848 # Example of an error that is returned when attempting to create a Spanner
1849 # instance in a region that is out of stock:
1850 #
1851 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1852 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1853 # &quot;metadata&quot;: {
1854 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1855 # }
1856 # }
1857 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1858 # is typically the registered service name of the tool or product that
1859 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1860 # generated by some common infrastructure, the error domain must be a
1861 # globally unique value that identifies the infrastructure. For Google API
1862 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1863 &quot;metadatas&quot;: { # Additional structured details about this error.
1864 #
1865 # Keys must match a regular expression of `a-z+` but should
1866 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1867 # length. When identifying the current value of an exceeded limit, the units
1868 # should be contained in the key, not the value. For example, rather than
1869 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1870 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1871 # instances that can be created in a single (batch) request.
1872 &quot;a_key&quot;: &quot;A String&quot;,
1873 },
1874 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1875 # proximate cause of the error. Error reasons are unique within a particular
1876 # domain of errors. This should be at most 63 characters and match a
1877 # regular expression of `A-Z+[A-Z0-9]`, which represents
1878 # UPPER_SNAKE_CASE.
1879 },
1880 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1881 #
1882 # For example, if a quota check failed with an error indicating the calling
1883 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1884 # directly to the right place in the developer console to flip the bit.
1885 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1886 { # Describes a URL link.
1887 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1888 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1889 },
1890 ],
1891 },
1892 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1893 # which can be attached to an RPC error.
1894 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1895 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1896 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1897 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1898 },
1899 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1900 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1901 &quot;a_key&quot;: &quot;A String&quot;,
1902 },
1903 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1904 # type or metric.
1905 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1906 # or metric.
1907 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1908 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1909 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1910 },
1911 },
1912 ],
1913 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1914 # This property is optional.
1915 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1916 },
1917 ],
1918 },
1919 &quot;getVersionOperationMetadata&quot;: {
1920 &quot;inlineSbomInfo&quot;: {
1921 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1922 # appropriate identifiers.
1923 &quot;a_key&quot;: &quot;A String&quot;,
1924 },
1925 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1926 # identifiers.
1927 &quot;a_key&quot;: &quot;A String&quot;,
1928 },
1929 },
1930 },
1931 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1932 # message that was returned, such as `NOT FOUND`.
1933 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1934 # status code that was returned. For example, a `404` means the
1935 # resource was not found.
1936 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1937 # defined by the server.
1938 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1939 # This value is inRFC3339
1940 # text format.
1941 &quot;instancesBulkInsertOperationMetadata&quot;: {
1942 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1943 # Example key: zones/us-central1-a
1944 &quot;a_key&quot;: {
1945 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1946 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1947 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1948 # error.
1949 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1950 # if the flow is rolling forward or rolling back.
1951 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1952 },
1953 },
1954 },
1955 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1956 # Operation resources.
1957 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1958 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1959 # group of operations results from a `bulkInsert` API request.
1960 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1961 # `update`, or `delete`, and so on.
1962 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1963 # There is no requirement that this be linear or support any granularity of
1964 # operations. This should not be used to guess when the operation will be
1965 # complete. This number should monotonically increase as the operation
1966 # progresses.
1967 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1968 # applicable when performing regional operations.
1969 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1970 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1971 # this field will contain information on all underlying zonal actions and
1972 # their state.
1973 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1974 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1975 # Example key: zones/us-central1-a
1976 &quot;a_key&quot;: {
1977 &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
1978 # populated.
1979 # different programming environments, including REST APIs and RPC APIs. It is
1980 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1981 # three pieces of data: error code, error message, and error details.
1982 #
1983 # You can find out more about this error model and how to work with it in the
1984 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1985 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1986 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1987 # message types for APIs to use.
1988 {
1989 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1990 },
1991 ],
1992 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1993 # user-facing error message should be localized and sent in the
1994 # google.rpc.Status.details field, or localized by the client.
1995 },
1996 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1997 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1998 },
1999 },
2000 },
2001 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
2002 # This value is inRFC3339
2003 # text format.
2004 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
2005 # following:
2006 # `PENDING`, `RUNNING`, or `DONE`.
2007 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
2008 # operation.
2009 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
2010 # of the target resource.
2011 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
2012 # operations related to creating a snapshot, this points to the disk
2013 # that the snapshot was created from.
2014 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
2015 # `[email protected]` or
2016 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
2017 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
2018 # operation, this field will be populated.
2019 {
2020 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2021 # Engine returns NO_RESULTS_ON_PAGE if there
2022 # are no results in the response.
2023 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2024 # value format. For example:
2025 #
2026 # &quot;data&quot;: [
2027 # {
2028 # &quot;key&quot;: &quot;scope&quot;,
2029 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2030 # }
2031 {
2032 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2033 # returned. For example, for warnings where there are no results in a list
2034 # request for a particular zone, this key might be scope and
2035 # the key value might be the zone name. Other examples might be a key
2036 # indicating a deprecated resource and a suggested replacement, or a
2037 # warning about invalid network settings (for example, if an instance
2038 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2039 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2040 },
2041 ],
2042 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2043 },
2044 ],
2045 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
2046 # applicable when performing per-zone operations.
2047 }</pre>
2048 </div>
2049
2050 <div class="method">
2051 <code class="details" id="list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
2052 <pre>A list of all the reservations that have been configured for the
2053 specified project in specified zone.
2054
2055 Args:
2056 project: string, Project ID for this request. (required)
2057 zone: string, Name of the zone for this request. (required)
2058 filter: string, A filter expression that filters resources listed in the response. Most
2059 Compute resources support two types of filter expressions:
2060 expressions that support regular expressions and expressions that follow
2061 API improvement proposal AIP-160.
2062 These two types of filter expressions cannot be mixed in one request.
2063
2064 If you want to use AIP-160, your expression must specify the field name, an
2065 operator, and the value that you want to use for filtering. The value
2066 must be a string, a number, or a boolean. The operator
2067 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
2068
2069 For example, if you are filtering Compute Engine instances, you can
2070 exclude instances named `example-instance` by specifying
2071 `name != example-instance`.
2072
2073 The `:*` comparison can be used to test whether a key has been defined.
2074 For example, to find all objects with `owner` label use:
2075 ```
2076 labels.owner:*
2077 ```
2078
2079 You can also filter nested fields. For example, you could specify
2080 `scheduling.automaticRestart = false` to include instances only
2081 if they are not scheduled for automatic restarts. You can use filtering
2082 on nested fields to filter based onresource labels.
2083
2084 To filter on multiple expressions, provide each separate expression within
2085 parentheses. For example:
2086 ```
2087 (scheduling.automaticRestart = true)
2088 (cpuPlatform = &quot;Intel Skylake&quot;)
2089 ```
2090 By default, each expression is an `AND` expression. However, you
2091 can include `AND` and `OR` expressions explicitly.
2092 For example:
2093 ```
2094 (cpuPlatform = &quot;Intel Skylake&quot;) OR
2095 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
2096 (scheduling.automaticRestart = true)
2097 ```
2098
2099 If you want to use a regular expression, use the `eq` (equal) or `ne`
2100 (not equal) operator against a single un-parenthesized expression with or
2101 without quotes or against multiple parenthesized expressions. Examples:
2102
2103 `fieldname eq unquoted literal`
2104 `fieldname eq &#x27;single quoted literal&#x27;`
2105 `fieldname eq &quot;double quoted literal&quot;`
2106 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
2107
2108 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
2109 The literal value must match the entire field.
2110
2111 For example, to filter for instances that do not end with name &quot;instance&quot;,
2112 you would use `name ne .*instance`.
2113
2114 You cannot combine constraints on multiple fields using regular
2115 expressions.
2116 maxResults: integer, The maximum number of results per page that should be returned.
2117 If the number of available results is larger than `maxResults`,
2118 Compute Engine returns a `nextPageToken` that can be used to get
2119 the next page of results in subsequent list requests. Acceptable values are
2120 `0` to `500`, inclusive. (Default: `500`)
2121 orderBy: string, Sorts list results by a certain order. By default, results
2122 are returned in alphanumerical order based on the resource name.
2123
2124 You can also sort results in descending order based on the creation
2125 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
2126 results based on the `creationTimestamp` field in
2127 reverse chronological order (newest result first). Use this to sort
2128 resources like operations so that the newest operation is returned first.
2129
2130 Currently, only sorting by `name` or
2131 `creationTimestamp desc` is supported.
2132 pageToken: string, Specifies a page token to use. Set `pageToken` to the
2133 `nextPageToken` returned by a previous list request to get
2134 the next page of results.
2135 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
2136 of failure. The default value is false.
2137
2138 For example, when partial success behavior is enabled, aggregatedList for a
2139 single zone scope either returns all resources in the zone or no resources,
2140 with an error code.
2141 x__xgafv: string, V1 error format.
2142 Allowed values
2143 1 - v1 error format
2144 2 - v2 error format
2145
2146 Returns:
2147 An object of the form:
2148
2149 {
2150 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
2151 # defined by the server.
2152 &quot;items&quot;: [ # [Output Only] A list of Allocation resources.
2153 { # Represents a reservation resource. A reservation ensures that capacity is
2154 # held in a specific zone even if the reserved VMs are not running. For more
2155 # information, read Reserving zonal
2156 # resources.
2157 &quot;advancedDeploymentControl&quot;: { # Advance control for cluster management, applicable only to DENSE deployment # Advanced control for cluster management, applicable only to DENSE
2158 # deployment type reservations.
2159 # type reservations.
2160 &quot;reservationOperationalMode&quot;: &quot;A String&quot;, # Indicates chosen reservation operational mode for the reservation.
2161 },
2162 &quot;aggregateReservation&quot;: { # This reservation type is specified by total resource amounts (e.g. total # Reservation for aggregated resources, providing shape flexibility.
2163 # count of CPUs) and can account for multiple instance SKUs. In other words,
2164 # one can create instances of varying shapes against this reservation.
2165 &quot;hostCount&quot;: 42, # Count of reserved hosts of specified VM family. The host has fixed number
2166 # of accelerators based on the accelerator/vm-family selected.
2167 &quot;inUseHostCount&quot;: 42, # Output only. Number of hosts currently in use. If there is one or more Instances
2168 # running on the host, it is considered in use.
2169 &quot;inUseInstanceCount&quot;: 42, # Output only. Number of instances currently in use in this reservation.
2170 &quot;inUseResources&quot;: [ # Output only. [Output only] List of resources currently in use.
2171 {
2172 &quot;accelerator&quot;: { # Properties of accelerator resources in this reservation.
2173 &quot;acceleratorCount&quot;: 42, # Number of accelerators of specified type.
2174 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL to accelerator type. e.g.
2175 # &quot;projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l&quot;
2176 },
2177 },
2178 ],
2179 &quot;reservedResources&quot;: [ # List of reserved resources (CPUs, memory, accelerators).
2180 {
2181 &quot;accelerator&quot;: { # Properties of accelerator resources in this reservation.
2182 &quot;acceleratorCount&quot;: 42, # Number of accelerators of specified type.
2183 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL to accelerator type. e.g.
2184 # &quot;projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l&quot;
2185 },
2186 },
2187 ],
2188 &quot;vmFamily&quot;: &quot;A String&quot;, # The VM family that all instances scheduled against this reservation must
2189 # belong to.
2190 &quot;workloadType&quot;: &quot;A String&quot;, # The workload type of the instances that will target this reservation.
2191 },
2192 &quot;commitment&quot;: &quot;A String&quot;, # Output only. [Output Only] Full or partial URL to a parent commitment. This field
2193 # displays for reservations that are tied to a commitment.
2194 &quot;confidentialComputeType&quot;: &quot;A String&quot;,
2195 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
2196 # text format.
2197 &quot;deleteAfterDuration&quot;: { # A Duration represents a fixed-length span of time represented # Duration time relative to reservation creation when Compute Engine will
2198 # automatically delete this resource.
2199 # as a count of seconds and fractions of seconds at nanosecond
2200 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
2201 # or &quot;month&quot;. Range is approximately 10,000 years.
2202 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
2203 # Durations less than one second are represented with a 0
2204 # `seconds` field and a positive `nanos` field. Must be from 0
2205 # to 999,999,999 inclusive.
2206 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
2207 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
2208 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
2209 },
2210 &quot;deleteAtTime&quot;: &quot;A String&quot;, # Absolute time in future when the reservation will be
2211 # auto-deleted by Compute Engine. Timestamp is represented inRFC3339 text format.
2212 &quot;deploymentType&quot;: &quot;A String&quot;, # Specifies the deployment strategy for this reservation.
2213 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
2214 # create the resource.
2215 &quot;earlyAccessMaintenance&quot;: &quot;A String&quot;, # Indicates the early access maintenance for the reservation.
2216 # If this field is absent or set to NO_EARLY_ACCESS, the reservation is not
2217 # enrolled in early access maintenance and the standard notice applies.
2218 &quot;enableEmergentMaintenance&quot;: True or False, # Indicates whether Compute Engine allows unplanned maintenance for your VMs;
2219 # for example, to fix hardware errors.
2220 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
2221 # defined by the server.
2222 &quot;kind&quot;: &quot;compute#reservation&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#reservations for reservations.
2223 &quot;linkedCommitments&quot;: [ # Output only. [Output Only] Full or partial URL to parent commitments. This field
2224 # displays for reservations that are tied to multiple commitments.
2225 &quot;A String&quot;,
2226 ],
2227 &quot;name&quot;: &quot;A String&quot;, # The name of the resource, provided by the client when initially creating
2228 # the resource. The resource name must be 1-63 characters long, and comply
2229 # withRFC1035.
2230 # Specifically, the name must be 1-63 characters long and match the regular
2231 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
2232 # character must be a lowercase letter, and all following characters must be
2233 # a dash, lowercase letter, or digit, except the last character, which cannot
2234 # be a dash.
2235 &quot;params&quot;: { # Additional reservation params. # Input only. Additional params passed with the request, but not persisted
2236 # as part of resource payload.
2237 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the reservation. Tag keys and
2238 # values have the same definition as resource
2239 # manager tags. Keys and values can be either in numeric format,
2240 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
2241 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
2242 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
2243 # PATCH) when empty.
2244 &quot;a_key&quot;: &quot;A String&quot;,
2245 },
2246 },
2247 &quot;protectionTier&quot;: &quot;A String&quot;, # Protection tier for the workload which specifies the workload expectations
2248 # in the event of infrastructure failures at data center (e.g. power
2249 # and/or cooling failures).
2250 &quot;reservationMode&quot;: &quot;A String&quot;, # Output only. [Output only] Indicates the reservation mode of the reservation.
2251 &quot;reservationSharingPolicy&quot;: { # Specify the reservation sharing policy. If unspecified, the reservation
2252 # will not be shared with Google Cloud managed services.
2253 &quot;serviceShareType&quot;: &quot;A String&quot;, # Sharing config for all Google Cloud services.
2254 },
2255 &quot;resourcePolicies&quot;: { # Resource policies to be added to this reservation. The key is defined by
2256 # user, and the value is resource policy url. This is to define placement
2257 # policy with reservation.
2258 &quot;a_key&quot;: &quot;A String&quot;,
2259 },
2260 &quot;resourceStatus&quot;: { # [Output Only] Contains output only fields. # Output only. [Output Only] Status information for Reservation resource.
2261 &quot;healthInfo&quot;: { # Health information for the reservation. # [Output only] Health information for the reservation.
2262 &quot;degradedBlockCount&quot;: 42, # The number of reservation blocks that are degraded.
2263 &quot;healthStatus&quot;: &quot;A String&quot;, # The health status of the reservation.
2264 &quot;healthyBlockCount&quot;: 42, # The number of reservation blocks that are healthy.
2265 },
2266 &quot;reservationBlockCount&quot;: 42, # The number of reservation blocks associated with this reservation.
2267 &quot;reservationMaintenance&quot;: { # Maintenance Info for ReservationBlocks. # Maintenance information for this reservation
2268 &quot;instanceMaintenanceOngoingCount&quot;: 42, # Describes number of instances that have ongoing maintenance.
2269 &quot;instanceMaintenancePendingCount&quot;: 42, # Describes number of instances that have pending maintenance.
2270 &quot;maintenanceOngoingCount&quot;: 42, # Progress for ongoing maintenance for this group of VMs/hosts.
2271 # Describes number of hosts in the block that have ongoing maintenance.
2272 &quot;maintenancePendingCount&quot;: 42, # Progress for ongoing maintenance for this group of VMs/hosts.
2273 # Describes number of hosts in the block that have pending maintenance.
2274 &quot;schedulingType&quot;: &quot;A String&quot;, # The type of maintenance for the reservation.
2275 &quot;subblockInfraMaintenanceOngoingCount&quot;: 42, # Describes number of subblock Infrastructure that has ongoing maintenance.
2276 # Here, Subblock Infrastructure Maintenance pertains to upstream hardware
2277 # contained in the Subblock that is necessary for a VM Family(e.g. NVLink
2278 # Domains). Not all VM Families will support this field.
2279 &quot;subblockInfraMaintenancePendingCount&quot;: 42, # Describes number of subblock Infrastructure that has pending maintenance.
2280 # Here, Subblock Infrastructure Maintenance pertains to upstream hardware
2281 # contained in the Subblock that is necessary for a VM Family (e.g. NVLink
2282 # Domains). Not all VM Families will support this field.
2283 &quot;upcomingGroupMaintenance&quot;: { # Upcoming Maintenance notification information. # Maintenance information on this group of VMs.
2284 &quot;canReschedule&quot;: True or False, # Indicates if the maintenance can be customer triggered.
2285 &quot;latestWindowStartTime&quot;: &quot;A String&quot;, # The latest time for the planned maintenance window to start.
2286 # This timestamp value is in RFC3339 text format.
2287 &quot;maintenanceOnShutdown&quot;: True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown.
2288 &quot;maintenanceReasons&quot;: [ # The reasons for the maintenance. Only valid for vms.
2289 &quot;A String&quot;,
2290 ],
2291 &quot;maintenanceStatus&quot;: &quot;A String&quot;,
2292 &quot;type&quot;: &quot;A String&quot;, # Defines the type of maintenance.
2293 &quot;windowEndTime&quot;: &quot;A String&quot;, # The time by which the maintenance disruption will be completed.
2294 # This timestamp value is in RFC3339 text format.
2295 &quot;windowStartTime&quot;: &quot;A String&quot;, # The current start time of the maintenance window.
2296 # This timestamp value is in RFC3339 text format.
2297 },
2298 },
2299 &quot;specificSkuAllocation&quot;: { # Contains Properties set for the reservation. # Allocation Properties of this reservation.
2300 &quot;sourceInstanceTemplateId&quot;: &quot;A String&quot;, # ID of the instance template used to populate reservation properties.
2301 &quot;utilizations&quot;: { # Per service utilization breakdown. The Key is the Google Cloud managed
2302 # service name.
2303 &quot;a_key&quot;: &quot;A String&quot;,
2304 },
2305 },
2306 },
2307 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
2308 &quot;schedulingType&quot;: &quot;A String&quot;, # The type of maintenance for the reservation.
2309 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
2310 &quot;shareSettings&quot;: { # The share setting for reservations and sole tenancy node groups. # Specify share-settings to create a shared reservation. This property is
2311 # optional. For more information about the syntax and options for this
2312 # field and its subfields, see the guide for creating
2313 # a shared reservation.
2314 &quot;folderMap&quot;: { # A map of folder id and folder config to specify consumer projects for this
2315 # shared-reservation. This is only valid when share_type&#x27;s value is
2316 # DIRECT_PROJECTS_UNDER_SPECIFIC_FOLDERS.
2317 # Folder id should be a string of number, and without &quot;folders/&quot; prefix.
2318 &quot;a_key&quot;: { # Config for each folder in the share settings.
2319 &quot;folderId&quot;: &quot;A String&quot;, # The folder ID, should be same as the key of this folder config in the
2320 # parent map.
2321 # Folder id should be a string of number, and without &quot;folders/&quot; prefix.
2322 },
2323 },
2324 &quot;projectMap&quot;: { # A map of project id and project config. This is only valid when
2325 # share_type&#x27;s value is SPECIFIC_PROJECTS.
2326 &quot;a_key&quot;: { # Config for each project in the share settings.
2327 &quot;projectId&quot;: &quot;A String&quot;, # The project ID, should be same as the key of this project config in the
2328 # parent map.
2329 },
2330 },
2331 &quot;projects&quot;: [ # A List of Project names to specify consumer projects for this
2332 # shared-reservation. This is only valid when share_type&#x27;s value is
2333 # SPECIFIC_PROJECTS.
2334 &quot;A String&quot;,
2335 ],
2336 &quot;shareType&quot;: &quot;A String&quot;, # Type of sharing for this shared-reservation
2337 },
2338 &quot;specificReservation&quot;: { # This reservation type allows to pre allocate specific instance # Reservation for instances with specific machine shapes.
2339 # configuration.
2340 &quot;assuredCount&quot;: &quot;A String&quot;, # Output only. [Output Only] Indicates how many instances are actually usable currently.
2341 &quot;count&quot;: &quot;A String&quot;, # Specifies the number of resources that are allocated.
2342 &quot;inUseCount&quot;: &quot;A String&quot;, # Output only. [Output Only] Indicates how many instances are in use.
2343 &quot;instanceProperties&quot;: { # Properties of the SKU instances being reserved. # The instance properties for the reservation.
2344 # Next ID: 10
2345 &quot;guestAccelerators&quot;: [ # Specifies accelerator type and count.
2346 { # A specification of the type and number of accelerator cards attached to the
2347 # instance.
2348 &quot;acceleratorCount&quot;: 42, # The number of the guest accelerator cards exposed to this instance.
2349 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL of the accelerator type resource to attach to this
2350 # instance. For example:projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100
2351 # If you are creating an instance template, specify only the
2352 # accelerator name.
2353 # See GPUs on Compute Engine
2354 # for a full list of accelerator types.
2355 },
2356 ],
2357 &quot;localSsds&quot;: [ # Specifies amount of local ssd to reserve with each instance. The type
2358 # of disk is local-ssd.
2359 {
2360 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Specifies the size of the disk in base-2 GB.
2361 &quot;interface&quot;: &quot;A String&quot;, # Specifies the disk interface to use for attaching this disk, which is
2362 # either SCSI or NVME. The default isSCSI.
2363 # For performance characteristics of SCSI over NVMe, seeLocal SSD performance.
2364 },
2365 ],
2366 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the allocation close to other
2367 # resources.
2368 # This field is for use by internal tools that use the public API.
2369 &quot;machineType&quot;: &quot;A String&quot;, # Specifies type of machine (name only) which has fixed number of vCPUs
2370 # and fixed amount of memory. This also includes specifying custom
2371 # machine type following custom-NUMBER_OF_CPUS-AMOUNT_OF_MEMORY pattern.
2372 &quot;maintenanceFreezeDurationHours&quot;: 42, # Specifies the number of hours after reservation creation where
2373 # instances using the reservation won&#x27;t be scheduled for maintenance.
2374 &quot;maintenanceInterval&quot;: &quot;A String&quot;, # Specifies the frequency of planned maintenance events. The accepted
2375 # values are: `PERIODIC`.
2376 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Minimum cpu platform the reservation.
2377 },
2378 &quot;sourceInstanceTemplate&quot;: &quot;A String&quot;, # Specifies the instance template to create the reservation. If you use
2379 # this field, you must exclude the instanceProperties field.
2380 #
2381 # This field is optional, and it can be a full or partial URL. For example,
2382 # the following are all valid URLs to an instance template:
2383 #
2384 #
2385 # - https://www.googleapis.com/compute/v1/projects/project/global/instanceTemplates/instanceTemplate
2386 # - projects/project/global/instanceTemplates/instanceTemplate
2387 # - global/instanceTemplates/instanceTemplate
2388 },
2389 &quot;specificReservationRequired&quot;: True or False, # Indicates whether the reservation can be consumed by VMs with affinity
2390 # for &quot;any&quot; reservation. If the field is set, then only VMs that target
2391 # the reservation by name can consume from this reservation.
2392 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of the reservation.
2393 #
2394 #
2395 # - CREATING: Reservation resources are being
2396 # allocated.
2397 # - READY: Reservation resources have been allocated,
2398 # and the reservation is ready for use.
2399 # - DELETING: Reservation deletion is in progress.
2400 # - UPDATING: Reservation update is in progress.
2401 &quot;zone&quot;: &quot;A String&quot;, # Zone in which the reservation resides. A zone must be provided if the
2402 # reservation is created within a commitment.
2403 },
2404 ],
2405 &quot;kind&quot;: &quot;compute#reservationList&quot;, # Output only. [Output Only] Type of resource.Always compute#reservationsList
2406 # for listsof reservations
2407 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
2408 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
2409 # the query parameter pageToken in the next list request.
2410 # Subsequent list requests will have their own nextPageToken to
2411 # continue paging through the results.
2412 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
2413 &quot;warning&quot;: { # [Output Only] Informational warning message.
2414 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2415 # Engine returns NO_RESULTS_ON_PAGE if there
2416 # are no results in the response.
2417 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2418 # value format. For example:
2419 #
2420 # &quot;data&quot;: [
2421 # {
2422 # &quot;key&quot;: &quot;scope&quot;,
2423 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2424 # }
2425 {
2426 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2427 # returned. For example, for warnings where there are no results in a list
2428 # request for a particular zone, this key might be scope and
2429 # the key value might be the zone name. Other examples might be a key
2430 # indicating a deprecated resource and a suggested replacement, or a
2431 # warning about invalid network settings (for example, if an instance
2432 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2433 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2434 },
2435 ],
2436 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2437 },
2438 }</pre>
2439 </div>
2440
2441 <div class="method">
2442 <code class="details" id="list_next">list_next()</code>
2443 <pre>Retrieves the next page of results.
2444
2445 Args:
2446 previous_request: The request for the previous page. (required)
2447 previous_response: The response from the request for the previous page. (required)
2448
2449 Returns:
2450 A request object that you can call &#x27;execute()&#x27; on to request the next
2451 page. Returns None if there are no more items in the collection.
2452 </pre>
2453 </div>
2454
2455 <div class="method">
2456 <code class="details" id="performMaintenance">performMaintenance(project, zone, reservation, body=None, requestId=None, x__xgafv=None)</code>
2457 <pre>Perform maintenance on an extended reservation
2458
2459 Args:
2460 project: string, Project ID for this request. (required)
2461 zone: string, Name of the zone for this request. Zone name should conform to RFC1035. (required)
2462 reservation: string, The name of the reservation.
2463 Name should conform to RFC1035 or be a resource ID. (required)
2464 body: object, The request body.
2465 The object takes the form of:
2466
2467 {
2468 &quot;maintenanceScope&quot;: &quot;A String&quot;, # Specifies if all, running or unused hosts are in scope for this request.
2469 }
2470
2471 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
2472 that if you must retry your request, the server will know to ignore the
2473 request if it has already been completed.
2474
2475 For example, consider a situation where you make an initial request and
2476 the request times out. If you make the request again with the same
2477 request ID, the server can check if original operation with the same
2478 request ID was received, and if so, will ignore the second request. This
2479 prevents clients from accidentally creating duplicate commitments.
2480
2481 The request ID must be
2482 a valid UUID with the exception that zero UUID is not supported
2483 (00000000-0000-0000-0000-000000000000).
2484 x__xgafv: string, V1 error format.
2485 Allowed values
2486 1 - v1 error format
2487 2 - v2 error format
2488
2489 Returns:
2490 An object of the form:
2491
2492 { # Represents an Operation resource.
2493 #
2494 # Google Compute Engine has three Operation resources:
2495 #
2496 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
2497 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
2498 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
2499 #
2500 # You can use an operation resource to manage asynchronous API requests.
2501 # For more information, readHandling
2502 # API responses.
2503 #
2504 # Operations can be global, regional or zonal.
2505 #
2506 # - For global operations, use the `globalOperations`
2507 # resource.
2508 # - For regional operations, use the
2509 # `regionOperations` resource.
2510 # - For zonal operations, use
2511 # the `zoneOperations` resource.
2512 #
2513 #
2514 #
2515 # For more information, read
2516 # Global, Regional, and Zonal Resources.
2517 #
2518 # Note that completed Operation resources have a limited
2519 # retention period.
2520 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
2521 # Not present otherwise.
2522 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
2523 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
2524 # set when the operation is created.
2525 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
2526 # text format.
2527 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
2528 # this field will be populated.
2529 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
2530 # operation.
2531 {
2532 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
2533 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
2534 # details. There is a set of defined message types to use for providing
2535 # details.The syntax depends on the error code. For example,
2536 # QuotaExceededInfo will have details when the error code is
2537 # QUOTA_EXCEEDED.
2538 {
2539 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
2540 #
2541 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
2542 # is not enabled:
2543 #
2544 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
2545 # &quot;domain&quot;: &quot;googleapis.com&quot;
2546 # &quot;metadata&quot;: {
2547 # &quot;resource&quot;: &quot;projects/123&quot;,
2548 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
2549 # }
2550 # }
2551 #
2552 # This response indicates that the pubsub.googleapis.com API is not enabled.
2553 #
2554 # Example of an error that is returned when attempting to create a Spanner
2555 # instance in a region that is out of stock:
2556 #
2557 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
2558 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
2559 # &quot;metadata&quot;: {
2560 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
2561 # }
2562 # }
2563 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
2564 # is typically the registered service name of the tool or product that
2565 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
2566 # generated by some common infrastructure, the error domain must be a
2567 # globally unique value that identifies the infrastructure. For Google API
2568 # infrastructure, the error domain is &quot;googleapis.com&quot;.
2569 &quot;metadatas&quot;: { # Additional structured details about this error.
2570 #
2571 # Keys must match a regular expression of `a-z+` but should
2572 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
2573 # length. When identifying the current value of an exceeded limit, the units
2574 # should be contained in the key, not the value. For example, rather than
2575 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
2576 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
2577 # instances that can be created in a single (batch) request.
2578 &quot;a_key&quot;: &quot;A String&quot;,
2579 },
2580 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
2581 # proximate cause of the error. Error reasons are unique within a particular
2582 # domain of errors. This should be at most 63 characters and match a
2583 # regular expression of `A-Z+[A-Z0-9]`, which represents
2584 # UPPER_SNAKE_CASE.
2585 },
2586 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
2587 #
2588 # For example, if a quota check failed with an error indicating the calling
2589 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
2590 # directly to the right place in the developer console to flip the bit.
2591 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
2592 { # Describes a URL link.
2593 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
2594 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
2595 },
2596 ],
2597 },
2598 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
2599 # which can be attached to an RPC error.
2600 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
2601 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
2602 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
2603 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
2604 },
2605 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
2606 &quot;dimensions&quot;: { # The map holding related quota dimensions.
2607 &quot;a_key&quot;: &quot;A String&quot;,
2608 },
2609 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
2610 # type or metric.
2611 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
2612 # or metric.
2613 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
2614 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
2615 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
2616 },
2617 },
2618 ],
2619 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
2620 # This property is optional.
2621 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
2622 },
2623 ],
2624 },
2625 &quot;getVersionOperationMetadata&quot;: {
2626 &quot;inlineSbomInfo&quot;: {
2627 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
2628 # appropriate identifiers.
2629 &quot;a_key&quot;: &quot;A String&quot;,
2630 },
2631 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
2632 # identifiers.
2633 &quot;a_key&quot;: &quot;A String&quot;,
2634 },
2635 },
2636 },
2637 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
2638 # message that was returned, such as `NOT FOUND`.
2639 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
2640 # status code that was returned. For example, a `404` means the
2641 # resource was not found.
2642 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
2643 # defined by the server.
2644 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
2645 # This value is inRFC3339
2646 # text format.
2647 &quot;instancesBulkInsertOperationMetadata&quot;: {
2648 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
2649 # Example key: zones/us-central1-a
2650 &quot;a_key&quot;: {
2651 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
2652 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
2653 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
2654 # error.
2655 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
2656 # if the flow is rolling forward or rolling back.
2657 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
2658 },
2659 },
2660 },
2661 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
2662 # Operation resources.
2663 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
2664 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
2665 # group of operations results from a `bulkInsert` API request.
2666 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
2667 # `update`, or `delete`, and so on.
2668 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
2669 # There is no requirement that this be linear or support any granularity of
2670 # operations. This should not be used to guess when the operation will be
2671 # complete. This number should monotonically increase as the operation
2672 # progresses.
2673 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
2674 # applicable when performing regional operations.
2675 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2676 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
2677 # this field will contain information on all underlying zonal actions and
2678 # their state.
2679 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
2680 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
2681 # Example key: zones/us-central1-a
2682 &quot;a_key&quot;: {
2683 &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
2684 # populated.
2685 # different programming environments, including REST APIs and RPC APIs. It is
2686 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
2687 # three pieces of data: error code, error message, and error details.
2688 #
2689 # You can find out more about this error model and how to work with it in the
2690 # [API Design Guide](https://cloud.google.com/apis/design/errors).
2691 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
2692 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
2693 # message types for APIs to use.
2694 {
2695 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
2696 },
2697 ],
2698 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
2699 # user-facing error message should be localized and sent in the
2700 # google.rpc.Status.details field, or localized by the client.
2701 },
2702 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
2703 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
2704 },
2705 },
2706 },
2707 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
2708 # This value is inRFC3339
2709 # text format.
2710 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
2711 # following:
2712 # `PENDING`, `RUNNING`, or `DONE`.
2713 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
2714 # operation.
2715 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
2716 # of the target resource.
2717 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
2718 # operations related to creating a snapshot, this points to the disk
2719 # that the snapshot was created from.
2720 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
2721 # `[email protected]` or
2722 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
2723 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
2724 # operation, this field will be populated.
2725 {
2726 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2727 # Engine returns NO_RESULTS_ON_PAGE if there
2728 # are no results in the response.
2729 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2730 # value format. For example:
2731 #
2732 # &quot;data&quot;: [
2733 # {
2734 # &quot;key&quot;: &quot;scope&quot;,
2735 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2736 # }
2737 {
2738 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2739 # returned. For example, for warnings where there are no results in a list
2740 # request for a particular zone, this key might be scope and
2741 # the key value might be the zone name. Other examples might be a key
2742 # indicating a deprecated resource and a suggested replacement, or a
2743 # warning about invalid network settings (for example, if an instance
2744 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2745 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2746 },
2747 ],
2748 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2749 },
2750 ],
2751 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
2752 # applicable when performing per-zone operations.
2753 }</pre>
2754 </div>
2755
2756 <div class="method">
2757 <code class="details" id="resize">resize(project, zone, reservation, body=None, requestId=None, x__xgafv=None)</code>
2758 <pre>Resizes the reservation (applicable to standalone reservations only). For
2759 more information, readModifying
2760 reservations.
2761
2762 Args:
2763 project: string, Project ID for this request. (required)
2764 zone: string, Name of the zone for this request. (required)
2765 reservation: string, Name of the reservation to update. (required)
2766 body: object, The request body.
2767 The object takes the form of:
2768
2769 {
2770 &quot;specificSkuCount&quot;: &quot;A String&quot;, # Number of allocated resources can be resized with minimum = 1 and
2771 # maximum = 1000.
2772 }
2773
2774 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
2775 that if you must retry your request, the server will know to ignore the
2776 request if it has already been completed.
2777
2778 For example, consider a situation where you make an initial request and
2779 the request times out. If you make the request again with the same
2780 request ID, the server can check if original operation with the same
2781 request ID was received, and if so, will ignore the second request. This
2782 prevents clients from accidentally creating duplicate commitments.
2783
2784 The request ID must be
2785 a valid UUID with the exception that zero UUID is not supported
2786 (00000000-0000-0000-0000-000000000000).
2787 x__xgafv: string, V1 error format.
2788 Allowed values
2789 1 - v1 error format
2790 2 - v2 error format
2791
2792 Returns:
2793 An object of the form:
2794
2795 { # Represents an Operation resource.
2796 #
2797 # Google Compute Engine has three Operation resources:
2798 #
2799 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
2800 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
2801 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
2802 #
2803 # You can use an operation resource to manage asynchronous API requests.
2804 # For more information, readHandling
2805 # API responses.
2806 #
2807 # Operations can be global, regional or zonal.
2808 #
2809 # - For global operations, use the `globalOperations`
2810 # resource.
2811 # - For regional operations, use the
2812 # `regionOperations` resource.
2813 # - For zonal operations, use
2814 # the `zoneOperations` resource.
2815 #
2816 #
2817 #
2818 # For more information, read
2819 # Global, Regional, and Zonal Resources.
2820 #
2821 # Note that completed Operation resources have a limited
2822 # retention period.
2823 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
2824 # Not present otherwise.
2825 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
2826 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
2827 # set when the operation is created.
2828 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
2829 # text format.
2830 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
2831 # this field will be populated.
2832 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
2833 # operation.
2834 {
2835 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
2836 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
2837 # details. There is a set of defined message types to use for providing
2838 # details.The syntax depends on the error code. For example,
2839 # QuotaExceededInfo will have details when the error code is
2840 # QUOTA_EXCEEDED.
2841 {
2842 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
2843 #
2844 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
2845 # is not enabled:
2846 #
2847 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
2848 # &quot;domain&quot;: &quot;googleapis.com&quot;
2849 # &quot;metadata&quot;: {
2850 # &quot;resource&quot;: &quot;projects/123&quot;,
2851 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
2852 # }
2853 # }
2854 #
2855 # This response indicates that the pubsub.googleapis.com API is not enabled.
2856 #
2857 # Example of an error that is returned when attempting to create a Spanner
2858 # instance in a region that is out of stock:
2859 #
2860 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
2861 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
2862 # &quot;metadata&quot;: {
2863 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
2864 # }
2865 # }
2866 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
2867 # is typically the registered service name of the tool or product that
2868 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
2869 # generated by some common infrastructure, the error domain must be a
2870 # globally unique value that identifies the infrastructure. For Google API
2871 # infrastructure, the error domain is &quot;googleapis.com&quot;.
2872 &quot;metadatas&quot;: { # Additional structured details about this error.
2873 #
2874 # Keys must match a regular expression of `a-z+` but should
2875 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
2876 # length. When identifying the current value of an exceeded limit, the units
2877 # should be contained in the key, not the value. For example, rather than
2878 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
2879 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
2880 # instances that can be created in a single (batch) request.
2881 &quot;a_key&quot;: &quot;A String&quot;,
2882 },
2883 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
2884 # proximate cause of the error. Error reasons are unique within a particular
2885 # domain of errors. This should be at most 63 characters and match a
2886 # regular expression of `A-Z+[A-Z0-9]`, which represents
2887 # UPPER_SNAKE_CASE.
2888 },
2889 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
2890 #
2891 # For example, if a quota check failed with an error indicating the calling
2892 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
2893 # directly to the right place in the developer console to flip the bit.
2894 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
2895 { # Describes a URL link.
2896 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
2897 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
2898 },
2899 ],
2900 },
2901 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
2902 # which can be attached to an RPC error.
2903 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
2904 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
2905 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
2906 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
2907 },
2908 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
2909 &quot;dimensions&quot;: { # The map holding related quota dimensions.
2910 &quot;a_key&quot;: &quot;A String&quot;,
2911 },
2912 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
2913 # type or metric.
2914 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
2915 # or metric.
2916 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
2917 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
2918 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
2919 },
2920 },
2921 ],
2922 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
2923 # This property is optional.
2924 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
2925 },
2926 ],
2927 },
2928 &quot;getVersionOperationMetadata&quot;: {
2929 &quot;inlineSbomInfo&quot;: {
2930 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
2931 # appropriate identifiers.
2932 &quot;a_key&quot;: &quot;A String&quot;,
2933 },
2934 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
2935 # identifiers.
2936 &quot;a_key&quot;: &quot;A String&quot;,
2937 },
2938 },
2939 },
2940 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
2941 # message that was returned, such as `NOT FOUND`.
2942 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
2943 # status code that was returned. For example, a `404` means the
2944 # resource was not found.
2945 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
2946 # defined by the server.
2947 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
2948 # This value is inRFC3339
2949 # text format.
2950 &quot;instancesBulkInsertOperationMetadata&quot;: {
2951 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
2952 # Example key: zones/us-central1-a
2953 &quot;a_key&quot;: {
2954 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
2955 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
2956 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
2957 # error.
2958 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
2959 # if the flow is rolling forward or rolling back.
2960 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
2961 },
2962 },
2963 },
2964 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
2965 # Operation resources.
2966 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
2967 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
2968 # group of operations results from a `bulkInsert` API request.
2969 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
2970 # `update`, or `delete`, and so on.
2971 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
2972 # There is no requirement that this be linear or support any granularity of
2973 # operations. This should not be used to guess when the operation will be
2974 # complete. This number should monotonically increase as the operation
2975 # progresses.
2976 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
2977 # applicable when performing regional operations.
2978 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2979 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
2980 # this field will contain information on all underlying zonal actions and
2981 # their state.
2982 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
2983 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
2984 # Example key: zones/us-central1-a
2985 &quot;a_key&quot;: {
2986 &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
2987 # populated.
2988 # different programming environments, including REST APIs and RPC APIs. It is
2989 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
2990 # three pieces of data: error code, error message, and error details.
2991 #
2992 # You can find out more about this error model and how to work with it in the
2993 # [API Design Guide](https://cloud.google.com/apis/design/errors).
2994 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
2995 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
2996 # message types for APIs to use.
2997 {
2998 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
2999 },
3000 ],
3001 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
3002 # user-facing error message should be localized and sent in the
3003 # google.rpc.Status.details field, or localized by the client.
3004 },
3005 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
3006 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
3007 },
3008 },
3009 },
3010 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
3011 # This value is inRFC3339
3012 # text format.
3013 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
3014 # following:
3015 # `PENDING`, `RUNNING`, or `DONE`.
3016 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
3017 # operation.
3018 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
3019 # of the target resource.
3020 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
3021 # operations related to creating a snapshot, this points to the disk
3022 # that the snapshot was created from.
3023 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
3024 # `[email protected]` or
3025 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
3026 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
3027 # operation, this field will be populated.
3028 {
3029 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
3030 # Engine returns NO_RESULTS_ON_PAGE if there
3031 # are no results in the response.
3032 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
3033 # value format. For example:
3034 #
3035 # &quot;data&quot;: [
3036 # {
3037 # &quot;key&quot;: &quot;scope&quot;,
3038 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
3039 # }
3040 {
3041 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
3042 # returned. For example, for warnings where there are no results in a list
3043 # request for a particular zone, this key might be scope and
3044 # the key value might be the zone name. Other examples might be a key
3045 # indicating a deprecated resource and a suggested replacement, or a
3046 # warning about invalid network settings (for example, if an instance
3047 # attempts to perform IP forwarding but is not enabled for IP forwarding).
3048 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
3049 },
3050 ],
3051 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
3052 },
3053 ],
3054 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
3055 # applicable when performing per-zone operations.
3056 }</pre>
3057 </div>
3058
3059 <div class="method">
3060 <code class="details" id="setIamPolicy">setIamPolicy(project, zone, resource, body=None, x__xgafv=None)</code>
3061 <pre>Sets the access control policy on the specified resource.
3062 Replaces any existing policy.
3063
3064 Args:
3065 project: string, Project ID for this request. (required)
3066 zone: string, The name of the zone for this request. (required)
3067 resource: string, Name or id of the resource for this request. (required)
3068 body: object, The request body.
3069 The object takes the form of:
3070
3071 {
3072 &quot;bindings&quot;: [ # Flatten Policy to create a backwacd compatible wire-format.
3073 # Deprecated. Use &#x27;policy&#x27; to specify bindings.
3074 { # Associates `members`, or principals, with a `role`.
3075 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
3076 #
3077 # If the condition evaluates to `true`, then this binding applies to the
3078 # current request.
3079 #
3080 # If the condition evaluates to `false`, then this binding does not apply to
3081 # the current request. However, a different role binding might grant the same
3082 # role to one or more of the principals in this binding.
3083 #
3084 # To learn which resources support conditions in their IAM policies, see the
3085 # [IAM
3086 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3087 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
3088 # are documented at https://github.com/google/cel-spec.
3089 #
3090 # Example (Comparison):
3091 #
3092 # title: &quot;Summary size limit&quot;
3093 # description: &quot;Determines if a summary is less than 100 chars&quot;
3094 # expression: &quot;document.summary.size() &lt; 100&quot;
3095 #
3096 # Example (Equality):
3097 #
3098 # title: &quot;Requestor is owner&quot;
3099 # description: &quot;Determines if requestor is the document owner&quot;
3100 # expression: &quot;document.owner == request.auth.claims.email&quot;
3101 #
3102 # Example (Logic):
3103 #
3104 # title: &quot;Public documents&quot;
3105 # description: &quot;Determine whether the document should be publicly visible&quot;
3106 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
3107 #
3108 # Example (Data Manipulation):
3109 #
3110 # title: &quot;Notification string&quot;
3111 # description: &quot;Create a notification string with a timestamp.&quot;
3112 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
3113 #
3114 # The exact variables and functions that may be referenced within an expression
3115 # are determined by the service that evaluates it. See the service
3116 # documentation for additional information.
3117 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
3118 # describes the expression, e.g. when hovered over it in a UI.
3119 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
3120 # syntax.
3121 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
3122 # reporting, e.g. a file name and a position in the file.
3123 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
3124 # its purpose. This can be used e.g. in UIs which allow to enter the
3125 # expression.
3126 },
3127 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
3128 # `members` can have the following values:
3129 #
3130 # * `allUsers`: A special identifier that represents anyone who is
3131 # on the internet; with or without a Google account.
3132 #
3133 # * `allAuthenticatedUsers`: A special identifier that represents anyone
3134 # who is authenticated with a Google account or a service account.
3135 # Does not include identities that come from external identity providers
3136 # (IdPs) through identity federation.
3137 #
3138 # * `user:{emailid}`: An email address that represents a specific Google
3139 # account. For example, `[email protected]` .
3140 #
3141 #
3142 # * `serviceAccount:{emailid}`: An email address that represents a Google
3143 # service account. For example,
3144 # `[email protected]`.
3145 #
3146 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
3147 # identifier for a
3148 # [Kubernetes service
3149 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
3150 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
3151 #
3152 # * `group:{emailid}`: An email address that represents a Google group.
3153 # For example, `[email protected]`.
3154 #
3155 #
3156 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
3157 # users of that domain. For example, `google.com` or `example.com`.
3158 #
3159 #
3160 #
3161 #
3162 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
3163 # A single identity in a workforce identity pool.
3164 #
3165 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
3166 # All workforce identities in a group.
3167 #
3168 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
3169 # All workforce identities with a specific attribute value.
3170 #
3171 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
3172 # All identities in a workforce identity pool.
3173 #
3174 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
3175 # A single identity in a workload identity pool.
3176 #
3177 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
3178 # A workload identity pool group.
3179 #
3180 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
3181 # All identities in a workload identity pool with a certain attribute.
3182 #
3183 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
3184 # All identities in a workload identity pool.
3185 #
3186 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
3187 # identifier) representing a user that has been recently deleted. For
3188 # example, `[email protected]?uid=123456789012345678901`. If the user is
3189 # recovered, this value reverts to `user:{emailid}` and the recovered user
3190 # retains the role in the binding.
3191 #
3192 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
3193 # unique identifier) representing a service account that has been recently
3194 # deleted. For example,
3195 # `[email protected]?uid=123456789012345678901`.
3196 # If the service account is undeleted, this value reverts to
3197 # `serviceAccount:{emailid}` and the undeleted service account retains the
3198 # role in the binding.
3199 #
3200 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
3201 # identifier) representing a Google group that has been recently
3202 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
3203 # the group is recovered, this value reverts to `group:{emailid}` and the
3204 # recovered group retains the role in the binding.
3205 #
3206 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
3207 # Deleted single identity in a workforce identity pool. For example,
3208 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
3209 &quot;A String&quot;,
3210 ],
3211 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
3212 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
3213 #
3214 # For an overview of the IAM roles and permissions, see the
3215 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
3216 # a list of the available pre-defined roles, see
3217 # [here](https://cloud.google.com/iam/docs/understanding-roles).
3218 },
3219 ],
3220 &quot;etag&quot;: &quot;A String&quot;, # Flatten Policy to create a backward compatible wire-format.
3221 # Deprecated. Use &#x27;policy&#x27; to specify the etag.
3222 &quot;policy&quot;: { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the &#x27;resource&#x27;. The size of
3223 # the policy is limited to a few 10s of KB. An empty policy is in general a
3224 # valid policy but certain services (like Projects) might reject them.
3225 # controls for Google Cloud resources.
3226 #
3227 #
3228 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
3229 # `members`, or principals, to a single `role`. Principals can be user
3230 # accounts, service accounts, Google groups, and domains (such as G Suite). A
3231 # `role` is a named list of permissions; each `role` can be an IAM predefined
3232 # role or a user-created custom role.
3233 #
3234 # For some types of Google Cloud resources, a `binding` can also specify a
3235 # `condition`, which is a logical expression that allows access to a resource
3236 # only if the expression evaluates to `true`. A condition can add constraints
3237 # based on attributes of the request, the resource, or both. To learn which
3238 # resources support conditions in their IAM policies, see the
3239 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3240 #
3241 # **JSON example:**
3242 #
3243 # ```
3244 # {
3245 # &quot;bindings&quot;: [
3246 # {
3247 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
3248 # &quot;members&quot;: [
3249 # &quot;user:[email protected]&quot;,
3250 # &quot;group:[email protected]&quot;,
3251 # &quot;domain:google.com&quot;,
3252 # &quot;serviceAccount:[email protected]&quot;
3253 # ]
3254 # },
3255 # {
3256 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
3257 # &quot;members&quot;: [
3258 # &quot;user:[email protected]&quot;
3259 # ],
3260 # &quot;condition&quot;: {
3261 # &quot;title&quot;: &quot;expirable access&quot;,
3262 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
3263 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
3264 # }
3265 # }
3266 # ],
3267 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
3268 # &quot;version&quot;: 3
3269 # }
3270 # ```
3271 #
3272 # **YAML example:**
3273 #
3274 # ```
3275 # bindings:
3276 # - members:
3277 # - user:[email protected]
3278 # - group:[email protected]
3279 # - domain:google.com
3280 # - serviceAccount:[email protected]
3281 # role: roles/resourcemanager.organizationAdmin
3282 # - members:
3283 # - user:[email protected]
3284 # role: roles/resourcemanager.organizationViewer
3285 # condition:
3286 # title: expirable access
3287 # description: Does not grant access after Sep 2020
3288 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
3289 # etag: BwWWja0YfJA=
3290 # version: 3
3291 # ```
3292 #
3293 # For a description of IAM and its features, see the
3294 # [IAM documentation](https://cloud.google.com/iam/docs/).
3295 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
3296 { # Specifies the audit configuration for a service.
3297 # The configuration determines which permission types are logged, and what
3298 # identities, if any, are exempted from logging.
3299 # An AuditConfig must have one or more AuditLogConfigs.
3300 #
3301 # If there are AuditConfigs for both `allServices` and a specific service,
3302 # the union of the two AuditConfigs is used for that service: the log_types
3303 # specified in each AuditConfig are enabled, and the exempted_members in each
3304 # AuditLogConfig are exempted.
3305 #
3306 # Example Policy with multiple AuditConfigs:
3307 #
3308 # {
3309 # &quot;audit_configs&quot;: [
3310 # {
3311 # &quot;service&quot;: &quot;allServices&quot;,
3312 # &quot;audit_log_configs&quot;: [
3313 # {
3314 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
3315 # &quot;exempted_members&quot;: [
3316 # &quot;user:[email protected]&quot;
3317 # ]
3318 # },
3319 # {
3320 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
3321 # },
3322 # {
3323 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
3324 # }
3325 # ]
3326 # },
3327 # {
3328 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
3329 # &quot;audit_log_configs&quot;: [
3330 # {
3331 # &quot;log_type&quot;: &quot;DATA_READ&quot;
3332 # },
3333 # {
3334 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
3335 # &quot;exempted_members&quot;: [
3336 # &quot;user:[email protected]&quot;
3337 # ]
3338 # }
3339 # ]
3340 # }
3341 # ]
3342 # }
3343 #
3344 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
3345 # logging. It also exempts `[email protected]` from DATA_READ logging, and
3346 # `[email protected]` from DATA_WRITE logging.
3347 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
3348 { # Provides the configuration for logging a type of permissions.
3349 # Example:
3350 #
3351 # {
3352 # &quot;audit_log_configs&quot;: [
3353 # {
3354 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
3355 # &quot;exempted_members&quot;: [
3356 # &quot;user:[email protected]&quot;
3357 # ]
3358 # },
3359 # {
3360 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
3361 # }
3362 # ]
3363 # }
3364 #
3365 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
3366 # [email protected] from DATA_READ logging.
3367 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
3368 # permission.
3369 # Follows the same format of Binding.members.
3370 &quot;A String&quot;,
3371 ],
3372 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
3373 },
3374 ],
3375 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
3376 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
3377 # `allServices` is a special value that covers all services.
3378 },
3379 ],
3380 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
3381 # may specify a `condition` that determines how and when the `bindings` are
3382 # applied. Each of the `bindings` must contain at least one principal.
3383 #
3384 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
3385 # of these principals can be Google groups. Each occurrence of a principal
3386 # counts towards these limits. For example, if the `bindings` grant 50
3387 # different roles to `user:[email protected]`, and not to any other
3388 # principal, then you can add another 1,450 principals to the `bindings` in
3389 # the `Policy`.
3390 { # Associates `members`, or principals, with a `role`.
3391 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
3392 #
3393 # If the condition evaluates to `true`, then this binding applies to the
3394 # current request.
3395 #
3396 # If the condition evaluates to `false`, then this binding does not apply to
3397 # the current request. However, a different role binding might grant the same
3398 # role to one or more of the principals in this binding.
3399 #
3400 # To learn which resources support conditions in their IAM policies, see the
3401 # [IAM
3402 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3403 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
3404 # are documented at https://github.com/google/cel-spec.
3405 #
3406 # Example (Comparison):
3407 #
3408 # title: &quot;Summary size limit&quot;
3409 # description: &quot;Determines if a summary is less than 100 chars&quot;
3410 # expression: &quot;document.summary.size() &lt; 100&quot;
3411 #
3412 # Example (Equality):
3413 #
3414 # title: &quot;Requestor is owner&quot;
3415 # description: &quot;Determines if requestor is the document owner&quot;
3416 # expression: &quot;document.owner == request.auth.claims.email&quot;
3417 #
3418 # Example (Logic):
3419 #
3420 # title: &quot;Public documents&quot;
3421 # description: &quot;Determine whether the document should be publicly visible&quot;
3422 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
3423 #
3424 # Example (Data Manipulation):
3425 #
3426 # title: &quot;Notification string&quot;
3427 # description: &quot;Create a notification string with a timestamp.&quot;
3428 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
3429 #
3430 # The exact variables and functions that may be referenced within an expression
3431 # are determined by the service that evaluates it. See the service
3432 # documentation for additional information.
3433 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
3434 # describes the expression, e.g. when hovered over it in a UI.
3435 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
3436 # syntax.
3437 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
3438 # reporting, e.g. a file name and a position in the file.
3439 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
3440 # its purpose. This can be used e.g. in UIs which allow to enter the
3441 # expression.
3442 },
3443 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
3444 # `members` can have the following values:
3445 #
3446 # * `allUsers`: A special identifier that represents anyone who is
3447 # on the internet; with or without a Google account.
3448 #
3449 # * `allAuthenticatedUsers`: A special identifier that represents anyone
3450 # who is authenticated with a Google account or a service account.
3451 # Does not include identities that come from external identity providers
3452 # (IdPs) through identity federation.
3453 #
3454 # * `user:{emailid}`: An email address that represents a specific Google
3455 # account. For example, `[email protected]` .
3456 #
3457 #
3458 # * `serviceAccount:{emailid}`: An email address that represents a Google
3459 # service account. For example,
3460 # `[email protected]`.
3461 #
3462 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
3463 # identifier for a
3464 # [Kubernetes service
3465 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
3466 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
3467 #
3468 # * `group:{emailid}`: An email address that represents a Google group.
3469 # For example, `[email protected]`.
3470 #
3471 #
3472 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
3473 # users of that domain. For example, `google.com` or `example.com`.
3474 #
3475 #
3476 #
3477 #
3478 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
3479 # A single identity in a workforce identity pool.
3480 #
3481 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
3482 # All workforce identities in a group.
3483 #
3484 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
3485 # All workforce identities with a specific attribute value.
3486 #
3487 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
3488 # All identities in a workforce identity pool.
3489 #
3490 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
3491 # A single identity in a workload identity pool.
3492 #
3493 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
3494 # A workload identity pool group.
3495 #
3496 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
3497 # All identities in a workload identity pool with a certain attribute.
3498 #
3499 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
3500 # All identities in a workload identity pool.
3501 #
3502 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
3503 # identifier) representing a user that has been recently deleted. For
3504 # example, `[email protected]?uid=123456789012345678901`. If the user is
3505 # recovered, this value reverts to `user:{emailid}` and the recovered user
3506 # retains the role in the binding.
3507 #
3508 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
3509 # unique identifier) representing a service account that has been recently
3510 # deleted. For example,
3511 # `[email protected]?uid=123456789012345678901`.
3512 # If the service account is undeleted, this value reverts to
3513 # `serviceAccount:{emailid}` and the undeleted service account retains the
3514 # role in the binding.
3515 #
3516 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
3517 # identifier) representing a Google group that has been recently
3518 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
3519 # the group is recovered, this value reverts to `group:{emailid}` and the
3520 # recovered group retains the role in the binding.
3521 #
3522 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
3523 # Deleted single identity in a workforce identity pool. For example,
3524 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
3525 &quot;A String&quot;,
3526 ],
3527 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
3528 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
3529 #
3530 # For an overview of the IAM roles and permissions, see the
3531 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
3532 # a list of the available pre-defined roles, see
3533 # [here](https://cloud.google.com/iam/docs/understanding-roles).
3534 },
3535 ],
3536 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
3537 # prevent simultaneous updates of a policy from overwriting each other.
3538 # It is strongly suggested that systems make use of the `etag` in the
3539 # read-modify-write cycle to perform policy updates in order to avoid race
3540 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
3541 # systems are expected to put that etag in the request to `setIamPolicy` to
3542 # ensure that their change will be applied to the same version of the policy.
3543 #
3544 # **Important:** If you use IAM Conditions, you must include the `etag` field
3545 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
3546 # you to overwrite a version `3` policy with a version `1` policy, and all of
3547 # the conditions in the version `3` policy are lost.
3548 &quot;version&quot;: 42, # Specifies the format of the policy.
3549 #
3550 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
3551 # are rejected.
3552 #
3553 # Any operation that affects conditional role bindings must specify version
3554 # `3`. This requirement applies to the following operations:
3555 #
3556 # * Getting a policy that includes a conditional role binding
3557 # * Adding a conditional role binding to a policy
3558 # * Changing a conditional role binding in a policy
3559 # * Removing any role binding, with or without a condition, from a policy
3560 # that includes conditions
3561 #
3562 # **Important:** If you use IAM Conditions, you must include the `etag` field
3563 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
3564 # you to overwrite a version `3` policy with a version `1` policy, and all of
3565 # the conditions in the version `3` policy are lost.
3566 #
3567 # If a policy does not include any conditions, operations on that policy may
3568 # specify any valid version or leave the field unset.
3569 #
3570 # To learn which resources support conditions in their IAM policies, see the
3571 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3572 },
3573 }
3574
3575 x__xgafv: string, V1 error format.
3576 Allowed values
3577 1 - v1 error format
3578 2 - v2 error format
3579
3580 Returns:
3581 An object of the form:
3582
3583 { # An Identity and Access Management (IAM) policy, which specifies access
3584 # controls for Google Cloud resources.
3585 #
3586 #
3587 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
3588 # `members`, or principals, to a single `role`. Principals can be user
3589 # accounts, service accounts, Google groups, and domains (such as G Suite). A
3590 # `role` is a named list of permissions; each `role` can be an IAM predefined
3591 # role or a user-created custom role.
3592 #
3593 # For some types of Google Cloud resources, a `binding` can also specify a
3594 # `condition`, which is a logical expression that allows access to a resource
3595 # only if the expression evaluates to `true`. A condition can add constraints
3596 # based on attributes of the request, the resource, or both. To learn which
3597 # resources support conditions in their IAM policies, see the
3598 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3599 #
3600 # **JSON example:**
3601 #
3602 # ```
3603 # {
3604 # &quot;bindings&quot;: [
3605 # {
3606 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
3607 # &quot;members&quot;: [
3608 # &quot;user:[email protected]&quot;,
3609 # &quot;group:[email protected]&quot;,
3610 # &quot;domain:google.com&quot;,
3611 # &quot;serviceAccount:[email protected]&quot;
3612 # ]
3613 # },
3614 # {
3615 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
3616 # &quot;members&quot;: [
3617 # &quot;user:[email protected]&quot;
3618 # ],
3619 # &quot;condition&quot;: {
3620 # &quot;title&quot;: &quot;expirable access&quot;,
3621 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
3622 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
3623 # }
3624 # }
3625 # ],
3626 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
3627 # &quot;version&quot;: 3
3628 # }
3629 # ```
3630 #
3631 # **YAML example:**
3632 #
3633 # ```
3634 # bindings:
3635 # - members:
3636 # - user:[email protected]
3637 # - group:[email protected]
3638 # - domain:google.com
3639 # - serviceAccount:[email protected]
3640 # role: roles/resourcemanager.organizationAdmin
3641 # - members:
3642 # - user:[email protected]
3643 # role: roles/resourcemanager.organizationViewer
3644 # condition:
3645 # title: expirable access
3646 # description: Does not grant access after Sep 2020
3647 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
3648 # etag: BwWWja0YfJA=
3649 # version: 3
3650 # ```
3651 #
3652 # For a description of IAM and its features, see the
3653 # [IAM documentation](https://cloud.google.com/iam/docs/).
3654 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
3655 { # Specifies the audit configuration for a service.
3656 # The configuration determines which permission types are logged, and what
3657 # identities, if any, are exempted from logging.
3658 # An AuditConfig must have one or more AuditLogConfigs.
3659 #
3660 # If there are AuditConfigs for both `allServices` and a specific service,
3661 # the union of the two AuditConfigs is used for that service: the log_types
3662 # specified in each AuditConfig are enabled, and the exempted_members in each
3663 # AuditLogConfig are exempted.
3664 #
3665 # Example Policy with multiple AuditConfigs:
3666 #
3667 # {
3668 # &quot;audit_configs&quot;: [
3669 # {
3670 # &quot;service&quot;: &quot;allServices&quot;,
3671 # &quot;audit_log_configs&quot;: [
3672 # {
3673 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
3674 # &quot;exempted_members&quot;: [
3675 # &quot;user:[email protected]&quot;
3676 # ]
3677 # },
3678 # {
3679 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
3680 # },
3681 # {
3682 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
3683 # }
3684 # ]
3685 # },
3686 # {
3687 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
3688 # &quot;audit_log_configs&quot;: [
3689 # {
3690 # &quot;log_type&quot;: &quot;DATA_READ&quot;
3691 # },
3692 # {
3693 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
3694 # &quot;exempted_members&quot;: [
3695 # &quot;user:[email protected]&quot;
3696 # ]
3697 # }
3698 # ]
3699 # }
3700 # ]
3701 # }
3702 #
3703 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
3704 # logging. It also exempts `[email protected]` from DATA_READ logging, and
3705 # `[email protected]` from DATA_WRITE logging.
3706 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
3707 { # Provides the configuration for logging a type of permissions.
3708 # Example:
3709 #
3710 # {
3711 # &quot;audit_log_configs&quot;: [
3712 # {
3713 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
3714 # &quot;exempted_members&quot;: [
3715 # &quot;user:[email protected]&quot;
3716 # ]
3717 # },
3718 # {
3719 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
3720 # }
3721 # ]
3722 # }
3723 #
3724 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
3725 # [email protected] from DATA_READ logging.
3726 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
3727 # permission.
3728 # Follows the same format of Binding.members.
3729 &quot;A String&quot;,
3730 ],
3731 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
3732 },
3733 ],
3734 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
3735 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
3736 # `allServices` is a special value that covers all services.
3737 },
3738 ],
3739 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
3740 # may specify a `condition` that determines how and when the `bindings` are
3741 # applied. Each of the `bindings` must contain at least one principal.
3742 #
3743 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
3744 # of these principals can be Google groups. Each occurrence of a principal
3745 # counts towards these limits. For example, if the `bindings` grant 50
3746 # different roles to `user:[email protected]`, and not to any other
3747 # principal, then you can add another 1,450 principals to the `bindings` in
3748 # the `Policy`.
3749 { # Associates `members`, or principals, with a `role`.
3750 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
3751 #
3752 # If the condition evaluates to `true`, then this binding applies to the
3753 # current request.
3754 #
3755 # If the condition evaluates to `false`, then this binding does not apply to
3756 # the current request. However, a different role binding might grant the same
3757 # role to one or more of the principals in this binding.
3758 #
3759 # To learn which resources support conditions in their IAM policies, see the
3760 # [IAM
3761 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3762 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
3763 # are documented at https://github.com/google/cel-spec.
3764 #
3765 # Example (Comparison):
3766 #
3767 # title: &quot;Summary size limit&quot;
3768 # description: &quot;Determines if a summary is less than 100 chars&quot;
3769 # expression: &quot;document.summary.size() &lt; 100&quot;
3770 #
3771 # Example (Equality):
3772 #
3773 # title: &quot;Requestor is owner&quot;
3774 # description: &quot;Determines if requestor is the document owner&quot;
3775 # expression: &quot;document.owner == request.auth.claims.email&quot;
3776 #
3777 # Example (Logic):
3778 #
3779 # title: &quot;Public documents&quot;
3780 # description: &quot;Determine whether the document should be publicly visible&quot;
3781 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
3782 #
3783 # Example (Data Manipulation):
3784 #
3785 # title: &quot;Notification string&quot;
3786 # description: &quot;Create a notification string with a timestamp.&quot;
3787 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
3788 #
3789 # The exact variables and functions that may be referenced within an expression
3790 # are determined by the service that evaluates it. See the service
3791 # documentation for additional information.
3792 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
3793 # describes the expression, e.g. when hovered over it in a UI.
3794 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
3795 # syntax.
3796 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
3797 # reporting, e.g. a file name and a position in the file.
3798 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
3799 # its purpose. This can be used e.g. in UIs which allow to enter the
3800 # expression.
3801 },
3802 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
3803 # `members` can have the following values:
3804 #
3805 # * `allUsers`: A special identifier that represents anyone who is
3806 # on the internet; with or without a Google account.
3807 #
3808 # * `allAuthenticatedUsers`: A special identifier that represents anyone
3809 # who is authenticated with a Google account or a service account.
3810 # Does not include identities that come from external identity providers
3811 # (IdPs) through identity federation.
3812 #
3813 # * `user:{emailid}`: An email address that represents a specific Google
3814 # account. For example, `[email protected]` .
3815 #
3816 #
3817 # * `serviceAccount:{emailid}`: An email address that represents a Google
3818 # service account. For example,
3819 # `[email protected]`.
3820 #
3821 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
3822 # identifier for a
3823 # [Kubernetes service
3824 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
3825 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
3826 #
3827 # * `group:{emailid}`: An email address that represents a Google group.
3828 # For example, `[email protected]`.
3829 #
3830 #
3831 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
3832 # users of that domain. For example, `google.com` or `example.com`.
3833 #
3834 #
3835 #
3836 #
3837 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
3838 # A single identity in a workforce identity pool.
3839 #
3840 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
3841 # All workforce identities in a group.
3842 #
3843 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
3844 # All workforce identities with a specific attribute value.
3845 #
3846 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
3847 # All identities in a workforce identity pool.
3848 #
3849 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
3850 # A single identity in a workload identity pool.
3851 #
3852 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
3853 # A workload identity pool group.
3854 #
3855 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
3856 # All identities in a workload identity pool with a certain attribute.
3857 #
3858 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
3859 # All identities in a workload identity pool.
3860 #
3861 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
3862 # identifier) representing a user that has been recently deleted. For
3863 # example, `[email protected]?uid=123456789012345678901`. If the user is
3864 # recovered, this value reverts to `user:{emailid}` and the recovered user
3865 # retains the role in the binding.
3866 #
3867 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
3868 # unique identifier) representing a service account that has been recently
3869 # deleted. For example,
3870 # `[email protected]?uid=123456789012345678901`.
3871 # If the service account is undeleted, this value reverts to
3872 # `serviceAccount:{emailid}` and the undeleted service account retains the
3873 # role in the binding.
3874 #
3875 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
3876 # identifier) representing a Google group that has been recently
3877 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
3878 # the group is recovered, this value reverts to `group:{emailid}` and the
3879 # recovered group retains the role in the binding.
3880 #
3881 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
3882 # Deleted single identity in a workforce identity pool. For example,
3883 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
3884 &quot;A String&quot;,
3885 ],
3886 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
3887 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
3888 #
3889 # For an overview of the IAM roles and permissions, see the
3890 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
3891 # a list of the available pre-defined roles, see
3892 # [here](https://cloud.google.com/iam/docs/understanding-roles).
3893 },
3894 ],
3895 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
3896 # prevent simultaneous updates of a policy from overwriting each other.
3897 # It is strongly suggested that systems make use of the `etag` in the
3898 # read-modify-write cycle to perform policy updates in order to avoid race
3899 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
3900 # systems are expected to put that etag in the request to `setIamPolicy` to
3901 # ensure that their change will be applied to the same version of the policy.
3902 #
3903 # **Important:** If you use IAM Conditions, you must include the `etag` field
3904 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
3905 # you to overwrite a version `3` policy with a version `1` policy, and all of
3906 # the conditions in the version `3` policy are lost.
3907 &quot;version&quot;: 42, # Specifies the format of the policy.
3908 #
3909 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
3910 # are rejected.
3911 #
3912 # Any operation that affects conditional role bindings must specify version
3913 # `3`. This requirement applies to the following operations:
3914 #
3915 # * Getting a policy that includes a conditional role binding
3916 # * Adding a conditional role binding to a policy
3917 # * Changing a conditional role binding in a policy
3918 # * Removing any role binding, with or without a condition, from a policy
3919 # that includes conditions
3920 #
3921 # **Important:** If you use IAM Conditions, you must include the `etag` field
3922 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
3923 # you to overwrite a version `3` policy with a version `1` policy, and all of
3924 # the conditions in the version `3` policy are lost.
3925 #
3926 # If a policy does not include any conditions, operations on that policy may
3927 # specify any valid version or leave the field unset.
3928 #
3929 # To learn which resources support conditions in their IAM policies, see the
3930 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3931 }</pre>
3932 </div>
3933
3934 <div class="method">
3935 <code class="details" id="testIamPermissions">testIamPermissions(project, zone, resource, body=None, x__xgafv=None)</code>
3936 <pre>Returns permissions that a caller has on the specified resource.
3937
3938 Args:
3939 project: string, Project ID for this request. (required)
3940 zone: string, The name of the zone for this request. (required)
3941 resource: string, Name or id of the resource for this request. (required)
3942 body: object, The request body.
3943 The object takes the form of:
3944
3945 {
3946 &quot;permissions&quot;: [ # The set of permissions to check for the &#x27;resource&#x27;. Permissions with
3947 # wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed.
3948 &quot;A String&quot;,
3949 ],
3950 }
3951
3952 x__xgafv: string, V1 error format.
3953 Allowed values
3954 1 - v1 error format
3955 2 - v2 error format
3956
3957 Returns:
3958 An object of the form:
3959
3960 {
3961 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is
3962 # allowed.
3963 &quot;A String&quot;,
3964 ],
3965 }</pre>
3966 </div>
3967
3968 <div class="method">
3969 <code class="details" id="update">update(project, zone, reservation, body=None, paths=None, requestId=None, updateMask=None, x__xgafv=None)</code>
3970 <pre>Update share settings of the reservation.
3971
3972 Args:
3973 project: string, Project ID for this request. (required)
3974 zone: string, Name of the zone for this request. (required)
3975 reservation: string, Name of the reservation to update. (required)
3976 body: object, The request body.
3977 The object takes the form of:
3978
3979 { # Represents a reservation resource. A reservation ensures that capacity is
3980 # held in a specific zone even if the reserved VMs are not running. For more
3981 # information, read Reserving zonal
3982 # resources.
3983 &quot;advancedDeploymentControl&quot;: { # Advance control for cluster management, applicable only to DENSE deployment # Advanced control for cluster management, applicable only to DENSE
3984 # deployment type reservations.
3985 # type reservations.
3986 &quot;reservationOperationalMode&quot;: &quot;A String&quot;, # Indicates chosen reservation operational mode for the reservation.
3987 },
3988 &quot;aggregateReservation&quot;: { # This reservation type is specified by total resource amounts (e.g. total # Reservation for aggregated resources, providing shape flexibility.
3989 # count of CPUs) and can account for multiple instance SKUs. In other words,
3990 # one can create instances of varying shapes against this reservation.
3991 &quot;hostCount&quot;: 42, # Count of reserved hosts of specified VM family. The host has fixed number
3992 # of accelerators based on the accelerator/vm-family selected.
3993 &quot;inUseHostCount&quot;: 42, # Output only. Number of hosts currently in use. If there is one or more Instances
3994 # running on the host, it is considered in use.
3995 &quot;inUseInstanceCount&quot;: 42, # Output only. Number of instances currently in use in this reservation.
3996 &quot;inUseResources&quot;: [ # Output only. [Output only] List of resources currently in use.
3997 {
3998 &quot;accelerator&quot;: { # Properties of accelerator resources in this reservation.
3999 &quot;acceleratorCount&quot;: 42, # Number of accelerators of specified type.
4000 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL to accelerator type. e.g.
4001 # &quot;projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l&quot;
4002 },
4003 },
4004 ],
4005 &quot;reservedResources&quot;: [ # List of reserved resources (CPUs, memory, accelerators).
4006 {
4007 &quot;accelerator&quot;: { # Properties of accelerator resources in this reservation.
4008 &quot;acceleratorCount&quot;: 42, # Number of accelerators of specified type.
4009 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL to accelerator type. e.g.
4010 # &quot;projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l&quot;
4011 },
4012 },
4013 ],
4014 &quot;vmFamily&quot;: &quot;A String&quot;, # The VM family that all instances scheduled against this reservation must
4015 # belong to.
4016 &quot;workloadType&quot;: &quot;A String&quot;, # The workload type of the instances that will target this reservation.
4017 },
4018 &quot;commitment&quot;: &quot;A String&quot;, # Output only. [Output Only] Full or partial URL to a parent commitment. This field
4019 # displays for reservations that are tied to a commitment.
4020 &quot;confidentialComputeType&quot;: &quot;A String&quot;,
4021 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
4022 # text format.
4023 &quot;deleteAfterDuration&quot;: { # A Duration represents a fixed-length span of time represented # Duration time relative to reservation creation when Compute Engine will
4024 # automatically delete this resource.
4025 # as a count of seconds and fractions of seconds at nanosecond
4026 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
4027 # or &quot;month&quot;. Range is approximately 10,000 years.
4028 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
4029 # Durations less than one second are represented with a 0
4030 # `seconds` field and a positive `nanos` field. Must be from 0
4031 # to 999,999,999 inclusive.
4032 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
4033 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
4034 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
4035 },
4036 &quot;deleteAtTime&quot;: &quot;A String&quot;, # Absolute time in future when the reservation will be
4037 # auto-deleted by Compute Engine. Timestamp is represented inRFC3339 text format.
4038 &quot;deploymentType&quot;: &quot;A String&quot;, # Specifies the deployment strategy for this reservation.
4039 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
4040 # create the resource.
4041 &quot;earlyAccessMaintenance&quot;: &quot;A String&quot;, # Indicates the early access maintenance for the reservation.
4042 # If this field is absent or set to NO_EARLY_ACCESS, the reservation is not
4043 # enrolled in early access maintenance and the standard notice applies.
4044 &quot;enableEmergentMaintenance&quot;: True or False, # Indicates whether Compute Engine allows unplanned maintenance for your VMs;
4045 # for example, to fix hardware errors.
4046 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
4047 # defined by the server.
4048 &quot;kind&quot;: &quot;compute#reservation&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#reservations for reservations.
4049 &quot;linkedCommitments&quot;: [ # Output only. [Output Only] Full or partial URL to parent commitments. This field
4050 # displays for reservations that are tied to multiple commitments.
4051 &quot;A String&quot;,
4052 ],
4053 &quot;name&quot;: &quot;A String&quot;, # The name of the resource, provided by the client when initially creating
4054 # the resource. The resource name must be 1-63 characters long, and comply
4055 # withRFC1035.
4056 # Specifically, the name must be 1-63 characters long and match the regular
4057 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
4058 # character must be a lowercase letter, and all following characters must be
4059 # a dash, lowercase letter, or digit, except the last character, which cannot
4060 # be a dash.
4061 &quot;params&quot;: { # Additional reservation params. # Input only. Additional params passed with the request, but not persisted
4062 # as part of resource payload.
4063 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the reservation. Tag keys and
4064 # values have the same definition as resource
4065 # manager tags. Keys and values can be either in numeric format,
4066 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
4067 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
4068 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
4069 # PATCH) when empty.
4070 &quot;a_key&quot;: &quot;A String&quot;,
4071 },
4072 },
4073 &quot;protectionTier&quot;: &quot;A String&quot;, # Protection tier for the workload which specifies the workload expectations
4074 # in the event of infrastructure failures at data center (e.g. power
4075 # and/or cooling failures).
4076 &quot;reservationMode&quot;: &quot;A String&quot;, # Output only. [Output only] Indicates the reservation mode of the reservation.
4077 &quot;reservationSharingPolicy&quot;: { # Specify the reservation sharing policy. If unspecified, the reservation
4078 # will not be shared with Google Cloud managed services.
4079 &quot;serviceShareType&quot;: &quot;A String&quot;, # Sharing config for all Google Cloud services.
4080 },
4081 &quot;resourcePolicies&quot;: { # Resource policies to be added to this reservation. The key is defined by
4082 # user, and the value is resource policy url. This is to define placement
4083 # policy with reservation.
4084 &quot;a_key&quot;: &quot;A String&quot;,
4085 },
4086 &quot;resourceStatus&quot;: { # [Output Only] Contains output only fields. # Output only. [Output Only] Status information for Reservation resource.
4087 &quot;healthInfo&quot;: { # Health information for the reservation. # [Output only] Health information for the reservation.
4088 &quot;degradedBlockCount&quot;: 42, # The number of reservation blocks that are degraded.
4089 &quot;healthStatus&quot;: &quot;A String&quot;, # The health status of the reservation.
4090 &quot;healthyBlockCount&quot;: 42, # The number of reservation blocks that are healthy.
4091 },
4092 &quot;reservationBlockCount&quot;: 42, # The number of reservation blocks associated with this reservation.
4093 &quot;reservationMaintenance&quot;: { # Maintenance Info for ReservationBlocks. # Maintenance information for this reservation
4094 &quot;instanceMaintenanceOngoingCount&quot;: 42, # Describes number of instances that have ongoing maintenance.
4095 &quot;instanceMaintenancePendingCount&quot;: 42, # Describes number of instances that have pending maintenance.
4096 &quot;maintenanceOngoingCount&quot;: 42, # Progress for ongoing maintenance for this group of VMs/hosts.
4097 # Describes number of hosts in the block that have ongoing maintenance.
4098 &quot;maintenancePendingCount&quot;: 42, # Progress for ongoing maintenance for this group of VMs/hosts.
4099 # Describes number of hosts in the block that have pending maintenance.
4100 &quot;schedulingType&quot;: &quot;A String&quot;, # The type of maintenance for the reservation.
4101 &quot;subblockInfraMaintenanceOngoingCount&quot;: 42, # Describes number of subblock Infrastructure that has ongoing maintenance.
4102 # Here, Subblock Infrastructure Maintenance pertains to upstream hardware
4103 # contained in the Subblock that is necessary for a VM Family(e.g. NVLink
4104 # Domains). Not all VM Families will support this field.
4105 &quot;subblockInfraMaintenancePendingCount&quot;: 42, # Describes number of subblock Infrastructure that has pending maintenance.
4106 # Here, Subblock Infrastructure Maintenance pertains to upstream hardware
4107 # contained in the Subblock that is necessary for a VM Family (e.g. NVLink
4108 # Domains). Not all VM Families will support this field.
4109 &quot;upcomingGroupMaintenance&quot;: { # Upcoming Maintenance notification information. # Maintenance information on this group of VMs.
4110 &quot;canReschedule&quot;: True or False, # Indicates if the maintenance can be customer triggered.
4111 &quot;latestWindowStartTime&quot;: &quot;A String&quot;, # The latest time for the planned maintenance window to start.
4112 # This timestamp value is in RFC3339 text format.
4113 &quot;maintenanceOnShutdown&quot;: True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown.
4114 &quot;maintenanceReasons&quot;: [ # The reasons for the maintenance. Only valid for vms.
4115 &quot;A String&quot;,
4116 ],
4117 &quot;maintenanceStatus&quot;: &quot;A String&quot;,
4118 &quot;type&quot;: &quot;A String&quot;, # Defines the type of maintenance.
4119 &quot;windowEndTime&quot;: &quot;A String&quot;, # The time by which the maintenance disruption will be completed.
4120 # This timestamp value is in RFC3339 text format.
4121 &quot;windowStartTime&quot;: &quot;A String&quot;, # The current start time of the maintenance window.
4122 # This timestamp value is in RFC3339 text format.
4123 },
4124 },
4125 &quot;specificSkuAllocation&quot;: { # Contains Properties set for the reservation. # Allocation Properties of this reservation.
4126 &quot;sourceInstanceTemplateId&quot;: &quot;A String&quot;, # ID of the instance template used to populate reservation properties.
4127 &quot;utilizations&quot;: { # Per service utilization breakdown. The Key is the Google Cloud managed
4128 # service name.
4129 &quot;a_key&quot;: &quot;A String&quot;,
4130 },
4131 },
4132 },
4133 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
4134 &quot;schedulingType&quot;: &quot;A String&quot;, # The type of maintenance for the reservation.
4135 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
4136 &quot;shareSettings&quot;: { # The share setting for reservations and sole tenancy node groups. # Specify share-settings to create a shared reservation. This property is
4137 # optional. For more information about the syntax and options for this
4138 # field and its subfields, see the guide for creating
4139 # a shared reservation.
4140 &quot;folderMap&quot;: { # A map of folder id and folder config to specify consumer projects for this
4141 # shared-reservation. This is only valid when share_type&#x27;s value is
4142 # DIRECT_PROJECTS_UNDER_SPECIFIC_FOLDERS.
4143 # Folder id should be a string of number, and without &quot;folders/&quot; prefix.
4144 &quot;a_key&quot;: { # Config for each folder in the share settings.
4145 &quot;folderId&quot;: &quot;A String&quot;, # The folder ID, should be same as the key of this folder config in the
4146 # parent map.
4147 # Folder id should be a string of number, and without &quot;folders/&quot; prefix.
4148 },
4149 },
4150 &quot;projectMap&quot;: { # A map of project id and project config. This is only valid when
4151 # share_type&#x27;s value is SPECIFIC_PROJECTS.
4152 &quot;a_key&quot;: { # Config for each project in the share settings.
4153 &quot;projectId&quot;: &quot;A String&quot;, # The project ID, should be same as the key of this project config in the
4154 # parent map.
4155 },
4156 },
4157 &quot;projects&quot;: [ # A List of Project names to specify consumer projects for this
4158 # shared-reservation. This is only valid when share_type&#x27;s value is
4159 # SPECIFIC_PROJECTS.
4160 &quot;A String&quot;,
4161 ],
4162 &quot;shareType&quot;: &quot;A String&quot;, # Type of sharing for this shared-reservation
4163 },
4164 &quot;specificReservation&quot;: { # This reservation type allows to pre allocate specific instance # Reservation for instances with specific machine shapes.
4165 # configuration.
4166 &quot;assuredCount&quot;: &quot;A String&quot;, # Output only. [Output Only] Indicates how many instances are actually usable currently.
4167 &quot;count&quot;: &quot;A String&quot;, # Specifies the number of resources that are allocated.
4168 &quot;inUseCount&quot;: &quot;A String&quot;, # Output only. [Output Only] Indicates how many instances are in use.
4169 &quot;instanceProperties&quot;: { # Properties of the SKU instances being reserved. # The instance properties for the reservation.
4170 # Next ID: 10
4171 &quot;guestAccelerators&quot;: [ # Specifies accelerator type and count.
4172 { # A specification of the type and number of accelerator cards attached to the
4173 # instance.
4174 &quot;acceleratorCount&quot;: 42, # The number of the guest accelerator cards exposed to this instance.
4175 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL of the accelerator type resource to attach to this
4176 # instance. For example:projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100
4177 # If you are creating an instance template, specify only the
4178 # accelerator name.
4179 # See GPUs on Compute Engine
4180 # for a full list of accelerator types.
4181 },
4182 ],
4183 &quot;localSsds&quot;: [ # Specifies amount of local ssd to reserve with each instance. The type
4184 # of disk is local-ssd.
4185 {
4186 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Specifies the size of the disk in base-2 GB.
4187 &quot;interface&quot;: &quot;A String&quot;, # Specifies the disk interface to use for attaching this disk, which is
4188 # either SCSI or NVME. The default isSCSI.
4189 # For performance characteristics of SCSI over NVMe, seeLocal SSD performance.
4190 },
4191 ],
4192 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the allocation close to other
4193 # resources.
4194 # This field is for use by internal tools that use the public API.
4195 &quot;machineType&quot;: &quot;A String&quot;, # Specifies type of machine (name only) which has fixed number of vCPUs
4196 # and fixed amount of memory. This also includes specifying custom
4197 # machine type following custom-NUMBER_OF_CPUS-AMOUNT_OF_MEMORY pattern.
4198 &quot;maintenanceFreezeDurationHours&quot;: 42, # Specifies the number of hours after reservation creation where
4199 # instances using the reservation won&#x27;t be scheduled for maintenance.
4200 &quot;maintenanceInterval&quot;: &quot;A String&quot;, # Specifies the frequency of planned maintenance events. The accepted
4201 # values are: `PERIODIC`.
4202 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Minimum cpu platform the reservation.
4203 },
4204 &quot;sourceInstanceTemplate&quot;: &quot;A String&quot;, # Specifies the instance template to create the reservation. If you use
4205 # this field, you must exclude the instanceProperties field.
4206 #
4207 # This field is optional, and it can be a full or partial URL. For example,
4208 # the following are all valid URLs to an instance template:
4209 #
4210 #
4211 # - https://www.googleapis.com/compute/v1/projects/project/global/instanceTemplates/instanceTemplate
4212 # - projects/project/global/instanceTemplates/instanceTemplate
4213 # - global/instanceTemplates/instanceTemplate
4214 },
4215 &quot;specificReservationRequired&quot;: True or False, # Indicates whether the reservation can be consumed by VMs with affinity
4216 # for &quot;any&quot; reservation. If the field is set, then only VMs that target
4217 # the reservation by name can consume from this reservation.
4218 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of the reservation.
4219 #
4220 #
4221 # - CREATING: Reservation resources are being
4222 # allocated.
4223 # - READY: Reservation resources have been allocated,
4224 # and the reservation is ready for use.
4225 # - DELETING: Reservation deletion is in progress.
4226 # - UPDATING: Reservation update is in progress.
4227 &quot;zone&quot;: &quot;A String&quot;, # Zone in which the reservation resides. A zone must be provided if the
4228 # reservation is created within a commitment.
4229 }
4230
4231 paths: string, A parameter (repeated)
4232 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
4233 that if you must retry your request, the server will know to ignore the
4234 request if it has already been completed.
4235
4236 For example, consider a situation where you make an initial request and
4237 the request times out. If you make the request again with the same
4238 request ID, the server can check if original operation with the same
4239 request ID was received, and if so, will ignore the second request. This
4240 prevents clients from accidentally creating duplicate commitments.
4241
4242 The request ID must be
4243 a valid UUID with the exception that zero UUID is not supported
4244 (00000000-0000-0000-0000-000000000000).
4245 updateMask: string, Update_mask indicates fields to be updated as part of this request.
4246 x__xgafv: string, V1 error format.
4247 Allowed values
4248 1 - v1 error format
4249 2 - v2 error format
4250
4251 Returns:
4252 An object of the form:
4253
4254 { # Represents an Operation resource.
4255 #
4256 # Google Compute Engine has three Operation resources:
4257 #
4258 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
4259 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
4260 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
4261 #
4262 # You can use an operation resource to manage asynchronous API requests.
4263 # For more information, readHandling
4264 # API responses.
4265 #
4266 # Operations can be global, regional or zonal.
4267 #
4268 # - For global operations, use the `globalOperations`
4269 # resource.
4270 # - For regional operations, use the
4271 # `regionOperations` resource.
4272 # - For zonal operations, use
4273 # the `zoneOperations` resource.
4274 #
4275 #
4276 #
4277 # For more information, read
4278 # Global, Regional, and Zonal Resources.
4279 #
4280 # Note that completed Operation resources have a limited
4281 # retention period.
4282 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
4283 # Not present otherwise.
4284 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
4285 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
4286 # set when the operation is created.
4287 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
4288 # text format.
4289 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
4290 # this field will be populated.
4291 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
4292 # operation.
4293 {
4294 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
4295 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
4296 # details. There is a set of defined message types to use for providing
4297 # details.The syntax depends on the error code. For example,
4298 # QuotaExceededInfo will have details when the error code is
4299 # QUOTA_EXCEEDED.
4300 {
4301 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
4302 #
4303 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
4304 # is not enabled:
4305 #
4306 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
4307 # &quot;domain&quot;: &quot;googleapis.com&quot;
4308 # &quot;metadata&quot;: {
4309 # &quot;resource&quot;: &quot;projects/123&quot;,
4310 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
4311 # }
4312 # }
4313 #
4314 # This response indicates that the pubsub.googleapis.com API is not enabled.
4315 #
4316 # Example of an error that is returned when attempting to create a Spanner
4317 # instance in a region that is out of stock:
4318 #
4319 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
4320 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
4321 # &quot;metadata&quot;: {
4322 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
4323 # }
4324 # }
4325 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
4326 # is typically the registered service name of the tool or product that
4327 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
4328 # generated by some common infrastructure, the error domain must be a
4329 # globally unique value that identifies the infrastructure. For Google API
4330 # infrastructure, the error domain is &quot;googleapis.com&quot;.
4331 &quot;metadatas&quot;: { # Additional structured details about this error.
4332 #
4333 # Keys must match a regular expression of `a-z+` but should
4334 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
4335 # length. When identifying the current value of an exceeded limit, the units
4336 # should be contained in the key, not the value. For example, rather than
4337 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
4338 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
4339 # instances that can be created in a single (batch) request.
4340 &quot;a_key&quot;: &quot;A String&quot;,
4341 },
4342 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
4343 # proximate cause of the error. Error reasons are unique within a particular
4344 # domain of errors. This should be at most 63 characters and match a
4345 # regular expression of `A-Z+[A-Z0-9]`, which represents
4346 # UPPER_SNAKE_CASE.
4347 },
4348 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
4349 #
4350 # For example, if a quota check failed with an error indicating the calling
4351 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
4352 # directly to the right place in the developer console to flip the bit.
4353 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
4354 { # Describes a URL link.
4355 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
4356 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
4357 },
4358 ],
4359 },
4360 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
4361 # which can be attached to an RPC error.
4362 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
4363 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
4364 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
4365 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
4366 },
4367 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
4368 &quot;dimensions&quot;: { # The map holding related quota dimensions.
4369 &quot;a_key&quot;: &quot;A String&quot;,
4370 },
4371 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
4372 # type or metric.
4373 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
4374 # or metric.
4375 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
4376 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
4377 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
4378 },
4379 },
4380 ],
4381 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
4382 # This property is optional.
4383 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
4384 },
4385 ],
4386 },
4387 &quot;getVersionOperationMetadata&quot;: {
4388 &quot;inlineSbomInfo&quot;: {
4389 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
4390 # appropriate identifiers.
4391 &quot;a_key&quot;: &quot;A String&quot;,
4392 },
4393 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
4394 # identifiers.
4395 &quot;a_key&quot;: &quot;A String&quot;,
4396 },
4397 },
4398 },
4399 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
4400 # message that was returned, such as `NOT FOUND`.
4401 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
4402 # status code that was returned. For example, a `404` means the
4403 # resource was not found.
4404 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
4405 # defined by the server.
4406 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
4407 # This value is inRFC3339
4408 # text format.
4409 &quot;instancesBulkInsertOperationMetadata&quot;: {
4410 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
4411 # Example key: zones/us-central1-a
4412 &quot;a_key&quot;: {
4413 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
4414 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
4415 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
4416 # error.
4417 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
4418 # if the flow is rolling forward or rolling back.
4419 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
4420 },
4421 },
4422 },
4423 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
4424 # Operation resources.
4425 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
4426 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
4427 # group of operations results from a `bulkInsert` API request.
4428 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
4429 # `update`, or `delete`, and so on.
4430 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
4431 # There is no requirement that this be linear or support any granularity of
4432 # operations. This should not be used to guess when the operation will be
4433 # complete. This number should monotonically increase as the operation
4434 # progresses.
4435 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
4436 # applicable when performing regional operations.
4437 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
4438 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
4439 # this field will contain information on all underlying zonal actions and
4440 # their state.
4441 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
4442 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
4443 # Example key: zones/us-central1-a
4444 &quot;a_key&quot;: {
4445 &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
4446 # populated.
4447 # different programming environments, including REST APIs and RPC APIs. It is
4448 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
4449 # three pieces of data: error code, error message, and error details.
4450 #
4451 # You can find out more about this error model and how to work with it in the
4452 # [API Design Guide](https://cloud.google.com/apis/design/errors).
4453 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
4454 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
4455 # message types for APIs to use.
4456 {
4457 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
4458 },
4459 ],
4460 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
4461 # user-facing error message should be localized and sent in the
4462 # google.rpc.Status.details field, or localized by the client.
4463 },
4464 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
4465 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
4466 },
4467 },
4468 },
4469 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
4470 # This value is inRFC3339
4471 # text format.
4472 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
4473 # following:
4474 # `PENDING`, `RUNNING`, or `DONE`.
4475 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
4476 # operation.
4477 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
4478 # of the target resource.
4479 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
4480 # operations related to creating a snapshot, this points to the disk
4481 # that the snapshot was created from.
4482 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
4483 # `[email protected]` or
4484 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
4485 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
4486 # operation, this field will be populated.
4487 {
4488 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
4489 # Engine returns NO_RESULTS_ON_PAGE if there
4490 # are no results in the response.
4491 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
4492 # value format. For example:
4493 #
4494 # &quot;data&quot;: [
4495 # {
4496 # &quot;key&quot;: &quot;scope&quot;,
4497 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
4498 # }
4499 {
4500 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
4501 # returned. For example, for warnings where there are no results in a list
4502 # request for a particular zone, this key might be scope and
4503 # the key value might be the zone name. Other examples might be a key
4504 # indicating a deprecated resource and a suggested replacement, or a
4505 # warning about invalid network settings (for example, if an instance
4506 # attempts to perform IP forwarding but is not enabled for IP forwarding).
4507 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
4508 },
4509 ],
4510 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
4511 },
4512 ],
4513 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
4514 # applicable when performing per-zone operations.
4515 }</pre>
4516 </div>
4517
4518 </body></html>