Debian Codegraph @

docs/dyn/compute_alpha.diskSettings.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.diskSettings.html">diskSettings</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#get">get(project, zone, x__xgafv=None)</a></code></p>
82 <p class="firstline">Get Zonal Disk Settings.</p>
83 <p class="toc_element">
84 <code><a href="#patch">patch(project, zone, body=None, requestId=None, updateMask=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Patch Zonal Disk Settings</p>
86 <h3>Method Details</h3>
87 <div class="method">
88 <code class="details" id="close">close()</code>
89 <pre>Close httplib2 connections.</pre>
90 </div>
91
92 <div class="method">
93 <code class="details" id="get">get(project, zone, x__xgafv=None)</code>
94 <pre>Get Zonal Disk Settings.
95
96 Args:
97 project: string, Project ID for this request. (required)
98 zone: string, Name of the zone for this request. (required)
99 x__xgafv: string, V1 error format.
100 Allowed values
101 1 - v1 error format
102 2 - v2 error format
103
104 Returns:
105 An object of the form:
106
107 {
108 &quot;accessLocation&quot;: { # AccessLocation is only used for regional snapshot. It contains which # Policy of which locations are allowed to create regional
109 # snapshots.
110 # regions are allowed to create a regional snapshot from disks located in the
111 # given region/zone.
112 # It includes key-value pairs designed to store the following structure. The
113 # keys should match their corresponding values, which must be provided:
114 # access_location: {
115 # locations {
116 # us-central1 {
117 # region: &quot;us-central1&quot;
118 # },
119 # asia-west2 {
120 # region: &quot;asia-west2&quot;
121 # }
122 # }
123 # }
124 &quot;locations&quot;: { # List of regions that can create a regional
125 # snapshot from the current region
126 &quot;a_key&quot;: { # A structure for specifying an allowed target region to create snapshot.
127 &quot;region&quot;: &quot;A String&quot;, # Accessible region name
128 },
129 },
130 &quot;policy&quot;: &quot;A String&quot;, # Policy of which location is allowed to access snapshot.
131 },
132 &quot;defaultResourcePolicies&quot;: { # An optional parameter for storing the default resource policies that
133 # will be used for the Disks created in the given scope.
134 #
135 # The Key is a string type, provided by customers to uniquely identify the
136 # default Resource Policy entry.
137 #
138 # The Value is a Default ResourcePolicyDetails Object used to represent the
139 # detailed information of the Resource Policy entry.
140 &quot;a_key&quot;: { # This is the object for storing the detail information about the
141 # Resource Policy that will be set as default ones for the Disks
142 # that is using the DiskSettings.
143 #
144 # It contains:
145 # - one target Resource Policy referenced by its Fully-Qualified URL,
146 # - [output only] Disk Types that will be excluded from using this
147 # Resource Policy,
148 # - Other filtering support (e.g. Label filtering) for Default Resource
149 # Policy can be added here as well
150 &quot;excludedDiskTypes&quot;: [ # Output only. [Output Only] A list of Disk Types that will be excluded from applying
151 # the Resource Policy referenced here.
152 # If absent, Disks created in any DiskType can use the referenced
153 # default Resource Policy.
154 &quot;A String&quot;,
155 ],
156 &quot;resourcePolicy&quot;: &quot;A String&quot;, # The target Resource Policies identified by their Fully-Qualified URL.
157 },
158 },
159 }</pre>
160 </div>
161
162 <div class="method">
163 <code class="details" id="patch">patch(project, zone, body=None, requestId=None, updateMask=None, x__xgafv=None)</code>
164 <pre>Patch Zonal Disk Settings
165
166 Args:
167 project: string, Project ID for this request. (required)
168 zone: string, The name of the zone for this request. (required)
169 body: object, The request body.
170 The object takes the form of:
171
172 {
173 &quot;accessLocation&quot;: { # AccessLocation is only used for regional snapshot. It contains which # Policy of which locations are allowed to create regional
174 # snapshots.
175 # regions are allowed to create a regional snapshot from disks located in the
176 # given region/zone.
177 # It includes key-value pairs designed to store the following structure. The
178 # keys should match their corresponding values, which must be provided:
179 # access_location: {
180 # locations {
181 # us-central1 {
182 # region: &quot;us-central1&quot;
183 # },
184 # asia-west2 {
185 # region: &quot;asia-west2&quot;
186 # }
187 # }
188 # }
189 &quot;locations&quot;: { # List of regions that can create a regional
190 # snapshot from the current region
191 &quot;a_key&quot;: { # A structure for specifying an allowed target region to create snapshot.
192 &quot;region&quot;: &quot;A String&quot;, # Accessible region name
193 },
194 },
195 &quot;policy&quot;: &quot;A String&quot;, # Policy of which location is allowed to access snapshot.
196 },
197 &quot;defaultResourcePolicies&quot;: { # An optional parameter for storing the default resource policies that
198 # will be used for the Disks created in the given scope.
199 #
200 # The Key is a string type, provided by customers to uniquely identify the
201 # default Resource Policy entry.
202 #
203 # The Value is a Default ResourcePolicyDetails Object used to represent the
204 # detailed information of the Resource Policy entry.
205 &quot;a_key&quot;: { # This is the object for storing the detail information about the
206 # Resource Policy that will be set as default ones for the Disks
207 # that is using the DiskSettings.
208 #
209 # It contains:
210 # - one target Resource Policy referenced by its Fully-Qualified URL,
211 # - [output only] Disk Types that will be excluded from using this
212 # Resource Policy,
213 # - Other filtering support (e.g. Label filtering) for Default Resource
214 # Policy can be added here as well
215 &quot;excludedDiskTypes&quot;: [ # Output only. [Output Only] A list of Disk Types that will be excluded from applying
216 # the Resource Policy referenced here.
217 # If absent, Disks created in any DiskType can use the referenced
218 # default Resource Policy.
219 &quot;A String&quot;,
220 ],
221 &quot;resourcePolicy&quot;: &quot;A String&quot;, # The target Resource Policies identified by their Fully-Qualified URL.
222 },
223 },
224 }
225
226 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
227 that if you must retry your request, the server will know to ignore the
228 request if it has already been completed.
229
230 For example, consider a situation where you make an initial request and
231 the request times out. If you make the request again with the same
232 request ID, the server can check if original operation with the same
233 request ID was received, and if so, will ignore the second request. This
234 prevents clients from accidentally creating duplicate commitments.
235
236 The request ID must be
237 a valid UUID with the exception that zero UUID is not supported
238 (00000000-0000-0000-0000-000000000000).
239 updateMask: string, update_mask indicates fields to be updated as part of this request.
240 x__xgafv: string, V1 error format.
241 Allowed values
242 1 - v1 error format
243 2 - v2 error format
244
245 Returns:
246 An object of the form:
247
248 { # Represents an Operation resource.
249 #
250 # Google Compute Engine has three Operation resources:
251 #
252 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
253 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
254 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
255 #
256 # You can use an operation resource to manage asynchronous API requests.
257 # For more information, readHandling
258 # API responses.
259 #
260 # Operations can be global, regional or zonal.
261 #
262 # - For global operations, use the `globalOperations`
263 # resource.
264 # - For regional operations, use the
265 # `regionOperations` resource.
266 # - For zonal operations, use
267 # the `zoneOperations` resource.
268 #
269 #
270 #
271 # For more information, read
272 # Global, Regional, and Zonal Resources.
273 #
274 # Note that completed Operation resources have a limited
275 # retention period.
276 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
277 # Not present otherwise.
278 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
279 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
280 # set when the operation is created.
281 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
282 # text format.
283 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
284 # this field will be populated.
285 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
286 # operation.
287 {
288 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
289 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
290 # details. There is a set of defined message types to use for providing
291 # details.The syntax depends on the error code. For example,
292 # QuotaExceededInfo will have details when the error code is
293 # QUOTA_EXCEEDED.
294 {
295 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
296 #
297 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
298 # is not enabled:
299 #
300 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
301 # &quot;domain&quot;: &quot;googleapis.com&quot;
302 # &quot;metadata&quot;: {
303 # &quot;resource&quot;: &quot;projects/123&quot;,
304 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
305 # }
306 # }
307 #
308 # This response indicates that the pubsub.googleapis.com API is not enabled.
309 #
310 # Example of an error that is returned when attempting to create a Spanner
311 # instance in a region that is out of stock:
312 #
313 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
314 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
315 # &quot;metadata&quot;: {
316 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
317 # }
318 # }
319 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
320 # is typically the registered service name of the tool or product that
321 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
322 # generated by some common infrastructure, the error domain must be a
323 # globally unique value that identifies the infrastructure. For Google API
324 # infrastructure, the error domain is &quot;googleapis.com&quot;.
325 &quot;metadatas&quot;: { # Additional structured details about this error.
326 #
327 # Keys must match a regular expression of `a-z+` but should
328 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
329 # length. When identifying the current value of an exceeded limit, the units
330 # should be contained in the key, not the value. For example, rather than
331 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
332 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
333 # instances that can be created in a single (batch) request.
334 &quot;a_key&quot;: &quot;A String&quot;,
335 },
336 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
337 # proximate cause of the error. Error reasons are unique within a particular
338 # domain of errors. This should be at most 63 characters and match a
339 # regular expression of `A-Z+[A-Z0-9]`, which represents
340 # UPPER_SNAKE_CASE.
341 },
342 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
343 #
344 # For example, if a quota check failed with an error indicating the calling
345 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
346 # directly to the right place in the developer console to flip the bit.
347 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
348 { # Describes a URL link.
349 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
350 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
351 },
352 ],
353 },
354 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
355 # which can be attached to an RPC error.
356 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
357 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
358 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
359 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
360 },
361 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
362 &quot;dimensions&quot;: { # The map holding related quota dimensions.
363 &quot;a_key&quot;: &quot;A String&quot;,
364 },
365 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
366 # type or metric.
367 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
368 # or metric.
369 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
370 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
371 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
372 },
373 },
374 ],
375 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
376 # This property is optional.
377 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
378 },
379 ],
380 },
381 &quot;getVersionOperationMetadata&quot;: {
382 &quot;inlineSbomInfo&quot;: {
383 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
384 # appropriate identifiers.
385 &quot;a_key&quot;: &quot;A String&quot;,
386 },
387 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
388 # identifiers.
389 &quot;a_key&quot;: &quot;A String&quot;,
390 },
391 },
392 },
393 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
394 # message that was returned, such as `NOT FOUND`.
395 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
396 # status code that was returned. For example, a `404` means the
397 # resource was not found.
398 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
399 # defined by the server.
400 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
401 # This value is inRFC3339
402 # text format.
403 &quot;instancesBulkInsertOperationMetadata&quot;: {
404 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
405 # Example key: zones/us-central1-a
406 &quot;a_key&quot;: {
407 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
408 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
409 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
410 # error.
411 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
412 # if the flow is rolling forward or rolling back.
413 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
414 },
415 },
416 },
417 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
418 # Operation resources.
419 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
420 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
421 # group of operations results from a `bulkInsert` API request.
422 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
423 # `update`, or `delete`, and so on.
424 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
425 # There is no requirement that this be linear or support any granularity of
426 # operations. This should not be used to guess when the operation will be
427 # complete. This number should monotonically increase as the operation
428 # progresses.
429 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
430 # applicable when performing regional operations.
431 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
432 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
433 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
434 # this field will contain information on all underlying zonal actions and
435 # their state.
436 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
437 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
438 # Example key: zones/us-central1-a
439 &quot;a_key&quot;: {
440 &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
441 # populated.
442 # different programming environments, including REST APIs and RPC APIs. It is
443 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
444 # three pieces of data: error code, error message, and error details.
445 #
446 # You can find out more about this error model and how to work with it in the
447 # [API Design Guide](https://cloud.google.com/apis/design/errors).
448 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
449 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
450 # message types for APIs to use.
451 {
452 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
453 },
454 ],
455 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
456 # user-facing error message should be localized and sent in the
457 # google.rpc.Status.details field, or localized by the client.
458 },
459 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
460 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
461 },
462 },
463 },
464 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
465 # This value is inRFC3339
466 # text format.
467 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
468 # following:
469 # `PENDING`, `RUNNING`, or `DONE`.
470 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
471 # operation.
472 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
473 # of the target resource.
474 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
475 # operations related to creating a snapshot, this points to the disk
476 # that the snapshot was created from.
477 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
478 # `[email protected]` or
479 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
480 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
481 # operation, this field will be populated.
482 {
483 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
484 # Engine returns NO_RESULTS_ON_PAGE if there
485 # are no results in the response.
486 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
487 # value format. For example:
488 #
489 # &quot;data&quot;: [
490 # {
491 # &quot;key&quot;: &quot;scope&quot;,
492 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
493 # }
494 {
495 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
496 # returned. For example, for warnings where there are no results in a list
497 # request for a particular zone, this key might be scope and
498 # the key value might be the zone name. Other examples might be a key
499 # indicating a deprecated resource and a suggested replacement, or a
500 # warning about invalid network settings (for example, if an instance
501 # attempts to perform IP forwarding but is not enabled for IP forwarding).
502 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
503 },
504 ],
505 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
506 },
507 ],
508 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
509 # applicable when performing per-zone operations.
510 }</pre>
511 </div>
512
513 </body></html>