Debian Codegraph @

docs/dyn/compute_beta.snapshotSettings.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.snapshotSettings.html">snapshotSettings</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, x__xgafv=None)</a></code></p>
82 <p class="firstline">Get snapshot settings.</p>
83 <p class="toc_element">
84 <code><a href="#patch">patch(project, body=None, requestId=None, updateMask=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Patch snapshot 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, x__xgafv=None)</code>
94 <pre>Get snapshot settings.
95
96 Args:
97 project: string, Project ID for this request. (required)
98 x__xgafv: string, V1 error format.
99 Allowed values
100 1 - v1 error format
101 2 - v2 error format
102
103 Returns:
104 An object of the form:
105
106 {
107 &quot;accessLocation&quot;: { # (Regional snapshots use only)Policy of which location is allowed to access
108 # snapshot.
109 &quot;locations&quot;: { # List of regions that can restore a regional
110 # snapshot from the current region
111 &quot;a_key&quot;: { # A structure for specifying an allowed target region.
112 &quot;region&quot;: &quot;A String&quot;, # Accessible region name
113 },
114 },
115 &quot;policy&quot;: &quot;A String&quot;, # Policy of which location is allowed to access snapshot.
116 },
117 &quot;storageLocation&quot;: { # Policy of which storage location is going to be resolved, and additional
118 # data that particularizes how the policy is going to be carried out.
119 &quot;locations&quot;: { # When the policy is SPECIFIC_LOCATIONS, snapshots will be stored
120 # in the locations listed in this field. Keys are Cloud Storage bucket
121 # locations. Only one location can be specified.
122 &quot;a_key&quot;: { # A structure for specifying storage locations.
123 &quot;name&quot;: &quot;A String&quot;, # Name of the location. It should be one of the Cloud Storage buckets.
124 # Only one location can be specified.
125 },
126 },
127 &quot;policy&quot;: &quot;A String&quot;, # The chosen location policy.
128 },
129 }</pre>
130 </div>
131
132 <div class="method">
133 <code class="details" id="patch">patch(project, body=None, requestId=None, updateMask=None, x__xgafv=None)</code>
134 <pre>Patch snapshot settings.
135
136 Args:
137 project: string, Project ID for this request. (required)
138 body: object, The request body.
139 The object takes the form of:
140
141 {
142 &quot;accessLocation&quot;: { # (Regional snapshots use only)Policy of which location is allowed to access
143 # snapshot.
144 &quot;locations&quot;: { # List of regions that can restore a regional
145 # snapshot from the current region
146 &quot;a_key&quot;: { # A structure for specifying an allowed target region.
147 &quot;region&quot;: &quot;A String&quot;, # Accessible region name
148 },
149 },
150 &quot;policy&quot;: &quot;A String&quot;, # Policy of which location is allowed to access snapshot.
151 },
152 &quot;storageLocation&quot;: { # Policy of which storage location is going to be resolved, and additional
153 # data that particularizes how the policy is going to be carried out.
154 &quot;locations&quot;: { # When the policy is SPECIFIC_LOCATIONS, snapshots will be stored
155 # in the locations listed in this field. Keys are Cloud Storage bucket
156 # locations. Only one location can be specified.
157 &quot;a_key&quot;: { # A structure for specifying storage locations.
158 &quot;name&quot;: &quot;A String&quot;, # Name of the location. It should be one of the Cloud Storage buckets.
159 # Only one location can be specified.
160 },
161 },
162 &quot;policy&quot;: &quot;A String&quot;, # The chosen location policy.
163 },
164 }
165
166 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
167 that if you must retry your request, the server will know to ignore the
168 request if it has already been completed.
169
170 For example, consider a situation where you make an initial request and
171 the request times out. If you make the request again with the same
172 request ID, the server can check if original operation with the same
173 request ID was received, and if so, will ignore the second request. This
174 prevents clients from accidentally creating duplicate commitments.
175
176 The request ID must be
177 a valid UUID with the exception that zero UUID is not supported
178 (00000000-0000-0000-0000-000000000000).
179 updateMask: string, update_mask indicates fields to be updated as part of this request.
180 x__xgafv: string, V1 error format.
181 Allowed values
182 1 - v1 error format
183 2 - v2 error format
184
185 Returns:
186 An object of the form:
187
188 { # Represents an Operation resource.
189 #
190 # Google Compute Engine has three Operation resources:
191 #
192 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
193 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
194 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
195 #
196 # You can use an operation resource to manage asynchronous API requests.
197 # For more information, readHandling
198 # API responses.
199 #
200 # Operations can be global, regional or zonal.
201 #
202 # - For global operations, use the `globalOperations`
203 # resource.
204 # - For regional operations, use the
205 # `regionOperations` resource.
206 # - For zonal operations, use
207 # the `zoneOperations` resource.
208 #
209 #
210 #
211 # For more information, read
212 # Global, Regional, and Zonal Resources.
213 #
214 # Note that completed Operation resources have a limited
215 # retention period.
216 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
217 # Not present otherwise.
218 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
219 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
220 # set when the operation is created.
221 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
222 # text format.
223 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
224 # this field will be populated.
225 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
226 # operation.
227 {
228 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
229 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
230 # details. There is a set of defined message types to use for providing
231 # details.The syntax depends on the error code. For example,
232 # QuotaExceededInfo will have details when the error code is
233 # QUOTA_EXCEEDED.
234 {
235 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
236 #
237 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
238 # is not enabled:
239 #
240 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
241 # &quot;domain&quot;: &quot;googleapis.com&quot;
242 # &quot;metadata&quot;: {
243 # &quot;resource&quot;: &quot;projects/123&quot;,
244 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
245 # }
246 # }
247 #
248 # This response indicates that the pubsub.googleapis.com API is not enabled.
249 #
250 # Example of an error that is returned when attempting to create a Spanner
251 # instance in a region that is out of stock:
252 #
253 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
254 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
255 # &quot;metadata&quot;: {
256 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
257 # }
258 # }
259 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
260 # is typically the registered service name of the tool or product that
261 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
262 # generated by some common infrastructure, the error domain must be a
263 # globally unique value that identifies the infrastructure. For Google API
264 # infrastructure, the error domain is &quot;googleapis.com&quot;.
265 &quot;metadatas&quot;: { # Additional structured details about this error.
266 #
267 # Keys must match a regular expression of `a-z+` but should
268 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
269 # length. When identifying the current value of an exceeded limit, the units
270 # should be contained in the key, not the value. For example, rather than
271 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
272 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
273 # instances that can be created in a single (batch) request.
274 &quot;a_key&quot;: &quot;A String&quot;,
275 },
276 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
277 # proximate cause of the error. Error reasons are unique within a particular
278 # domain of errors. This should be at most 63 characters and match a
279 # regular expression of `A-Z+[A-Z0-9]`, which represents
280 # UPPER_SNAKE_CASE.
281 },
282 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
283 #
284 # For example, if a quota check failed with an error indicating the calling
285 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
286 # directly to the right place in the developer console to flip the bit.
287 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
288 { # Describes a URL link.
289 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
290 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
291 },
292 ],
293 },
294 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
295 # which can be attached to an RPC error.
296 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
297 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
298 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
299 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
300 },
301 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
302 &quot;dimensions&quot;: { # The map holding related quota dimensions.
303 &quot;a_key&quot;: &quot;A String&quot;,
304 },
305 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
306 # type or metric.
307 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
308 # or metric.
309 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
310 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
311 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
312 },
313 },
314 ],
315 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
316 # This property is optional.
317 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
318 },
319 ],
320 },
321 &quot;getVersionOperationMetadata&quot;: {
322 &quot;inlineSbomInfo&quot;: {
323 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
324 # appropriate identifiers.
325 &quot;a_key&quot;: &quot;A String&quot;,
326 },
327 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
328 # identifiers.
329 &quot;a_key&quot;: &quot;A String&quot;,
330 },
331 },
332 },
333 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
334 # message that was returned, such as `NOT FOUND`.
335 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
336 # status code that was returned. For example, a `404` means the
337 # resource was not found.
338 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
339 # defined by the server.
340 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
341 # This value is inRFC3339
342 # text format.
343 &quot;instancesBulkInsertOperationMetadata&quot;: {
344 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
345 # Example key: zones/us-central1-a
346 &quot;a_key&quot;: {
347 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
348 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
349 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
350 # error.
351 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
352 # if the flow is rolling forward or rolling back.
353 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
354 },
355 },
356 },
357 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
358 # Operation resources.
359 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
360 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
361 # group of operations results from a `bulkInsert` API request.
362 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
363 # `update`, or `delete`, and so on.
364 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
365 # There is no requirement that this be linear or support any granularity of
366 # operations. This should not be used to guess when the operation will be
367 # complete. This number should monotonically increase as the operation
368 # progresses.
369 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
370 # applicable when performing regional operations.
371 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
372 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
373 # this field will contain information on all underlying zonal actions and
374 # their state.
375 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
376 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
377 # Example key: zones/us-central1-a
378 &quot;a_key&quot;: {
379 &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
380 # populated.
381 # different programming environments, including REST APIs and RPC APIs. It is
382 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
383 # three pieces of data: error code, error message, and error details.
384 #
385 # You can find out more about this error model and how to work with it in the
386 # [API Design Guide](https://cloud.google.com/apis/design/errors).
387 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
388 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
389 # message types for APIs to use.
390 {
391 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
392 },
393 ],
394 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
395 # user-facing error message should be localized and sent in the
396 # google.rpc.Status.details field, or localized by the client.
397 },
398 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
399 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
400 },
401 },
402 },
403 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
404 # This value is inRFC3339
405 # text format.
406 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
407 # following:
408 # `PENDING`, `RUNNING`, or `DONE`.
409 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
410 # operation.
411 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
412 # of the target resource.
413 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
414 # operations related to creating a snapshot, this points to the disk
415 # that the snapshot was created from.
416 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
417 # `[email protected]` or
418 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
419 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
420 # operation, this field will be populated.
421 {
422 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
423 # Engine returns NO_RESULTS_ON_PAGE if there
424 # are no results in the response.
425 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
426 # value format. For example:
427 #
428 # &quot;data&quot;: [
429 # {
430 # &quot;key&quot;: &quot;scope&quot;,
431 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
432 # }
433 {
434 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
435 # returned. For example, for warnings where there are no results in a list
436 # request for a particular zone, this key might be scope and
437 # the key value might be the zone name. Other examples might be a key
438 # indicating a deprecated resource and a suggested replacement, or a
439 # warning about invalid network settings (for example, if an instance
440 # attempts to perform IP forwarding but is not enabled for IP forwarding).
441 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
442 },
443 ],
444 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
445 },
446 ],
447 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
448 # applicable when performing per-zone operations.
449 }</pre>
450 </div>
451
452 </body></html>