Debian Codegraph @

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