Debian Codegraph @

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