Compute V1 Client - Class InstanceSettings (1.17.0)

Reference documentation and code samples for the Compute V1 Client class InstanceSettings.

Represents a Instance Settings resource. You can use instance settings to configure default settings for Compute Engine VM instances. For example, you can use it to configure default machine type of Compute Engine VM instances.

Generated from protobuf message google.cloud.compute.v1.InstanceSettings

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ fingerprint
string

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.

↳ metadata
Google\Cloud\Compute\V1\InstanceSettingsMetadata

The metadata key/value pairs assigned to all the instances in the corresponding scope.

↳ 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.

getFingerprint

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.

Returns
Type
Description
string

hasFingerprint

clearFingerprint

setFingerprint

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.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getKind

[Output Only] Type of the resource. Always compute#instance_settings for instance settings.

Returns
Type
Description
string

hasKind

clearKind

setKind

[Output Only] Type of the resource. Always compute#instance_settings for instance settings.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

The metadata key/value pairs assigned to all the instances in the corresponding scope.

Returns
Type
Description

The metadata key/value pairs assigned to all the instances in the corresponding scope.

Parameter
Name
Description
Returns
Type
Description
$this

getZone

[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.

Returns
Type
Description
string

hasZone

clearZone

setZone

[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.

Parameter
Name
Description
var
string
Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: