instance_settings
Creates, updates, deletes, gets or lists an instance_settings resource.
Overview
| Name | instance_settings |
| Type | Resource |
| Id | google.compute.instance_settings |
Fields
The following fields are returned by SELECT queries:
- get
Successful response
| Name | Datatype | Description |
|---|---|---|
fingerprint | string (byte) | Specifies a fingerprint for instance settings, which is essentially a hash of the instance settings resource's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update the instance settings resource. You must always provide an up-to-date fingerprint hash in order to update or change the resource, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the resource. |
kind | string | [Output Only] Type of the resource. Always compute#instance_settings for instance settings. (default: compute#instanceSettings) |
metadata | object | The metadata key/value pairs assigned to all the instances in the corresponding scope. (id: InstanceSettingsMetadata) |
zone | string | [Output Only] URL of the zone where the resource resides You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | project, zone | Get Instance settings. | |
patch | update | project, zone | requestId, updateMask | Patch Instance settings |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
project | string | |
zone | string | |
requestId | string | |
updateMask | string (google-fieldmask) |
SELECT examples
- get
Get Instance settings.
SELECT
fingerprint,
kind,
metadata,
zone
FROM google.compute.instance_settings
WHERE project = '{{ project }}' -- required
AND zone = '{{ zone }}' -- required;
UPDATE examples
- patch
Patch Instance settings
UPDATE google.compute.instance_settings
SET
data__kind = '{{ kind }}',
data__fingerprint = '{{ fingerprint }}',
data__metadata = '{{ metadata }}',
data__zone = '{{ zone }}'
WHERE
project = '{{ project }}' --required
AND zone = '{{ zone }}' --required
AND requestId = '{{ requestId}}'
AND updateMask = '{{ updateMask}}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone;