Debian Codegraph @

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