Reference documentation and code samples for the Compute V1 Client class PerInstanceConfig.
Generated from protobuf message google.cloud.compute.v1.PerInstanceConfig
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ fingerprint |
string
Fingerprint of this per-instance config. This field can be used in optimistic locking. It is ignored when inserting a per-instance config. An up-to-date fingerprint must be provided in order to update an existing per-instance configuration or the field needs to be unset. |
↳ name |
string
The name of a per-instance configuration and its corresponding instance. Serves as a merge key during UpdatePerInstanceConfigs operations, that is, if a per-instance configuration with the same name exists then it will be updated, otherwise a new one will be created for the VM instance with the same name. An attempt to create a per-instance configconfiguration for a VM instance that either doesn't exist or is not part of the group will result in an error. |
↳ preserved_state |
Google\Cloud\Compute\V1\PreservedState
The intended preserved state for the given instance. Does not contain preserved state generated from a stateful policy. |
↳ status |
string
The status of applying this per-instance configuration on the corresponding managed instance. Check the Status enum for the list of possible values. |
getFingerprint
Fingerprint of this per-instance config. This field can be used in optimistic locking. It is ignored when inserting a per-instance config. An up-to-date fingerprint must be provided in order to update an existing per-instance configuration or the field needs to be unset.
| Returns | |
|---|---|
| Type | Description |
string | |
hasFingerprint
clearFingerprint
setFingerprint
Fingerprint of this per-instance config. This field can be used in optimistic locking. It is ignored when inserting a per-instance config. An up-to-date fingerprint must be provided in order to update an existing per-instance configuration or the field needs to be unset.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getName
The name of a per-instance configuration and its corresponding instance. Serves as a merge key during UpdatePerInstanceConfigs operations, that is, if a per-instance configuration with the same name exists then it will be updated, otherwise a new one will be created for the VM instance with the same name. An attempt to create a per-instance configconfiguration for a VM instance that either doesn't exist or is not part of the group will result in an error.
| Returns | |
|---|---|
| Type | Description |
string | |
hasName
clearName
setName
The name of a per-instance configuration and its corresponding instance. Serves as a merge key during UpdatePerInstanceConfigs operations, that is, if a per-instance configuration with the same name exists then it will be updated, otherwise a new one will be created for the VM instance with the same name. An attempt to create a per-instance configconfiguration for a VM instance that either doesn't exist or is not part of the group will result in an error.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPreservedState
The intended preserved state for the given instance. Does not contain preserved state generated from a stateful policy.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Compute\V1\PreservedState|null | |
hasPreservedState
clearPreservedState
setPreservedState
The intended preserved state for the given instance. Does not contain preserved state generated from a stateful policy.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Compute\V1\PreservedState
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStatus
The status of applying this per-instance configuration on the corresponding managed instance.
Check the Status enum for the list of possible values.
| Returns | |
|---|---|
| Type | Description |
string | |
hasStatus
clearStatus
setStatus
The status of applying this per-instance configuration on the corresponding managed instance.
Check the Status enum for the list of possible values.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |