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