Debian Codegraph @

docs/dyn/compute_alpha.licenses.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.licenses.html">licenses</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#delete">delete(project, license, requestId=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Deletes the specified license.</p>
83 <p class="toc_element">
84 <code><a href="#get">get(project, license, x__xgafv=None)</a></code></p>
85 <p class="firstline">Returns the specified License resource.</p>
86 <p class="toc_element">
87 <code><a href="#getIamPolicy">getIamPolicy(project, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Gets the access control policy for a resource. May be empty if no such</p>
89 <p class="toc_element">
90 <code><a href="#insert">insert(project, body=None, requestId=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Create a License resource in the specified project.</p>
92 <p class="toc_element">
93 <code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
94 <p class="firstline">Retrieves the list of licenses</p>
95 <p class="toc_element">
96 <code><a href="#list_next">list_next()</a></code></p>
97 <p class="firstline">Retrieves the next page of results.</p>
98 <p class="toc_element">
99 <code><a href="#setIamPolicy">setIamPolicy(project, resource, body=None, x__xgafv=None)</a></code></p>
100 <p class="firstline">Sets the access control policy on the specified resource.</p>
101 <p class="toc_element">
102 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</a></code></p>
103 <p class="firstline">Returns permissions that a caller has on the specified resource.</p>
104 <p class="toc_element">
105 <code><a href="#update">update(project, license, body=None, requestId=None, updateMask=None, x__xgafv=None)</a></code></p>
106 <p class="firstline">Updates a License resource in the specified project.</p>
107 <h3>Method Details</h3>
108 <div class="method">
109 <code class="details" id="close">close()</code>
110 <pre>Close httplib2 connections.</pre>
111 </div>
112
113 <div class="method">
114 <code class="details" id="delete">delete(project, license, requestId=None, x__xgafv=None)</code>
115 <pre>Deletes the specified license.
116 *Caution* This resource is intended
117 for use only by third-party partners who are creatingCloud Marketplace
118 images.
119
120 Args:
121 project: string, Project ID for this request. (required)
122 license: string, Name of the license resource to delete. (required)
123 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
124 that if you must retry your request, the server will know to ignore the
125 request if it has already been completed.
126
127 For example, consider a situation where you make an initial request and
128 the request times out. If you make the request again with the same
129 request ID, the server can check if original operation with the same
130 request ID was received, and if so, will ignore the second request. This
131 prevents clients from accidentally creating duplicate commitments.
132
133 The request ID must be
134 a valid UUID with the exception that zero UUID is not supported
135 (00000000-0000-0000-0000-000000000000).
136 x__xgafv: string, V1 error format.
137 Allowed values
138 1 - v1 error format
139 2 - v2 error format
140
141 Returns:
142 An object of the form:
143
144 { # Represents an Operation resource.
145 #
146 # Google Compute Engine has three Operation resources:
147 #
148 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
149 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
150 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
151 #
152 # You can use an operation resource to manage asynchronous API requests.
153 # For more information, readHandling
154 # API responses.
155 #
156 # Operations can be global, regional or zonal.
157 #
158 # - For global operations, use the `globalOperations`
159 # resource.
160 # - For regional operations, use the
161 # `regionOperations` resource.
162 # - For zonal operations, use
163 # the `zoneOperations` resource.
164 #
165 #
166 #
167 # For more information, read
168 # Global, Regional, and Zonal Resources.
169 #
170 # Note that completed Operation resources have a limited
171 # retention period.
172 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
173 # Not present otherwise.
174 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
175 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
176 # set when the operation is created.
177 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
178 # text format.
179 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
180 # this field will be populated.
181 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
182 # operation.
183 {
184 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
185 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
186 # details. There is a set of defined message types to use for providing
187 # details.The syntax depends on the error code. For example,
188 # QuotaExceededInfo will have details when the error code is
189 # QUOTA_EXCEEDED.
190 {
191 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
192 #
193 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
194 # is not enabled:
195 #
196 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
197 # &quot;domain&quot;: &quot;googleapis.com&quot;
198 # &quot;metadata&quot;: {
199 # &quot;resource&quot;: &quot;projects/123&quot;,
200 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
201 # }
202 # }
203 #
204 # This response indicates that the pubsub.googleapis.com API is not enabled.
205 #
206 # Example of an error that is returned when attempting to create a Spanner
207 # instance in a region that is out of stock:
208 #
209 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
210 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
211 # &quot;metadata&quot;: {
212 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
213 # }
214 # }
215 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
216 # is typically the registered service name of the tool or product that
217 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
218 # generated by some common infrastructure, the error domain must be a
219 # globally unique value that identifies the infrastructure. For Google API
220 # infrastructure, the error domain is &quot;googleapis.com&quot;.
221 &quot;metadatas&quot;: { # Additional structured details about this error.
222 #
223 # Keys must match a regular expression of `a-z+` but should
224 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
225 # length. When identifying the current value of an exceeded limit, the units
226 # should be contained in the key, not the value. For example, rather than
227 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
228 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
229 # instances that can be created in a single (batch) request.
230 &quot;a_key&quot;: &quot;A String&quot;,
231 },
232 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
233 # proximate cause of the error. Error reasons are unique within a particular
234 # domain of errors. This should be at most 63 characters and match a
235 # regular expression of `A-Z+[A-Z0-9]`, which represents
236 # UPPER_SNAKE_CASE.
237 },
238 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
239 #
240 # For example, if a quota check failed with an error indicating the calling
241 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
242 # directly to the right place in the developer console to flip the bit.
243 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
244 { # Describes a URL link.
245 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
246 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
247 },
248 ],
249 },
250 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
251 # which can be attached to an RPC error.
252 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
253 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
254 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
255 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
256 },
257 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
258 &quot;dimensions&quot;: { # The map holding related quota dimensions.
259 &quot;a_key&quot;: &quot;A String&quot;,
260 },
261 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
262 # type or metric.
263 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
264 # or metric.
265 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
266 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
267 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
268 },
269 },
270 ],
271 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
272 # This property is optional.
273 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
274 },
275 ],
276 },
277 &quot;getVersionOperationMetadata&quot;: {
278 &quot;inlineSbomInfo&quot;: {
279 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
280 # appropriate identifiers.
281 &quot;a_key&quot;: &quot;A String&quot;,
282 },
283 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
284 # identifiers.
285 &quot;a_key&quot;: &quot;A String&quot;,
286 },
287 },
288 },
289 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
290 # message that was returned, such as `NOT FOUND`.
291 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
292 # status code that was returned. For example, a `404` means the
293 # resource was not found.
294 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
295 # defined by the server.
296 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
297 # This value is inRFC3339
298 # text format.
299 &quot;instancesBulkInsertOperationMetadata&quot;: {
300 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
301 # Example key: zones/us-central1-a
302 &quot;a_key&quot;: {
303 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
304 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
305 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
306 # error.
307 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
308 # if the flow is rolling forward or rolling back.
309 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
310 },
311 },
312 },
313 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
314 # Operation resources.
315 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
316 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
317 # group of operations results from a `bulkInsert` API request.
318 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
319 # `update`, or `delete`, and so on.
320 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
321 # There is no requirement that this be linear or support any granularity of
322 # operations. This should not be used to guess when the operation will be
323 # complete. This number should monotonically increase as the operation
324 # progresses.
325 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
326 # applicable when performing regional operations.
327 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
328 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
329 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
330 # this field will contain information on all underlying zonal actions and
331 # their state.
332 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
333 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
334 # Example key: zones/us-central1-a
335 &quot;a_key&quot;: {
336 &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
337 # populated.
338 # different programming environments, including REST APIs and RPC APIs. It is
339 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
340 # three pieces of data: error code, error message, and error details.
341 #
342 # You can find out more about this error model and how to work with it in the
343 # [API Design Guide](https://cloud.google.com/apis/design/errors).
344 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
345 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
346 # message types for APIs to use.
347 {
348 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
349 },
350 ],
351 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
352 # user-facing error message should be localized and sent in the
353 # google.rpc.Status.details field, or localized by the client.
354 },
355 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
356 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
357 },
358 },
359 },
360 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
361 # This value is inRFC3339
362 # text format.
363 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
364 # following:
365 # `PENDING`, `RUNNING`, or `DONE`.
366 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
367 # operation.
368 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
369 # of the target resource.
370 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
371 # operations related to creating a snapshot, this points to the disk
372 # that the snapshot was created from.
373 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
374 # `[email protected]` or
375 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
376 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
377 # operation, this field will be populated.
378 {
379 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
380 # Engine returns NO_RESULTS_ON_PAGE if there
381 # are no results in the response.
382 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
383 # value format. For example:
384 #
385 # &quot;data&quot;: [
386 # {
387 # &quot;key&quot;: &quot;scope&quot;,
388 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
389 # }
390 {
391 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
392 # returned. For example, for warnings where there are no results in a list
393 # request for a particular zone, this key might be scope and
394 # the key value might be the zone name. Other examples might be a key
395 # indicating a deprecated resource and a suggested replacement, or a
396 # warning about invalid network settings (for example, if an instance
397 # attempts to perform IP forwarding but is not enabled for IP forwarding).
398 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
399 },
400 ],
401 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
402 },
403 ],
404 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
405 # applicable when performing per-zone operations.
406 }</pre>
407 </div>
408
409 <div class="method">
410 <code class="details" id="get">get(project, license, x__xgafv=None)</code>
411 <pre>Returns the specified License resource.
412 *Caution* This resource is intended
413 for use only by third-party partners who are creatingCloud Marketplace
414 images.
415
416 Args:
417 project: string, Project ID for this request. (required)
418 license: string, Name of the License resource to return. (required)
419 x__xgafv: string, V1 error format.
420 Allowed values
421 1 - v1 error format
422 2 - v2 error format
423
424 Returns:
425 An object of the form:
426
427 { # Represents a License resource.
428 #
429 # A License represents billing and aggregate usage data forpublic andmarketplace images.
430 # *Caution* This resource is intended for
431 # use only by third-party partners who are creatingCloud Marketplace
432 # images.
433 &quot;allowedReplacementLicenses&quot;: [ # Specifies licenseCodes of licenses that can replace this license. Note:
434 # such replacements are allowed even if removable_from_disk is false.
435 &quot;A String&quot;,
436 ],
437 &quot;appendableToDisk&quot;: True or False, # If true, this license can be appended to an existing disk&#x27;s set of
438 # licenses.
439 &quot;chargesUseFee&quot;: True or False, # [Output Only] Deprecated. This field no longer reflects whether a license
440 # charges a usage fee.
441 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
442 # text format.
443 &quot;description&quot;: &quot;A String&quot;, # An optional textual description of the resource; provided by the client
444 # when the resource is created.
445 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
446 # defined by the server.
447 &quot;incompatibleLicenses&quot;: [ # Specifies licenseCodes of licenses that are incompatible with this license.
448 # If a license is incompatible with this license, it cannot be attached to
449 # the same disk or image.
450 &quot;A String&quot;,
451 ],
452 &quot;kind&quot;: &quot;compute#license&quot;, # Output only. [Output Only] Type of resource. Always compute#license for
453 # licenses.
454 &quot;licenseCode&quot;: &quot;A String&quot;, # [Output Only] The unique code used to attach this license to images,
455 # snapshots, and disks.
456 &quot;minimumRetention&quot;: { # A Duration represents a fixed-length span of time represented # If set, this license will be unable to be removed or replaced once attached
457 # to a disk until the minimum_retention period has passed.
458 # as a count of seconds and fractions of seconds at nanosecond
459 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
460 # or &quot;month&quot;. Range is approximately 10,000 years.
461 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
462 # Durations less than one second are represented with a 0
463 # `seconds` field and a positive `nanos` field. Must be from 0
464 # to 999,999,999 inclusive.
465 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
466 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
467 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
468 },
469 &quot;multiTenantOnly&quot;: True or False, # If true, this license can only be used on VMs on multi tenant nodes.
470 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. The name must be 1-63 characters long and
471 # comply withRFC1035.
472 &quot;osLicense&quot;: True or False, # If true, indicates this is an OS license. Only one OS license can be
473 # attached to a disk or image at a time.
474 &quot;params&quot;: { # Additional license params. # Input only. Additional params passed with the request, but not persisted
475 # as part of resource payload.
476 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the license. Tag keys and values
477 # have the same definition as resource
478 # manager tags. Keys and values can be either in numeric format,
479 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
480 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
481 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
482 # PATCH) when empty.
483 &quot;a_key&quot;: &quot;A String&quot;,
484 },
485 },
486 &quot;removableFromDisk&quot;: True or False, # If true, this license can be removed from a disk&#x27;s set of licenses, with no
487 # replacement license needed.
488 &quot;requiredCoattachedLicenses&quot;: [ # Specifies the set of permissible coattached licenseCodes of licenses that
489 # satisfy the coattachment requirement of this license. At least one license
490 # from the set must be attached to the same disk or image as this license.
491 &quot;A String&quot;,
492 ],
493 &quot;resourceRequirements&quot;: { # [Input Only] Deprecated.
494 &quot;minGuestCpuCount&quot;: 42, # [Input Only] Deprecated. This field no longer reflects the minimum number
495 # of guest cpus required to use the Instance.
496 &quot;minMemoryMb&quot;: 42, # [Input Only] Deprecated. This field no longer reflects the minimum memory
497 # required to use the Instance.
498 },
499 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
500 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
501 &quot;soleTenantOnly&quot;: True or False, # If true, this license can only be used on VMs on sole tenant nodes.
502 &quot;transferable&quot;: True or False, # If false, licenses will not be copied from the source resource when
503 # creating an image from a disk, disk from snapshot, or snapshot from disk.
504 &quot;updateTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last update timestamp inRFC3339
505 # text format.
506 }</pre>
507 </div>
508
509 <div class="method">
510 <code class="details" id="getIamPolicy">getIamPolicy(project, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</code>
511 <pre>Gets the access control policy for a resource. May be empty if no such
512 policy or resource exists.
513 *Caution* This resource is intended
514 for use only by third-party partners who are creatingCloud Marketplace
515 images.
516
517 Args:
518 project: string, Project ID for this request. (required)
519 resource: string, Name or id of the resource for this request. (required)
520 optionsRequestedPolicyVersion: integer, Requested IAM Policy version.
521 x__xgafv: string, V1 error format.
522 Allowed values
523 1 - v1 error format
524 2 - v2 error format
525
526 Returns:
527 An object of the form:
528
529 { # An Identity and Access Management (IAM) policy, which specifies access
530 # controls for Google Cloud resources.
531 #
532 #
533 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
534 # `members`, or principals, to a single `role`. Principals can be user
535 # accounts, service accounts, Google groups, and domains (such as G Suite). A
536 # `role` is a named list of permissions; each `role` can be an IAM predefined
537 # role or a user-created custom role.
538 #
539 # For some types of Google Cloud resources, a `binding` can also specify a
540 # `condition`, which is a logical expression that allows access to a resource
541 # only if the expression evaluates to `true`. A condition can add constraints
542 # based on attributes of the request, the resource, or both. To learn which
543 # resources support conditions in their IAM policies, see the
544 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
545 #
546 # **JSON example:**
547 #
548 # ```
549 # {
550 # &quot;bindings&quot;: [
551 # {
552 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
553 # &quot;members&quot;: [
554 # &quot;user:[email protected]&quot;,
555 # &quot;group:[email protected]&quot;,
556 # &quot;domain:google.com&quot;,
557 # &quot;serviceAccount:[email protected]&quot;
558 # ]
559 # },
560 # {
561 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
562 # &quot;members&quot;: [
563 # &quot;user:[email protected]&quot;
564 # ],
565 # &quot;condition&quot;: {
566 # &quot;title&quot;: &quot;expirable access&quot;,
567 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
568 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
569 # }
570 # }
571 # ],
572 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
573 # &quot;version&quot;: 3
574 # }
575 # ```
576 #
577 # **YAML example:**
578 #
579 # ```
580 # bindings:
581 # - members:
582 # - user:[email protected]
583 # - group:[email protected]
584 # - domain:google.com
585 # - serviceAccount:[email protected]
586 # role: roles/resourcemanager.organizationAdmin
587 # - members:
588 # - user:[email protected]
589 # role: roles/resourcemanager.organizationViewer
590 # condition:
591 # title: expirable access
592 # description: Does not grant access after Sep 2020
593 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
594 # etag: BwWWja0YfJA=
595 # version: 3
596 # ```
597 #
598 # For a description of IAM and its features, see the
599 # [IAM documentation](https://cloud.google.com/iam/docs/).
600 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
601 { # Specifies the audit configuration for a service.
602 # The configuration determines which permission types are logged, and what
603 # identities, if any, are exempted from logging.
604 # An AuditConfig must have one or more AuditLogConfigs.
605 #
606 # If there are AuditConfigs for both `allServices` and a specific service,
607 # the union of the two AuditConfigs is used for that service: the log_types
608 # specified in each AuditConfig are enabled, and the exempted_members in each
609 # AuditLogConfig are exempted.
610 #
611 # Example Policy with multiple AuditConfigs:
612 #
613 # {
614 # &quot;audit_configs&quot;: [
615 # {
616 # &quot;service&quot;: &quot;allServices&quot;,
617 # &quot;audit_log_configs&quot;: [
618 # {
619 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
620 # &quot;exempted_members&quot;: [
621 # &quot;user:[email protected]&quot;
622 # ]
623 # },
624 # {
625 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
626 # },
627 # {
628 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
629 # }
630 # ]
631 # },
632 # {
633 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
634 # &quot;audit_log_configs&quot;: [
635 # {
636 # &quot;log_type&quot;: &quot;DATA_READ&quot;
637 # },
638 # {
639 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
640 # &quot;exempted_members&quot;: [
641 # &quot;user:[email protected]&quot;
642 # ]
643 # }
644 # ]
645 # }
646 # ]
647 # }
648 #
649 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
650 # logging. It also exempts `[email protected]` from DATA_READ logging, and
651 # `[email protected]` from DATA_WRITE logging.
652 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
653 { # Provides the configuration for logging a type of permissions.
654 # Example:
655 #
656 # {
657 # &quot;audit_log_configs&quot;: [
658 # {
659 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
660 # &quot;exempted_members&quot;: [
661 # &quot;user:[email protected]&quot;
662 # ]
663 # },
664 # {
665 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
666 # }
667 # ]
668 # }
669 #
670 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
671 # [email protected] from DATA_READ logging.
672 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
673 # permission.
674 # Follows the same format of Binding.members.
675 &quot;A String&quot;,
676 ],
677 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
678 },
679 ],
680 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
681 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
682 # `allServices` is a special value that covers all services.
683 },
684 ],
685 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
686 # may specify a `condition` that determines how and when the `bindings` are
687 # applied. Each of the `bindings` must contain at least one principal.
688 #
689 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
690 # of these principals can be Google groups. Each occurrence of a principal
691 # counts towards these limits. For example, if the `bindings` grant 50
692 # different roles to `user:[email protected]`, and not to any other
693 # principal, then you can add another 1,450 principals to the `bindings` in
694 # the `Policy`.
695 { # Associates `members`, or principals, with a `role`.
696 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
697 #
698 # If the condition evaluates to `true`, then this binding applies to the
699 # current request.
700 #
701 # If the condition evaluates to `false`, then this binding does not apply to
702 # the current request. However, a different role binding might grant the same
703 # role to one or more of the principals in this binding.
704 #
705 # To learn which resources support conditions in their IAM policies, see the
706 # [IAM
707 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
708 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
709 # are documented at https://github.com/google/cel-spec.
710 #
711 # Example (Comparison):
712 #
713 # title: &quot;Summary size limit&quot;
714 # description: &quot;Determines if a summary is less than 100 chars&quot;
715 # expression: &quot;document.summary.size() &lt; 100&quot;
716 #
717 # Example (Equality):
718 #
719 # title: &quot;Requestor is owner&quot;
720 # description: &quot;Determines if requestor is the document owner&quot;
721 # expression: &quot;document.owner == request.auth.claims.email&quot;
722 #
723 # Example (Logic):
724 #
725 # title: &quot;Public documents&quot;
726 # description: &quot;Determine whether the document should be publicly visible&quot;
727 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
728 #
729 # Example (Data Manipulation):
730 #
731 # title: &quot;Notification string&quot;
732 # description: &quot;Create a notification string with a timestamp.&quot;
733 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
734 #
735 # The exact variables and functions that may be referenced within an expression
736 # are determined by the service that evaluates it. See the service
737 # documentation for additional information.
738 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
739 # describes the expression, e.g. when hovered over it in a UI.
740 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
741 # syntax.
742 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
743 # reporting, e.g. a file name and a position in the file.
744 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
745 # its purpose. This can be used e.g. in UIs which allow to enter the
746 # expression.
747 },
748 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
749 # `members` can have the following values:
750 #
751 # * `allUsers`: A special identifier that represents anyone who is
752 # on the internet; with or without a Google account.
753 #
754 # * `allAuthenticatedUsers`: A special identifier that represents anyone
755 # who is authenticated with a Google account or a service account.
756 # Does not include identities that come from external identity providers
757 # (IdPs) through identity federation.
758 #
759 # * `user:{emailid}`: An email address that represents a specific Google
760 # account. For example, `[email protected]` .
761 #
762 #
763 # * `serviceAccount:{emailid}`: An email address that represents a Google
764 # service account. For example,
765 # `[email protected]`.
766 #
767 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
768 # identifier for a
769 # [Kubernetes service
770 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
771 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
772 #
773 # * `group:{emailid}`: An email address that represents a Google group.
774 # For example, `[email protected]`.
775 #
776 #
777 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
778 # users of that domain. For example, `google.com` or `example.com`.
779 #
780 #
781 #
782 #
783 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
784 # A single identity in a workforce identity pool.
785 #
786 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
787 # All workforce identities in a group.
788 #
789 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
790 # All workforce identities with a specific attribute value.
791 #
792 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
793 # All identities in a workforce identity pool.
794 #
795 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
796 # A single identity in a workload identity pool.
797 #
798 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
799 # A workload identity pool group.
800 #
801 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
802 # All identities in a workload identity pool with a certain attribute.
803 #
804 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
805 # All identities in a workload identity pool.
806 #
807 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
808 # identifier) representing a user that has been recently deleted. For
809 # example, `[email protected]?uid=123456789012345678901`. If the user is
810 # recovered, this value reverts to `user:{emailid}` and the recovered user
811 # retains the role in the binding.
812 #
813 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
814 # unique identifier) representing a service account that has been recently
815 # deleted. For example,
816 # `[email protected]?uid=123456789012345678901`.
817 # If the service account is undeleted, this value reverts to
818 # `serviceAccount:{emailid}` and the undeleted service account retains the
819 # role in the binding.
820 #
821 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
822 # identifier) representing a Google group that has been recently
823 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
824 # the group is recovered, this value reverts to `group:{emailid}` and the
825 # recovered group retains the role in the binding.
826 #
827 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
828 # Deleted single identity in a workforce identity pool. For example,
829 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
830 &quot;A String&quot;,
831 ],
832 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
833 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
834 #
835 # For an overview of the IAM roles and permissions, see the
836 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
837 # a list of the available pre-defined roles, see
838 # [here](https://cloud.google.com/iam/docs/understanding-roles).
839 },
840 ],
841 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
842 # prevent simultaneous updates of a policy from overwriting each other.
843 # It is strongly suggested that systems make use of the `etag` in the
844 # read-modify-write cycle to perform policy updates in order to avoid race
845 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
846 # systems are expected to put that etag in the request to `setIamPolicy` to
847 # ensure that their change will be applied to the same version of the policy.
848 #
849 # **Important:** If you use IAM Conditions, you must include the `etag` field
850 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
851 # you to overwrite a version `3` policy with a version `1` policy, and all of
852 # the conditions in the version `3` policy are lost.
853 &quot;version&quot;: 42, # Specifies the format of the policy.
854 #
855 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
856 # are rejected.
857 #
858 # Any operation that affects conditional role bindings must specify version
859 # `3`. This requirement applies to the following operations:
860 #
861 # * Getting a policy that includes a conditional role binding
862 # * Adding a conditional role binding to a policy
863 # * Changing a conditional role binding in a policy
864 # * Removing any role binding, with or without a condition, from a policy
865 # that includes conditions
866 #
867 # **Important:** If you use IAM Conditions, you must include the `etag` field
868 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
869 # you to overwrite a version `3` policy with a version `1` policy, and all of
870 # the conditions in the version `3` policy are lost.
871 #
872 # If a policy does not include any conditions, operations on that policy may
873 # specify any valid version or leave the field unset.
874 #
875 # To learn which resources support conditions in their IAM policies, see the
876 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
877 }</pre>
878 </div>
879
880 <div class="method">
881 <code class="details" id="insert">insert(project, body=None, requestId=None, x__xgafv=None)</code>
882 <pre>Create a License resource in the specified project.
883 *Caution* This resource is intended
884 for use only by third-party partners who are creatingCloud Marketplace
885 images.
886
887 Args:
888 project: string, Project ID for this request. (required)
889 body: object, The request body.
890 The object takes the form of:
891
892 { # Represents a License resource.
893 #
894 # A License represents billing and aggregate usage data forpublic andmarketplace images.
895 # *Caution* This resource is intended for
896 # use only by third-party partners who are creatingCloud Marketplace
897 # images.
898 &quot;allowedReplacementLicenses&quot;: [ # Specifies licenseCodes of licenses that can replace this license. Note:
899 # such replacements are allowed even if removable_from_disk is false.
900 &quot;A String&quot;,
901 ],
902 &quot;appendableToDisk&quot;: True or False, # If true, this license can be appended to an existing disk&#x27;s set of
903 # licenses.
904 &quot;chargesUseFee&quot;: True or False, # [Output Only] Deprecated. This field no longer reflects whether a license
905 # charges a usage fee.
906 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
907 # text format.
908 &quot;description&quot;: &quot;A String&quot;, # An optional textual description of the resource; provided by the client
909 # when the resource is created.
910 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
911 # defined by the server.
912 &quot;incompatibleLicenses&quot;: [ # Specifies licenseCodes of licenses that are incompatible with this license.
913 # If a license is incompatible with this license, it cannot be attached to
914 # the same disk or image.
915 &quot;A String&quot;,
916 ],
917 &quot;kind&quot;: &quot;compute#license&quot;, # Output only. [Output Only] Type of resource. Always compute#license for
918 # licenses.
919 &quot;licenseCode&quot;: &quot;A String&quot;, # [Output Only] The unique code used to attach this license to images,
920 # snapshots, and disks.
921 &quot;minimumRetention&quot;: { # A Duration represents a fixed-length span of time represented # If set, this license will be unable to be removed or replaced once attached
922 # to a disk until the minimum_retention period has passed.
923 # as a count of seconds and fractions of seconds at nanosecond
924 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
925 # or &quot;month&quot;. Range is approximately 10,000 years.
926 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
927 # Durations less than one second are represented with a 0
928 # `seconds` field and a positive `nanos` field. Must be from 0
929 # to 999,999,999 inclusive.
930 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
931 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
932 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
933 },
934 &quot;multiTenantOnly&quot;: True or False, # If true, this license can only be used on VMs on multi tenant nodes.
935 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. The name must be 1-63 characters long and
936 # comply withRFC1035.
937 &quot;osLicense&quot;: True or False, # If true, indicates this is an OS license. Only one OS license can be
938 # attached to a disk or image at a time.
939 &quot;params&quot;: { # Additional license params. # Input only. Additional params passed with the request, but not persisted
940 # as part of resource payload.
941 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the license. Tag keys and values
942 # have the same definition as resource
943 # manager tags. Keys and values can be either in numeric format,
944 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
945 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
946 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
947 # PATCH) when empty.
948 &quot;a_key&quot;: &quot;A String&quot;,
949 },
950 },
951 &quot;removableFromDisk&quot;: True or False, # If true, this license can be removed from a disk&#x27;s set of licenses, with no
952 # replacement license needed.
953 &quot;requiredCoattachedLicenses&quot;: [ # Specifies the set of permissible coattached licenseCodes of licenses that
954 # satisfy the coattachment requirement of this license. At least one license
955 # from the set must be attached to the same disk or image as this license.
956 &quot;A String&quot;,
957 ],
958 &quot;resourceRequirements&quot;: { # [Input Only] Deprecated.
959 &quot;minGuestCpuCount&quot;: 42, # [Input Only] Deprecated. This field no longer reflects the minimum number
960 # of guest cpus required to use the Instance.
961 &quot;minMemoryMb&quot;: 42, # [Input Only] Deprecated. This field no longer reflects the minimum memory
962 # required to use the Instance.
963 },
964 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
965 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
966 &quot;soleTenantOnly&quot;: True or False, # If true, this license can only be used on VMs on sole tenant nodes.
967 &quot;transferable&quot;: True or False, # If false, licenses will not be copied from the source resource when
968 # creating an image from a disk, disk from snapshot, or snapshot from disk.
969 &quot;updateTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last update timestamp inRFC3339
970 # text format.
971 }
972
973 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
974 that if you must retry your request, the server will know to ignore the
975 request if it has already been completed.
976
977 For example, consider a situation where you make an initial request and
978 the request times out. If you make the request again with the same
979 request ID, the server can check if original operation with the same
980 request ID was received, and if so, will ignore the second request. This
981 prevents clients from accidentally creating duplicate commitments.
982
983 The request ID must be
984 a valid UUID with the exception that zero UUID is not supported
985 (00000000-0000-0000-0000-000000000000).
986 x__xgafv: string, V1 error format.
987 Allowed values
988 1 - v1 error format
989 2 - v2 error format
990
991 Returns:
992 An object of the form:
993
994 { # Represents an Operation resource.
995 #
996 # Google Compute Engine has three Operation resources:
997 #
998 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
999 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
1000 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
1001 #
1002 # You can use an operation resource to manage asynchronous API requests.
1003 # For more information, readHandling
1004 # API responses.
1005 #
1006 # Operations can be global, regional or zonal.
1007 #
1008 # - For global operations, use the `globalOperations`
1009 # resource.
1010 # - For regional operations, use the
1011 # `regionOperations` resource.
1012 # - For zonal operations, use
1013 # the `zoneOperations` resource.
1014 #
1015 #
1016 #
1017 # For more information, read
1018 # Global, Regional, and Zonal Resources.
1019 #
1020 # Note that completed Operation resources have a limited
1021 # retention period.
1022 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1023 # Not present otherwise.
1024 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1025 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1026 # set when the operation is created.
1027 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1028 # text format.
1029 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1030 # this field will be populated.
1031 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1032 # operation.
1033 {
1034 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1035 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1036 # details. There is a set of defined message types to use for providing
1037 # details.The syntax depends on the error code. For example,
1038 # QuotaExceededInfo will have details when the error code is
1039 # QUOTA_EXCEEDED.
1040 {
1041 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1042 #
1043 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1044 # is not enabled:
1045 #
1046 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1047 # &quot;domain&quot;: &quot;googleapis.com&quot;
1048 # &quot;metadata&quot;: {
1049 # &quot;resource&quot;: &quot;projects/123&quot;,
1050 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1051 # }
1052 # }
1053 #
1054 # This response indicates that the pubsub.googleapis.com API is not enabled.
1055 #
1056 # Example of an error that is returned when attempting to create a Spanner
1057 # instance in a region that is out of stock:
1058 #
1059 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1060 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1061 # &quot;metadata&quot;: {
1062 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1063 # }
1064 # }
1065 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1066 # is typically the registered service name of the tool or product that
1067 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1068 # generated by some common infrastructure, the error domain must be a
1069 # globally unique value that identifies the infrastructure. For Google API
1070 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1071 &quot;metadatas&quot;: { # Additional structured details about this error.
1072 #
1073 # Keys must match a regular expression of `a-z+` but should
1074 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1075 # length. When identifying the current value of an exceeded limit, the units
1076 # should be contained in the key, not the value. For example, rather than
1077 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1078 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1079 # instances that can be created in a single (batch) request.
1080 &quot;a_key&quot;: &quot;A String&quot;,
1081 },
1082 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1083 # proximate cause of the error. Error reasons are unique within a particular
1084 # domain of errors. This should be at most 63 characters and match a
1085 # regular expression of `A-Z+[A-Z0-9]`, which represents
1086 # UPPER_SNAKE_CASE.
1087 },
1088 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1089 #
1090 # For example, if a quota check failed with an error indicating the calling
1091 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1092 # directly to the right place in the developer console to flip the bit.
1093 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1094 { # Describes a URL link.
1095 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1096 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1097 },
1098 ],
1099 },
1100 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1101 # which can be attached to an RPC error.
1102 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1103 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1104 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1105 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1106 },
1107 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1108 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1109 &quot;a_key&quot;: &quot;A String&quot;,
1110 },
1111 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1112 # type or metric.
1113 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1114 # or metric.
1115 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1116 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1117 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1118 },
1119 },
1120 ],
1121 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1122 # This property is optional.
1123 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1124 },
1125 ],
1126 },
1127 &quot;getVersionOperationMetadata&quot;: {
1128 &quot;inlineSbomInfo&quot;: {
1129 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1130 # appropriate identifiers.
1131 &quot;a_key&quot;: &quot;A String&quot;,
1132 },
1133 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1134 # identifiers.
1135 &quot;a_key&quot;: &quot;A String&quot;,
1136 },
1137 },
1138 },
1139 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1140 # message that was returned, such as `NOT FOUND`.
1141 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1142 # status code that was returned. For example, a `404` means the
1143 # resource was not found.
1144 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1145 # defined by the server.
1146 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1147 # This value is inRFC3339
1148 # text format.
1149 &quot;instancesBulkInsertOperationMetadata&quot;: {
1150 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1151 # Example key: zones/us-central1-a
1152 &quot;a_key&quot;: {
1153 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1154 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1155 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1156 # error.
1157 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1158 # if the flow is rolling forward or rolling back.
1159 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1160 },
1161 },
1162 },
1163 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1164 # Operation resources.
1165 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1166 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1167 # group of operations results from a `bulkInsert` API request.
1168 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1169 # `update`, or `delete`, and so on.
1170 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1171 # There is no requirement that this be linear or support any granularity of
1172 # operations. This should not be used to guess when the operation will be
1173 # complete. This number should monotonically increase as the operation
1174 # progresses.
1175 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1176 # applicable when performing regional operations.
1177 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1178 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
1179 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1180 # this field will contain information on all underlying zonal actions and
1181 # their state.
1182 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1183 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1184 # Example key: zones/us-central1-a
1185 &quot;a_key&quot;: {
1186 &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
1187 # populated.
1188 # different programming environments, including REST APIs and RPC APIs. It is
1189 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1190 # three pieces of data: error code, error message, and error details.
1191 #
1192 # You can find out more about this error model and how to work with it in the
1193 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1194 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1195 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1196 # message types for APIs to use.
1197 {
1198 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1199 },
1200 ],
1201 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1202 # user-facing error message should be localized and sent in the
1203 # google.rpc.Status.details field, or localized by the client.
1204 },
1205 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1206 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1207 },
1208 },
1209 },
1210 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1211 # This value is inRFC3339
1212 # text format.
1213 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1214 # following:
1215 # `PENDING`, `RUNNING`, or `DONE`.
1216 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1217 # operation.
1218 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1219 # of the target resource.
1220 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1221 # operations related to creating a snapshot, this points to the disk
1222 # that the snapshot was created from.
1223 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1224 # `[email protected]` or
1225 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1226 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1227 # operation, this field will be populated.
1228 {
1229 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1230 # Engine returns NO_RESULTS_ON_PAGE if there
1231 # are no results in the response.
1232 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1233 # value format. For example:
1234 #
1235 # &quot;data&quot;: [
1236 # {
1237 # &quot;key&quot;: &quot;scope&quot;,
1238 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1239 # }
1240 {
1241 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1242 # returned. For example, for warnings where there are no results in a list
1243 # request for a particular zone, this key might be scope and
1244 # the key value might be the zone name. Other examples might be a key
1245 # indicating a deprecated resource and a suggested replacement, or a
1246 # warning about invalid network settings (for example, if an instance
1247 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1248 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1249 },
1250 ],
1251 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1252 },
1253 ],
1254 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1255 # applicable when performing per-zone operations.
1256 }</pre>
1257 </div>
1258
1259 <div class="method">
1260 <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
1261 <pre>Retrieves the list of licenses
1262 available in the specified project. This method does not
1263 get any licenses that belong to other projects, including licenses attached
1264 to publicly-available images, like Debian 9. If you want to get a list of
1265 publicly-available licenses, use this method to make a request to the
1266 respective image project, such as debian-cloud orwindows-cloud.
1267 *Caution* This resource is intended
1268 for use only by third-party partners who are creatingCloud Marketplace
1269 images.
1270
1271 Args:
1272 project: string, Project ID for this request. (required)
1273 filter: string, A filter expression that filters resources listed in the response. Most
1274 Compute resources support two types of filter expressions:
1275 expressions that support regular expressions and expressions that follow
1276 API improvement proposal AIP-160.
1277 These two types of filter expressions cannot be mixed in one request.
1278
1279 If you want to use AIP-160, your expression must specify the field name, an
1280 operator, and the value that you want to use for filtering. The value
1281 must be a string, a number, or a boolean. The operator
1282 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
1283
1284 For example, if you are filtering Compute Engine instances, you can
1285 exclude instances named `example-instance` by specifying
1286 `name != example-instance`.
1287
1288 The `:*` comparison can be used to test whether a key has been defined.
1289 For example, to find all objects with `owner` label use:
1290 ```
1291 labels.owner:*
1292 ```
1293
1294 You can also filter nested fields. For example, you could specify
1295 `scheduling.automaticRestart = false` to include instances only
1296 if they are not scheduled for automatic restarts. You can use filtering
1297 on nested fields to filter based onresource labels.
1298
1299 To filter on multiple expressions, provide each separate expression within
1300 parentheses. For example:
1301 ```
1302 (scheduling.automaticRestart = true)
1303 (cpuPlatform = &quot;Intel Skylake&quot;)
1304 ```
1305 By default, each expression is an `AND` expression. However, you
1306 can include `AND` and `OR` expressions explicitly.
1307 For example:
1308 ```
1309 (cpuPlatform = &quot;Intel Skylake&quot;) OR
1310 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
1311 (scheduling.automaticRestart = true)
1312 ```
1313
1314 If you want to use a regular expression, use the `eq` (equal) or `ne`
1315 (not equal) operator against a single un-parenthesized expression with or
1316 without quotes or against multiple parenthesized expressions. Examples:
1317
1318 `fieldname eq unquoted literal`
1319 `fieldname eq &#x27;single quoted literal&#x27;`
1320 `fieldname eq &quot;double quoted literal&quot;`
1321 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
1322
1323 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
1324 The literal value must match the entire field.
1325
1326 For example, to filter for instances that do not end with name &quot;instance&quot;,
1327 you would use `name ne .*instance`.
1328
1329 You cannot combine constraints on multiple fields using regular
1330 expressions.
1331 maxResults: integer, The maximum number of results per page that should be returned.
1332 If the number of available results is larger than `maxResults`,
1333 Compute Engine returns a `nextPageToken` that can be used to get
1334 the next page of results in subsequent list requests. Acceptable values are
1335 `0` to `500`, inclusive. (Default: `500`)
1336 orderBy: string, Sorts list results by a certain order. By default, results
1337 are returned in alphanumerical order based on the resource name.
1338
1339 You can also sort results in descending order based on the creation
1340 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
1341 results based on the `creationTimestamp` field in
1342 reverse chronological order (newest result first). Use this to sort
1343 resources like operations so that the newest operation is returned first.
1344
1345 Currently, only sorting by `name` or
1346 `creationTimestamp desc` is supported.
1347 pageToken: string, Specifies a page token to use. Set `pageToken` to the
1348 `nextPageToken` returned by a previous list request to get
1349 the next page of results.
1350 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
1351 of failure. The default value is false.
1352
1353 For example, when partial success behavior is enabled, aggregatedList for a
1354 single zone scope either returns all resources in the zone or no resources,
1355 with an error code.
1356 x__xgafv: string, V1 error format.
1357 Allowed values
1358 1 - v1 error format
1359 2 - v2 error format
1360
1361 Returns:
1362 An object of the form:
1363
1364 {
1365 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
1366 &quot;items&quot;: [ # A list of License resources.
1367 { # Represents a License resource.
1368 #
1369 # A License represents billing and aggregate usage data forpublic andmarketplace images.
1370 # *Caution* This resource is intended for
1371 # use only by third-party partners who are creatingCloud Marketplace
1372 # images.
1373 &quot;allowedReplacementLicenses&quot;: [ # Specifies licenseCodes of licenses that can replace this license. Note:
1374 # such replacements are allowed even if removable_from_disk is false.
1375 &quot;A String&quot;,
1376 ],
1377 &quot;appendableToDisk&quot;: True or False, # If true, this license can be appended to an existing disk&#x27;s set of
1378 # licenses.
1379 &quot;chargesUseFee&quot;: True or False, # [Output Only] Deprecated. This field no longer reflects whether a license
1380 # charges a usage fee.
1381 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1382 # text format.
1383 &quot;description&quot;: &quot;A String&quot;, # An optional textual description of the resource; provided by the client
1384 # when the resource is created.
1385 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
1386 # defined by the server.
1387 &quot;incompatibleLicenses&quot;: [ # Specifies licenseCodes of licenses that are incompatible with this license.
1388 # If a license is incompatible with this license, it cannot be attached to
1389 # the same disk or image.
1390 &quot;A String&quot;,
1391 ],
1392 &quot;kind&quot;: &quot;compute#license&quot;, # Output only. [Output Only] Type of resource. Always compute#license for
1393 # licenses.
1394 &quot;licenseCode&quot;: &quot;A String&quot;, # [Output Only] The unique code used to attach this license to images,
1395 # snapshots, and disks.
1396 &quot;minimumRetention&quot;: { # A Duration represents a fixed-length span of time represented # If set, this license will be unable to be removed or replaced once attached
1397 # to a disk until the minimum_retention period has passed.
1398 # as a count of seconds and fractions of seconds at nanosecond
1399 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
1400 # or &quot;month&quot;. Range is approximately 10,000 years.
1401 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
1402 # Durations less than one second are represented with a 0
1403 # `seconds` field and a positive `nanos` field. Must be from 0
1404 # to 999,999,999 inclusive.
1405 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
1406 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
1407 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
1408 },
1409 &quot;multiTenantOnly&quot;: True or False, # If true, this license can only be used on VMs on multi tenant nodes.
1410 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. The name must be 1-63 characters long and
1411 # comply withRFC1035.
1412 &quot;osLicense&quot;: True or False, # If true, indicates this is an OS license. Only one OS license can be
1413 # attached to a disk or image at a time.
1414 &quot;params&quot;: { # Additional license params. # Input only. Additional params passed with the request, but not persisted
1415 # as part of resource payload.
1416 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the license. Tag keys and values
1417 # have the same definition as resource
1418 # manager tags. Keys and values can be either in numeric format,
1419 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
1420 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
1421 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
1422 # PATCH) when empty.
1423 &quot;a_key&quot;: &quot;A String&quot;,
1424 },
1425 },
1426 &quot;removableFromDisk&quot;: True or False, # If true, this license can be removed from a disk&#x27;s set of licenses, with no
1427 # replacement license needed.
1428 &quot;requiredCoattachedLicenses&quot;: [ # Specifies the set of permissible coattached licenseCodes of licenses that
1429 # satisfy the coattachment requirement of this license. At least one license
1430 # from the set must be attached to the same disk or image as this license.
1431 &quot;A String&quot;,
1432 ],
1433 &quot;resourceRequirements&quot;: { # [Input Only] Deprecated.
1434 &quot;minGuestCpuCount&quot;: 42, # [Input Only] Deprecated. This field no longer reflects the minimum number
1435 # of guest cpus required to use the Instance.
1436 &quot;minMemoryMb&quot;: 42, # [Input Only] Deprecated. This field no longer reflects the minimum memory
1437 # required to use the Instance.
1438 },
1439 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
1440 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
1441 &quot;soleTenantOnly&quot;: True or False, # If true, this license can only be used on VMs on sole tenant nodes.
1442 &quot;transferable&quot;: True or False, # If false, licenses will not be copied from the source resource when
1443 # creating an image from a disk, disk from snapshot, or snapshot from disk.
1444 &quot;updateTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last update timestamp inRFC3339
1445 # text format.
1446 },
1447 ],
1448 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
1449 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
1450 # the query parameter pageToken in the next list request.
1451 # Subsequent list requests will have their own nextPageToken to
1452 # continue paging through the results.
1453 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
1454 &quot;warning&quot;: { # [Output Only] Informational warning message.
1455 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1456 # Engine returns NO_RESULTS_ON_PAGE if there
1457 # are no results in the response.
1458 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1459 # value format. For example:
1460 #
1461 # &quot;data&quot;: [
1462 # {
1463 # &quot;key&quot;: &quot;scope&quot;,
1464 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1465 # }
1466 {
1467 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1468 # returned. For example, for warnings where there are no results in a list
1469 # request for a particular zone, this key might be scope and
1470 # the key value might be the zone name. Other examples might be a key
1471 # indicating a deprecated resource and a suggested replacement, or a
1472 # warning about invalid network settings (for example, if an instance
1473 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1474 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1475 },
1476 ],
1477 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1478 },
1479 }</pre>
1480 </div>
1481
1482 <div class="method">
1483 <code class="details" id="list_next">list_next()</code>
1484 <pre>Retrieves the next page of results.
1485
1486 Args:
1487 previous_request: The request for the previous page. (required)
1488 previous_response: The response from the request for the previous page. (required)
1489
1490 Returns:
1491 A request object that you can call &#x27;execute()&#x27; on to request the next
1492 page. Returns None if there are no more items in the collection.
1493 </pre>
1494 </div>
1495
1496 <div class="method">
1497 <code class="details" id="setIamPolicy">setIamPolicy(project, resource, body=None, x__xgafv=None)</code>
1498 <pre>Sets the access control policy on the specified resource.
1499 Replaces any existing policy.
1500 *Caution* This resource is intended
1501 for use only by third-party partners who are creatingCloud Marketplace
1502 images.
1503
1504 Args:
1505 project: string, Project ID for this request. (required)
1506 resource: string, Name or id of the resource for this request. (required)
1507 body: object, The request body.
1508 The object takes the form of:
1509
1510 {
1511 &quot;bindings&quot;: [ # Flatten Policy to create a backward compatible wire-format.
1512 # Deprecated. Use &#x27;policy&#x27; to specify bindings.
1513 { # Associates `members`, or principals, with a `role`.
1514 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
1515 #
1516 # If the condition evaluates to `true`, then this binding applies to the
1517 # current request.
1518 #
1519 # If the condition evaluates to `false`, then this binding does not apply to
1520 # the current request. However, a different role binding might grant the same
1521 # role to one or more of the principals in this binding.
1522 #
1523 # To learn which resources support conditions in their IAM policies, see the
1524 # [IAM
1525 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
1526 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
1527 # are documented at https://github.com/google/cel-spec.
1528 #
1529 # Example (Comparison):
1530 #
1531 # title: &quot;Summary size limit&quot;
1532 # description: &quot;Determines if a summary is less than 100 chars&quot;
1533 # expression: &quot;document.summary.size() &lt; 100&quot;
1534 #
1535 # Example (Equality):
1536 #
1537 # title: &quot;Requestor is owner&quot;
1538 # description: &quot;Determines if requestor is the document owner&quot;
1539 # expression: &quot;document.owner == request.auth.claims.email&quot;
1540 #
1541 # Example (Logic):
1542 #
1543 # title: &quot;Public documents&quot;
1544 # description: &quot;Determine whether the document should be publicly visible&quot;
1545 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
1546 #
1547 # Example (Data Manipulation):
1548 #
1549 # title: &quot;Notification string&quot;
1550 # description: &quot;Create a notification string with a timestamp.&quot;
1551 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
1552 #
1553 # The exact variables and functions that may be referenced within an expression
1554 # are determined by the service that evaluates it. See the service
1555 # documentation for additional information.
1556 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
1557 # describes the expression, e.g. when hovered over it in a UI.
1558 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
1559 # syntax.
1560 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
1561 # reporting, e.g. a file name and a position in the file.
1562 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
1563 # its purpose. This can be used e.g. in UIs which allow to enter the
1564 # expression.
1565 },
1566 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
1567 # `members` can have the following values:
1568 #
1569 # * `allUsers`: A special identifier that represents anyone who is
1570 # on the internet; with or without a Google account.
1571 #
1572 # * `allAuthenticatedUsers`: A special identifier that represents anyone
1573 # who is authenticated with a Google account or a service account.
1574 # Does not include identities that come from external identity providers
1575 # (IdPs) through identity federation.
1576 #
1577 # * `user:{emailid}`: An email address that represents a specific Google
1578 # account. For example, `[email protected]` .
1579 #
1580 #
1581 # * `serviceAccount:{emailid}`: An email address that represents a Google
1582 # service account. For example,
1583 # `[email protected]`.
1584 #
1585 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
1586 # identifier for a
1587 # [Kubernetes service
1588 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
1589 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
1590 #
1591 # * `group:{emailid}`: An email address that represents a Google group.
1592 # For example, `[email protected]`.
1593 #
1594 #
1595 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
1596 # users of that domain. For example, `google.com` or `example.com`.
1597 #
1598 #
1599 #
1600 #
1601 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
1602 # A single identity in a workforce identity pool.
1603 #
1604 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
1605 # All workforce identities in a group.
1606 #
1607 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
1608 # All workforce identities with a specific attribute value.
1609 #
1610 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
1611 # All identities in a workforce identity pool.
1612 #
1613 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
1614 # A single identity in a workload identity pool.
1615 #
1616 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
1617 # A workload identity pool group.
1618 #
1619 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
1620 # All identities in a workload identity pool with a certain attribute.
1621 #
1622 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
1623 # All identities in a workload identity pool.
1624 #
1625 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
1626 # identifier) representing a user that has been recently deleted. For
1627 # example, `[email protected]?uid=123456789012345678901`. If the user is
1628 # recovered, this value reverts to `user:{emailid}` and the recovered user
1629 # retains the role in the binding.
1630 #
1631 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
1632 # unique identifier) representing a service account that has been recently
1633 # deleted. For example,
1634 # `[email protected]?uid=123456789012345678901`.
1635 # If the service account is undeleted, this value reverts to
1636 # `serviceAccount:{emailid}` and the undeleted service account retains the
1637 # role in the binding.
1638 #
1639 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
1640 # identifier) representing a Google group that has been recently
1641 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
1642 # the group is recovered, this value reverts to `group:{emailid}` and the
1643 # recovered group retains the role in the binding.
1644 #
1645 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
1646 # Deleted single identity in a workforce identity pool. For example,
1647 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
1648 &quot;A String&quot;,
1649 ],
1650 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
1651 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
1652 #
1653 # For an overview of the IAM roles and permissions, see the
1654 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
1655 # a list of the available pre-defined roles, see
1656 # [here](https://cloud.google.com/iam/docs/understanding-roles).
1657 },
1658 ],
1659 &quot;etag&quot;: &quot;A String&quot;, # Flatten Policy to create a backward compatible wire-format.
1660 # Deprecated. Use &#x27;policy&#x27; to specify the etag.
1661 &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
1662 # the policy is limited to a few 10s of KB. An empty policy is in general a
1663 # valid policy but certain services (like Projects) might reject them.
1664 # controls for Google Cloud resources.
1665 #
1666 #
1667 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
1668 # `members`, or principals, to a single `role`. Principals can be user
1669 # accounts, service accounts, Google groups, and domains (such as G Suite). A
1670 # `role` is a named list of permissions; each `role` can be an IAM predefined
1671 # role or a user-created custom role.
1672 #
1673 # For some types of Google Cloud resources, a `binding` can also specify a
1674 # `condition`, which is a logical expression that allows access to a resource
1675 # only if the expression evaluates to `true`. A condition can add constraints
1676 # based on attributes of the request, the resource, or both. To learn which
1677 # resources support conditions in their IAM policies, see the
1678 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
1679 #
1680 # **JSON example:**
1681 #
1682 # ```
1683 # {
1684 # &quot;bindings&quot;: [
1685 # {
1686 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
1687 # &quot;members&quot;: [
1688 # &quot;user:[email protected]&quot;,
1689 # &quot;group:[email protected]&quot;,
1690 # &quot;domain:google.com&quot;,
1691 # &quot;serviceAccount:[email protected]&quot;
1692 # ]
1693 # },
1694 # {
1695 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
1696 # &quot;members&quot;: [
1697 # &quot;user:[email protected]&quot;
1698 # ],
1699 # &quot;condition&quot;: {
1700 # &quot;title&quot;: &quot;expirable access&quot;,
1701 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
1702 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
1703 # }
1704 # }
1705 # ],
1706 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
1707 # &quot;version&quot;: 3
1708 # }
1709 # ```
1710 #
1711 # **YAML example:**
1712 #
1713 # ```
1714 # bindings:
1715 # - members:
1716 # - user:[email protected]
1717 # - group:[email protected]
1718 # - domain:google.com
1719 # - serviceAccount:[email protected]
1720 # role: roles/resourcemanager.organizationAdmin
1721 # - members:
1722 # - user:[email protected]
1723 # role: roles/resourcemanager.organizationViewer
1724 # condition:
1725 # title: expirable access
1726 # description: Does not grant access after Sep 2020
1727 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
1728 # etag: BwWWja0YfJA=
1729 # version: 3
1730 # ```
1731 #
1732 # For a description of IAM and its features, see the
1733 # [IAM documentation](https://cloud.google.com/iam/docs/).
1734 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
1735 { # Specifies the audit configuration for a service.
1736 # The configuration determines which permission types are logged, and what
1737 # identities, if any, are exempted from logging.
1738 # An AuditConfig must have one or more AuditLogConfigs.
1739 #
1740 # If there are AuditConfigs for both `allServices` and a specific service,
1741 # the union of the two AuditConfigs is used for that service: the log_types
1742 # specified in each AuditConfig are enabled, and the exempted_members in each
1743 # AuditLogConfig are exempted.
1744 #
1745 # Example Policy with multiple AuditConfigs:
1746 #
1747 # {
1748 # &quot;audit_configs&quot;: [
1749 # {
1750 # &quot;service&quot;: &quot;allServices&quot;,
1751 # &quot;audit_log_configs&quot;: [
1752 # {
1753 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
1754 # &quot;exempted_members&quot;: [
1755 # &quot;user:[email protected]&quot;
1756 # ]
1757 # },
1758 # {
1759 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
1760 # },
1761 # {
1762 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
1763 # }
1764 # ]
1765 # },
1766 # {
1767 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
1768 # &quot;audit_log_configs&quot;: [
1769 # {
1770 # &quot;log_type&quot;: &quot;DATA_READ&quot;
1771 # },
1772 # {
1773 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
1774 # &quot;exempted_members&quot;: [
1775 # &quot;user:[email protected]&quot;
1776 # ]
1777 # }
1778 # ]
1779 # }
1780 # ]
1781 # }
1782 #
1783 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
1784 # logging. It also exempts `[email protected]` from DATA_READ logging, and
1785 # `[email protected]` from DATA_WRITE logging.
1786 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
1787 { # Provides the configuration for logging a type of permissions.
1788 # Example:
1789 #
1790 # {
1791 # &quot;audit_log_configs&quot;: [
1792 # {
1793 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
1794 # &quot;exempted_members&quot;: [
1795 # &quot;user:[email protected]&quot;
1796 # ]
1797 # },
1798 # {
1799 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
1800 # }
1801 # ]
1802 # }
1803 #
1804 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
1805 # [email protected] from DATA_READ logging.
1806 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
1807 # permission.
1808 # Follows the same format of Binding.members.
1809 &quot;A String&quot;,
1810 ],
1811 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
1812 },
1813 ],
1814 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
1815 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
1816 # `allServices` is a special value that covers all services.
1817 },
1818 ],
1819 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
1820 # may specify a `condition` that determines how and when the `bindings` are
1821 # applied. Each of the `bindings` must contain at least one principal.
1822 #
1823 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
1824 # of these principals can be Google groups. Each occurrence of a principal
1825 # counts towards these limits. For example, if the `bindings` grant 50
1826 # different roles to `user:[email protected]`, and not to any other
1827 # principal, then you can add another 1,450 principals to the `bindings` in
1828 # the `Policy`.
1829 { # Associates `members`, or principals, with a `role`.
1830 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
1831 #
1832 # If the condition evaluates to `true`, then this binding applies to the
1833 # current request.
1834 #
1835 # If the condition evaluates to `false`, then this binding does not apply to
1836 # the current request. However, a different role binding might grant the same
1837 # role to one or more of the principals in this binding.
1838 #
1839 # To learn which resources support conditions in their IAM policies, see the
1840 # [IAM
1841 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
1842 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
1843 # are documented at https://github.com/google/cel-spec.
1844 #
1845 # Example (Comparison):
1846 #
1847 # title: &quot;Summary size limit&quot;
1848 # description: &quot;Determines if a summary is less than 100 chars&quot;
1849 # expression: &quot;document.summary.size() &lt; 100&quot;
1850 #
1851 # Example (Equality):
1852 #
1853 # title: &quot;Requestor is owner&quot;
1854 # description: &quot;Determines if requestor is the document owner&quot;
1855 # expression: &quot;document.owner == request.auth.claims.email&quot;
1856 #
1857 # Example (Logic):
1858 #
1859 # title: &quot;Public documents&quot;
1860 # description: &quot;Determine whether the document should be publicly visible&quot;
1861 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
1862 #
1863 # Example (Data Manipulation):
1864 #
1865 # title: &quot;Notification string&quot;
1866 # description: &quot;Create a notification string with a timestamp.&quot;
1867 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
1868 #
1869 # The exact variables and functions that may be referenced within an expression
1870 # are determined by the service that evaluates it. See the service
1871 # documentation for additional information.
1872 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
1873 # describes the expression, e.g. when hovered over it in a UI.
1874 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
1875 # syntax.
1876 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
1877 # reporting, e.g. a file name and a position in the file.
1878 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
1879 # its purpose. This can be used e.g. in UIs which allow to enter the
1880 # expression.
1881 },
1882 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
1883 # `members` can have the following values:
1884 #
1885 # * `allUsers`: A special identifier that represents anyone who is
1886 # on the internet; with or without a Google account.
1887 #
1888 # * `allAuthenticatedUsers`: A special identifier that represents anyone
1889 # who is authenticated with a Google account or a service account.
1890 # Does not include identities that come from external identity providers
1891 # (IdPs) through identity federation.
1892 #
1893 # * `user:{emailid}`: An email address that represents a specific Google
1894 # account. For example, `[email protected]` .
1895 #
1896 #
1897 # * `serviceAccount:{emailid}`: An email address that represents a Google
1898 # service account. For example,
1899 # `[email protected]`.
1900 #
1901 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
1902 # identifier for a
1903 # [Kubernetes service
1904 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
1905 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
1906 #
1907 # * `group:{emailid}`: An email address that represents a Google group.
1908 # For example, `[email protected]`.
1909 #
1910 #
1911 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
1912 # users of that domain. For example, `google.com` or `example.com`.
1913 #
1914 #
1915 #
1916 #
1917 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
1918 # A single identity in a workforce identity pool.
1919 #
1920 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
1921 # All workforce identities in a group.
1922 #
1923 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
1924 # All workforce identities with a specific attribute value.
1925 #
1926 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
1927 # All identities in a workforce identity pool.
1928 #
1929 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
1930 # A single identity in a workload identity pool.
1931 #
1932 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
1933 # A workload identity pool group.
1934 #
1935 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
1936 # All identities in a workload identity pool with a certain attribute.
1937 #
1938 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
1939 # All identities in a workload identity pool.
1940 #
1941 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
1942 # identifier) representing a user that has been recently deleted. For
1943 # example, `[email protected]?uid=123456789012345678901`. If the user is
1944 # recovered, this value reverts to `user:{emailid}` and the recovered user
1945 # retains the role in the binding.
1946 #
1947 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
1948 # unique identifier) representing a service account that has been recently
1949 # deleted. For example,
1950 # `[email protected]?uid=123456789012345678901`.
1951 # If the service account is undeleted, this value reverts to
1952 # `serviceAccount:{emailid}` and the undeleted service account retains the
1953 # role in the binding.
1954 #
1955 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
1956 # identifier) representing a Google group that has been recently
1957 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
1958 # the group is recovered, this value reverts to `group:{emailid}` and the
1959 # recovered group retains the role in the binding.
1960 #
1961 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
1962 # Deleted single identity in a workforce identity pool. For example,
1963 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
1964 &quot;A String&quot;,
1965 ],
1966 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
1967 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
1968 #
1969 # For an overview of the IAM roles and permissions, see the
1970 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
1971 # a list of the available pre-defined roles, see
1972 # [here](https://cloud.google.com/iam/docs/understanding-roles).
1973 },
1974 ],
1975 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
1976 # prevent simultaneous updates of a policy from overwriting each other.
1977 # It is strongly suggested that systems make use of the `etag` in the
1978 # read-modify-write cycle to perform policy updates in order to avoid race
1979 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
1980 # systems are expected to put that etag in the request to `setIamPolicy` to
1981 # ensure that their change will be applied to the same version of the policy.
1982 #
1983 # **Important:** If you use IAM Conditions, you must include the `etag` field
1984 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
1985 # you to overwrite a version `3` policy with a version `1` policy, and all of
1986 # the conditions in the version `3` policy are lost.
1987 &quot;version&quot;: 42, # Specifies the format of the policy.
1988 #
1989 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
1990 # are rejected.
1991 #
1992 # Any operation that affects conditional role bindings must specify version
1993 # `3`. This requirement applies to the following operations:
1994 #
1995 # * Getting a policy that includes a conditional role binding
1996 # * Adding a conditional role binding to a policy
1997 # * Changing a conditional role binding in a policy
1998 # * Removing any role binding, with or without a condition, from a policy
1999 # that includes conditions
2000 #
2001 # **Important:** If you use IAM Conditions, you must include the `etag` field
2002 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
2003 # you to overwrite a version `3` policy with a version `1` policy, and all of
2004 # the conditions in the version `3` policy are lost.
2005 #
2006 # If a policy does not include any conditions, operations on that policy may
2007 # specify any valid version or leave the field unset.
2008 #
2009 # To learn which resources support conditions in their IAM policies, see the
2010 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
2011 },
2012 }
2013
2014 x__xgafv: string, V1 error format.
2015 Allowed values
2016 1 - v1 error format
2017 2 - v2 error format
2018
2019 Returns:
2020 An object of the form:
2021
2022 { # An Identity and Access Management (IAM) policy, which specifies access
2023 # controls for Google Cloud resources.
2024 #
2025 #
2026 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
2027 # `members`, or principals, to a single `role`. Principals can be user
2028 # accounts, service accounts, Google groups, and domains (such as G Suite). A
2029 # `role` is a named list of permissions; each `role` can be an IAM predefined
2030 # role or a user-created custom role.
2031 #
2032 # For some types of Google Cloud resources, a `binding` can also specify a
2033 # `condition`, which is a logical expression that allows access to a resource
2034 # only if the expression evaluates to `true`. A condition can add constraints
2035 # based on attributes of the request, the resource, or both. To learn which
2036 # resources support conditions in their IAM policies, see the
2037 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
2038 #
2039 # **JSON example:**
2040 #
2041 # ```
2042 # {
2043 # &quot;bindings&quot;: [
2044 # {
2045 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
2046 # &quot;members&quot;: [
2047 # &quot;user:[email protected]&quot;,
2048 # &quot;group:[email protected]&quot;,
2049 # &quot;domain:google.com&quot;,
2050 # &quot;serviceAccount:[email protected]&quot;
2051 # ]
2052 # },
2053 # {
2054 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
2055 # &quot;members&quot;: [
2056 # &quot;user:[email protected]&quot;
2057 # ],
2058 # &quot;condition&quot;: {
2059 # &quot;title&quot;: &quot;expirable access&quot;,
2060 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
2061 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
2062 # }
2063 # }
2064 # ],
2065 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
2066 # &quot;version&quot;: 3
2067 # }
2068 # ```
2069 #
2070 # **YAML example:**
2071 #
2072 # ```
2073 # bindings:
2074 # - members:
2075 # - user:[email protected]
2076 # - group:[email protected]
2077 # - domain:google.com
2078 # - serviceAccount:[email protected]
2079 # role: roles/resourcemanager.organizationAdmin
2080 # - members:
2081 # - user:[email protected]
2082 # role: roles/resourcemanager.organizationViewer
2083 # condition:
2084 # title: expirable access
2085 # description: Does not grant access after Sep 2020
2086 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
2087 # etag: BwWWja0YfJA=
2088 # version: 3
2089 # ```
2090 #
2091 # For a description of IAM and its features, see the
2092 # [IAM documentation](https://cloud.google.com/iam/docs/).
2093 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
2094 { # Specifies the audit configuration for a service.
2095 # The configuration determines which permission types are logged, and what
2096 # identities, if any, are exempted from logging.
2097 # An AuditConfig must have one or more AuditLogConfigs.
2098 #
2099 # If there are AuditConfigs for both `allServices` and a specific service,
2100 # the union of the two AuditConfigs is used for that service: the log_types
2101 # specified in each AuditConfig are enabled, and the exempted_members in each
2102 # AuditLogConfig are exempted.
2103 #
2104 # Example Policy with multiple AuditConfigs:
2105 #
2106 # {
2107 # &quot;audit_configs&quot;: [
2108 # {
2109 # &quot;service&quot;: &quot;allServices&quot;,
2110 # &quot;audit_log_configs&quot;: [
2111 # {
2112 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
2113 # &quot;exempted_members&quot;: [
2114 # &quot;user:[email protected]&quot;
2115 # ]
2116 # },
2117 # {
2118 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
2119 # },
2120 # {
2121 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
2122 # }
2123 # ]
2124 # },
2125 # {
2126 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
2127 # &quot;audit_log_configs&quot;: [
2128 # {
2129 # &quot;log_type&quot;: &quot;DATA_READ&quot;
2130 # },
2131 # {
2132 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
2133 # &quot;exempted_members&quot;: [
2134 # &quot;user:[email protected]&quot;
2135 # ]
2136 # }
2137 # ]
2138 # }
2139 # ]
2140 # }
2141 #
2142 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
2143 # logging. It also exempts `[email protected]` from DATA_READ logging, and
2144 # `[email protected]` from DATA_WRITE logging.
2145 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
2146 { # Provides the configuration for logging a type of permissions.
2147 # Example:
2148 #
2149 # {
2150 # &quot;audit_log_configs&quot;: [
2151 # {
2152 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
2153 # &quot;exempted_members&quot;: [
2154 # &quot;user:[email protected]&quot;
2155 # ]
2156 # },
2157 # {
2158 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
2159 # }
2160 # ]
2161 # }
2162 #
2163 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
2164 # [email protected] from DATA_READ logging.
2165 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
2166 # permission.
2167 # Follows the same format of Binding.members.
2168 &quot;A String&quot;,
2169 ],
2170 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
2171 },
2172 ],
2173 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
2174 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
2175 # `allServices` is a special value that covers all services.
2176 },
2177 ],
2178 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
2179 # may specify a `condition` that determines how and when the `bindings` are
2180 # applied. Each of the `bindings` must contain at least one principal.
2181 #
2182 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
2183 # of these principals can be Google groups. Each occurrence of a principal
2184 # counts towards these limits. For example, if the `bindings` grant 50
2185 # different roles to `user:[email protected]`, and not to any other
2186 # principal, then you can add another 1,450 principals to the `bindings` in
2187 # the `Policy`.
2188 { # Associates `members`, or principals, with a `role`.
2189 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
2190 #
2191 # If the condition evaluates to `true`, then this binding applies to the
2192 # current request.
2193 #
2194 # If the condition evaluates to `false`, then this binding does not apply to
2195 # the current request. However, a different role binding might grant the same
2196 # role to one or more of the principals in this binding.
2197 #
2198 # To learn which resources support conditions in their IAM policies, see the
2199 # [IAM
2200 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
2201 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
2202 # are documented at https://github.com/google/cel-spec.
2203 #
2204 # Example (Comparison):
2205 #
2206 # title: &quot;Summary size limit&quot;
2207 # description: &quot;Determines if a summary is less than 100 chars&quot;
2208 # expression: &quot;document.summary.size() &lt; 100&quot;
2209 #
2210 # Example (Equality):
2211 #
2212 # title: &quot;Requestor is owner&quot;
2213 # description: &quot;Determines if requestor is the document owner&quot;
2214 # expression: &quot;document.owner == request.auth.claims.email&quot;
2215 #
2216 # Example (Logic):
2217 #
2218 # title: &quot;Public documents&quot;
2219 # description: &quot;Determine whether the document should be publicly visible&quot;
2220 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
2221 #
2222 # Example (Data Manipulation):
2223 #
2224 # title: &quot;Notification string&quot;
2225 # description: &quot;Create a notification string with a timestamp.&quot;
2226 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
2227 #
2228 # The exact variables and functions that may be referenced within an expression
2229 # are determined by the service that evaluates it. See the service
2230 # documentation for additional information.
2231 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
2232 # describes the expression, e.g. when hovered over it in a UI.
2233 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
2234 # syntax.
2235 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
2236 # reporting, e.g. a file name and a position in the file.
2237 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
2238 # its purpose. This can be used e.g. in UIs which allow to enter the
2239 # expression.
2240 },
2241 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
2242 # `members` can have the following values:
2243 #
2244 # * `allUsers`: A special identifier that represents anyone who is
2245 # on the internet; with or without a Google account.
2246 #
2247 # * `allAuthenticatedUsers`: A special identifier that represents anyone
2248 # who is authenticated with a Google account or a service account.
2249 # Does not include identities that come from external identity providers
2250 # (IdPs) through identity federation.
2251 #
2252 # * `user:{emailid}`: An email address that represents a specific Google
2253 # account. For example, `[email protected]` .
2254 #
2255 #
2256 # * `serviceAccount:{emailid}`: An email address that represents a Google
2257 # service account. For example,
2258 # `[email protected]`.
2259 #
2260 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
2261 # identifier for a
2262 # [Kubernetes service
2263 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
2264 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
2265 #
2266 # * `group:{emailid}`: An email address that represents a Google group.
2267 # For example, `[email protected]`.
2268 #
2269 #
2270 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
2271 # users of that domain. For example, `google.com` or `example.com`.
2272 #
2273 #
2274 #
2275 #
2276 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
2277 # A single identity in a workforce identity pool.
2278 #
2279 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
2280 # All workforce identities in a group.
2281 #
2282 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
2283 # All workforce identities with a specific attribute value.
2284 #
2285 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
2286 # All identities in a workforce identity pool.
2287 #
2288 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
2289 # A single identity in a workload identity pool.
2290 #
2291 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
2292 # A workload identity pool group.
2293 #
2294 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
2295 # All identities in a workload identity pool with a certain attribute.
2296 #
2297 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
2298 # All identities in a workload identity pool.
2299 #
2300 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
2301 # identifier) representing a user that has been recently deleted. For
2302 # example, `[email protected]?uid=123456789012345678901`. If the user is
2303 # recovered, this value reverts to `user:{emailid}` and the recovered user
2304 # retains the role in the binding.
2305 #
2306 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
2307 # unique identifier) representing a service account that has been recently
2308 # deleted. For example,
2309 # `[email protected]?uid=123456789012345678901`.
2310 # If the service account is undeleted, this value reverts to
2311 # `serviceAccount:{emailid}` and the undeleted service account retains the
2312 # role in the binding.
2313 #
2314 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
2315 # identifier) representing a Google group that has been recently
2316 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
2317 # the group is recovered, this value reverts to `group:{emailid}` and the
2318 # recovered group retains the role in the binding.
2319 #
2320 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
2321 # Deleted single identity in a workforce identity pool. For example,
2322 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
2323 &quot;A String&quot;,
2324 ],
2325 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
2326 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
2327 #
2328 # For an overview of the IAM roles and permissions, see the
2329 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
2330 # a list of the available pre-defined roles, see
2331 # [here](https://cloud.google.com/iam/docs/understanding-roles).
2332 },
2333 ],
2334 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
2335 # prevent simultaneous updates of a policy from overwriting each other.
2336 # It is strongly suggested that systems make use of the `etag` in the
2337 # read-modify-write cycle to perform policy updates in order to avoid race
2338 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
2339 # systems are expected to put that etag in the request to `setIamPolicy` to
2340 # ensure that their change will be applied to the same version of the policy.
2341 #
2342 # **Important:** If you use IAM Conditions, you must include the `etag` field
2343 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
2344 # you to overwrite a version `3` policy with a version `1` policy, and all of
2345 # the conditions in the version `3` policy are lost.
2346 &quot;version&quot;: 42, # Specifies the format of the policy.
2347 #
2348 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
2349 # are rejected.
2350 #
2351 # Any operation that affects conditional role bindings must specify version
2352 # `3`. This requirement applies to the following operations:
2353 #
2354 # * Getting a policy that includes a conditional role binding
2355 # * Adding a conditional role binding to a policy
2356 # * Changing a conditional role binding in a policy
2357 # * Removing any role binding, with or without a condition, from a policy
2358 # that includes conditions
2359 #
2360 # **Important:** If you use IAM Conditions, you must include the `etag` field
2361 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
2362 # you to overwrite a version `3` policy with a version `1` policy, and all of
2363 # the conditions in the version `3` policy are lost.
2364 #
2365 # If a policy does not include any conditions, operations on that policy may
2366 # specify any valid version or leave the field unset.
2367 #
2368 # To learn which resources support conditions in their IAM policies, see the
2369 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
2370 }</pre>
2371 </div>
2372
2373 <div class="method">
2374 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</code>
2375 <pre>Returns permissions that a caller has on the specified resource.
2376 *Caution* This resource is intended
2377 for use only by third-party partners who are creatingCloud Marketplace
2378 images.
2379
2380 Args:
2381 project: string, Project ID for this request. (required)
2382 resource: string, Name or id of the resource for this request. (required)
2383 body: object, The request body.
2384 The object takes the form of:
2385
2386 {
2387 &quot;permissions&quot;: [ # The set of permissions to check for the &#x27;resource&#x27;. Permissions with
2388 # wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed.
2389 &quot;A String&quot;,
2390 ],
2391 }
2392
2393 x__xgafv: string, V1 error format.
2394 Allowed values
2395 1 - v1 error format
2396 2 - v2 error format
2397
2398 Returns:
2399 An object of the form:
2400
2401 {
2402 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is
2403 # allowed.
2404 &quot;A String&quot;,
2405 ],
2406 }</pre>
2407 </div>
2408
2409 <div class="method">
2410 <code class="details" id="update">update(project, license, body=None, requestId=None, updateMask=None, x__xgafv=None)</code>
2411 <pre>Updates a License resource in the specified project.
2412 *Caution* This resource is intended
2413 for use only by third-party partners who are creatingCloud Marketplace
2414 images.
2415
2416 Args:
2417 project: string, Project ID for this request. (required)
2418 license: string, The license name for this request. (required)
2419 body: object, The request body.
2420 The object takes the form of:
2421
2422 { # Represents a License resource.
2423 #
2424 # A License represents billing and aggregate usage data forpublic andmarketplace images.
2425 # *Caution* This resource is intended for
2426 # use only by third-party partners who are creatingCloud Marketplace
2427 # images.
2428 &quot;allowedReplacementLicenses&quot;: [ # Specifies licenseCodes of licenses that can replace this license. Note:
2429 # such replacements are allowed even if removable_from_disk is false.
2430 &quot;A String&quot;,
2431 ],
2432 &quot;appendableToDisk&quot;: True or False, # If true, this license can be appended to an existing disk&#x27;s set of
2433 # licenses.
2434 &quot;chargesUseFee&quot;: True or False, # [Output Only] Deprecated. This field no longer reflects whether a license
2435 # charges a usage fee.
2436 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
2437 # text format.
2438 &quot;description&quot;: &quot;A String&quot;, # An optional textual description of the resource; provided by the client
2439 # when the resource is created.
2440 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
2441 # defined by the server.
2442 &quot;incompatibleLicenses&quot;: [ # Specifies licenseCodes of licenses that are incompatible with this license.
2443 # If a license is incompatible with this license, it cannot be attached to
2444 # the same disk or image.
2445 &quot;A String&quot;,
2446 ],
2447 &quot;kind&quot;: &quot;compute#license&quot;, # Output only. [Output Only] Type of resource. Always compute#license for
2448 # licenses.
2449 &quot;licenseCode&quot;: &quot;A String&quot;, # [Output Only] The unique code used to attach this license to images,
2450 # snapshots, and disks.
2451 &quot;minimumRetention&quot;: { # A Duration represents a fixed-length span of time represented # If set, this license will be unable to be removed or replaced once attached
2452 # to a disk until the minimum_retention period has passed.
2453 # as a count of seconds and fractions of seconds at nanosecond
2454 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
2455 # or &quot;month&quot;. Range is approximately 10,000 years.
2456 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
2457 # Durations less than one second are represented with a 0
2458 # `seconds` field and a positive `nanos` field. Must be from 0
2459 # to 999,999,999 inclusive.
2460 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
2461 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
2462 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
2463 },
2464 &quot;multiTenantOnly&quot;: True or False, # If true, this license can only be used on VMs on multi tenant nodes.
2465 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. The name must be 1-63 characters long and
2466 # comply withRFC1035.
2467 &quot;osLicense&quot;: True or False, # If true, indicates this is an OS license. Only one OS license can be
2468 # attached to a disk or image at a time.
2469 &quot;params&quot;: { # Additional license params. # Input only. Additional params passed with the request, but not persisted
2470 # as part of resource payload.
2471 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the license. Tag keys and values
2472 # have the same definition as resource
2473 # manager tags. Keys and values can be either in numeric format,
2474 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
2475 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
2476 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
2477 # PATCH) when empty.
2478 &quot;a_key&quot;: &quot;A String&quot;,
2479 },
2480 },
2481 &quot;removableFromDisk&quot;: True or False, # If true, this license can be removed from a disk&#x27;s set of licenses, with no
2482 # replacement license needed.
2483 &quot;requiredCoattachedLicenses&quot;: [ # Specifies the set of permissible coattached licenseCodes of licenses that
2484 # satisfy the coattachment requirement of this license. At least one license
2485 # from the set must be attached to the same disk or image as this license.
2486 &quot;A String&quot;,
2487 ],
2488 &quot;resourceRequirements&quot;: { # [Input Only] Deprecated.
2489 &quot;minGuestCpuCount&quot;: 42, # [Input Only] Deprecated. This field no longer reflects the minimum number
2490 # of guest cpus required to use the Instance.
2491 &quot;minMemoryMb&quot;: 42, # [Input Only] Deprecated. This field no longer reflects the minimum memory
2492 # required to use the Instance.
2493 },
2494 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
2495 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
2496 &quot;soleTenantOnly&quot;: True or False, # If true, this license can only be used on VMs on sole tenant nodes.
2497 &quot;transferable&quot;: True or False, # If false, licenses will not be copied from the source resource when
2498 # creating an image from a disk, disk from snapshot, or snapshot from disk.
2499 &quot;updateTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last update timestamp inRFC3339
2500 # text format.
2501 }
2502
2503 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
2504 that if you must retry your request, the server will know to ignore the
2505 request if it has already been completed.
2506
2507 For example, consider a situation where you make an initial request and
2508 the request times out. If you make the request again with the same
2509 request ID, the server can check if original operation with the same
2510 request ID was received, and if so, will ignore the second request. This
2511 prevents clients from accidentally creating duplicate commitments.
2512
2513 The request ID must be
2514 a valid UUID with the exception that zero UUID is not supported
2515 (00000000-0000-0000-0000-000000000000).
2516 updateMask: string, update_mask indicates fields to be updated as part of this request.
2517 x__xgafv: string, V1 error format.
2518 Allowed values
2519 1 - v1 error format
2520 2 - v2 error format
2521
2522 Returns:
2523 An object of the form:
2524
2525 { # Represents an Operation resource.
2526 #
2527 # Google Compute Engine has three Operation resources:
2528 #
2529 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
2530 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
2531 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
2532 #
2533 # You can use an operation resource to manage asynchronous API requests.
2534 # For more information, readHandling
2535 # API responses.
2536 #
2537 # Operations can be global, regional or zonal.
2538 #
2539 # - For global operations, use the `globalOperations`
2540 # resource.
2541 # - For regional operations, use the
2542 # `regionOperations` resource.
2543 # - For zonal operations, use
2544 # the `zoneOperations` resource.
2545 #
2546 #
2547 #
2548 # For more information, read
2549 # Global, Regional, and Zonal Resources.
2550 #
2551 # Note that completed Operation resources have a limited
2552 # retention period.
2553 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
2554 # Not present otherwise.
2555 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
2556 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
2557 # set when the operation is created.
2558 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
2559 # text format.
2560 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
2561 # this field will be populated.
2562 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
2563 # operation.
2564 {
2565 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
2566 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
2567 # details. There is a set of defined message types to use for providing
2568 # details.The syntax depends on the error code. For example,
2569 # QuotaExceededInfo will have details when the error code is
2570 # QUOTA_EXCEEDED.
2571 {
2572 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
2573 #
2574 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
2575 # is not enabled:
2576 #
2577 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
2578 # &quot;domain&quot;: &quot;googleapis.com&quot;
2579 # &quot;metadata&quot;: {
2580 # &quot;resource&quot;: &quot;projects/123&quot;,
2581 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
2582 # }
2583 # }
2584 #
2585 # This response indicates that the pubsub.googleapis.com API is not enabled.
2586 #
2587 # Example of an error that is returned when attempting to create a Spanner
2588 # instance in a region that is out of stock:
2589 #
2590 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
2591 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
2592 # &quot;metadata&quot;: {
2593 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
2594 # }
2595 # }
2596 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
2597 # is typically the registered service name of the tool or product that
2598 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
2599 # generated by some common infrastructure, the error domain must be a
2600 # globally unique value that identifies the infrastructure. For Google API
2601 # infrastructure, the error domain is &quot;googleapis.com&quot;.
2602 &quot;metadatas&quot;: { # Additional structured details about this error.
2603 #
2604 # Keys must match a regular expression of `a-z+` but should
2605 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
2606 # length. When identifying the current value of an exceeded limit, the units
2607 # should be contained in the key, not the value. For example, rather than
2608 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
2609 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
2610 # instances that can be created in a single (batch) request.
2611 &quot;a_key&quot;: &quot;A String&quot;,
2612 },
2613 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
2614 # proximate cause of the error. Error reasons are unique within a particular
2615 # domain of errors. This should be at most 63 characters and match a
2616 # regular expression of `A-Z+[A-Z0-9]`, which represents
2617 # UPPER_SNAKE_CASE.
2618 },
2619 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
2620 #
2621 # For example, if a quota check failed with an error indicating the calling
2622 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
2623 # directly to the right place in the developer console to flip the bit.
2624 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
2625 { # Describes a URL link.
2626 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
2627 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
2628 },
2629 ],
2630 },
2631 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
2632 # which can be attached to an RPC error.
2633 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
2634 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
2635 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
2636 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
2637 },
2638 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
2639 &quot;dimensions&quot;: { # The map holding related quota dimensions.
2640 &quot;a_key&quot;: &quot;A String&quot;,
2641 },
2642 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
2643 # type or metric.
2644 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
2645 # or metric.
2646 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
2647 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
2648 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
2649 },
2650 },
2651 ],
2652 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
2653 # This property is optional.
2654 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
2655 },
2656 ],
2657 },
2658 &quot;getVersionOperationMetadata&quot;: {
2659 &quot;inlineSbomInfo&quot;: {
2660 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
2661 # appropriate identifiers.
2662 &quot;a_key&quot;: &quot;A String&quot;,
2663 },
2664 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
2665 # identifiers.
2666 &quot;a_key&quot;: &quot;A String&quot;,
2667 },
2668 },
2669 },
2670 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
2671 # message that was returned, such as `NOT FOUND`.
2672 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
2673 # status code that was returned. For example, a `404` means the
2674 # resource was not found.
2675 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
2676 # defined by the server.
2677 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
2678 # This value is inRFC3339
2679 # text format.
2680 &quot;instancesBulkInsertOperationMetadata&quot;: {
2681 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
2682 # Example key: zones/us-central1-a
2683 &quot;a_key&quot;: {
2684 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
2685 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
2686 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
2687 # error.
2688 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
2689 # if the flow is rolling forward or rolling back.
2690 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
2691 },
2692 },
2693 },
2694 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
2695 # Operation resources.
2696 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
2697 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
2698 # group of operations results from a `bulkInsert` API request.
2699 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
2700 # `update`, or `delete`, and so on.
2701 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
2702 # There is no requirement that this be linear or support any granularity of
2703 # operations. This should not be used to guess when the operation will be
2704 # complete. This number should monotonically increase as the operation
2705 # progresses.
2706 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
2707 # applicable when performing regional operations.
2708 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2709 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
2710 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
2711 # this field will contain information on all underlying zonal actions and
2712 # their state.
2713 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
2714 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
2715 # Example key: zones/us-central1-a
2716 &quot;a_key&quot;: {
2717 &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
2718 # populated.
2719 # different programming environments, including REST APIs and RPC APIs. It is
2720 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
2721 # three pieces of data: error code, error message, and error details.
2722 #
2723 # You can find out more about this error model and how to work with it in the
2724 # [API Design Guide](https://cloud.google.com/apis/design/errors).
2725 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
2726 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
2727 # message types for APIs to use.
2728 {
2729 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
2730 },
2731 ],
2732 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
2733 # user-facing error message should be localized and sent in the
2734 # google.rpc.Status.details field, or localized by the client.
2735 },
2736 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
2737 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
2738 },
2739 },
2740 },
2741 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
2742 # This value is inRFC3339
2743 # text format.
2744 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
2745 # following:
2746 # `PENDING`, `RUNNING`, or `DONE`.
2747 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
2748 # operation.
2749 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
2750 # of the target resource.
2751 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
2752 # operations related to creating a snapshot, this points to the disk
2753 # that the snapshot was created from.
2754 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
2755 # `[email protected]` or
2756 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
2757 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
2758 # operation, this field will be populated.
2759 {
2760 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2761 # Engine returns NO_RESULTS_ON_PAGE if there
2762 # are no results in the response.
2763 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2764 # value format. For example:
2765 #
2766 # &quot;data&quot;: [
2767 # {
2768 # &quot;key&quot;: &quot;scope&quot;,
2769 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2770 # }
2771 {
2772 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2773 # returned. For example, for warnings where there are no results in a list
2774 # request for a particular zone, this key might be scope and
2775 # the key value might be the zone name. Other examples might be a key
2776 # indicating a deprecated resource and a suggested replacement, or a
2777 # warning about invalid network settings (for example, if an instance
2778 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2779 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2780 },
2781 ],
2782 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2783 },
2784 ],
2785 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
2786 # applicable when performing per-zone operations.
2787 }</pre>
2788 </div>
2789
2790 </body></html>