Compute V1 Client - Class ManagedInstance (1.5.0)

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

A Managed Instance resource.

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

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ current_action`	`string` [Output Only] The current action that the managed instance group has scheduled for the instance. Possible values: - NONE The instance is running, and the managed instance group does not have any scheduled actions for this instance. - CREATING The managed instance group is creating this instance. If the group fails to create this instance, it will try again until it is successful. - CREATING_WITHOUT_RETRIES The managed instance group is attempting to create this instance only once. If the group fails to create this instance, it does not try again and the group's targetSize value is decreased instead. - RECREATING The managed instance group is recreating this instance. - DELETING The managed instance group is permanently deleting this instance. - ABANDONING The managed instance group is abandoning this instance. The instance will be removed from the instance group and from any target pools that are associated with this group. - RESTARTING The managed instance group is restarting the instance. - REFRESHING The managed instance group is applying configuration changes to the instance without stopping it. For example, the group can update the target pool list for an instance without stopping that instance. - VERIFYING The managed instance group has created the instance and it is in the process of being verified. Check the CurrentAction enum for the list of possible values.
`↳ id`	`int\|string` [Output only] The unique identifier for this resource. This field is empty when instance does not exist.
`↳ instance`	`string` [Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created.
`↳ instance_health`	`array<Google\Cloud\Compute\V1\ManagedInstanceInstanceHealth>` [Output Only] Health state of the instance per health-check.
`↳ instance_status`	`string` [Output Only] The status of the instance. This field is empty when the instance does not exist. Check the InstanceStatus enum for the list of possible values.
`↳ last_attempt`	`Google\Cloud\Compute\V1\ManagedInstanceLastAttempt` [Output Only] Information about the last attempt to create or delete the instance.
`↳ preserved_state_from_config`	`Google\Cloud\Compute\V1\PreservedState` [Output Only] Preserved state applied from per-instance config for this instance.
`↳ preserved_state_from_policy`	`Google\Cloud\Compute\V1\PreservedState` [Output Only] Preserved state generated based on stateful policy for this instance.
`↳ version`	`Google\Cloud\Compute\V1\ManagedInstanceVersion` [Output Only] Intended version of this instance.

getCurrentAction

[Output Only] The current action that the managed instance group has scheduled for the instance. Possible values: - NONE The instance is running, and the managed instance group does not have any scheduled actions for this instance. - CREATING The managed instance group is creating this instance. If the group fails to create this instance, it will try again until it is successful. - CREATING_WITHOUT_RETRIES The managed instance group is attempting to create this instance only once. If the group fails to create this instance, it does not try again and the group's targetSize value is decreased instead. - RECREATING The managed instance group is recreating this instance. - DELETING The managed instance group is permanently deleting this instance. - ABANDONING The managed instance group is abandoning this instance. The instance will be removed from the instance group and from any target pools that are associated with this group. - RESTARTING The managed instance group is restarting the instance. - REFRESHING The managed instance group is applying configuration changes to the instance without stopping it. For example, the group can update the target pool list for an instance without stopping that instance. - VERIFYING The managed instance group has created the instance and it is in the process of being verified.

Check the CurrentAction enum for the list of possible values.

Generated from protobuf field optional string current_action = 178475964;

Returns
Type	Description
`string`

hasCurrentAction

clearCurrentAction

setCurrentAction

Check the CurrentAction enum for the list of possible values.

Generated from protobuf field optional string current_action = 178475964;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getId

[Output only] The unique identifier for this resource. This field is empty when instance does not exist.

Generated from protobuf field optional uint64 id = 3355;

Returns
Type	Description
`int\|string`

hasId

clearId

setId

[Output only] The unique identifier for this resource. This field is empty when instance does not exist.

Generated from protobuf field optional uint64 id = 3355;

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getInstance

[Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created.

Generated from protobuf field optional string instance = 18257045;

Returns
Type	Description
`string`

hasInstance

clearInstance

setInstance

[Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created.

Generated from protobuf field optional string instance = 18257045;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getInstanceHealth

[Output Only] Health state of the instance per health-check.

Generated from protobuf field repeated .google.cloud.compute.v1.ManagedInstanceInstanceHealth instance_health = 382667078;

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setInstanceHealth

[Output Only] Health state of the instance per health-check.

Generated from protobuf field repeated .google.cloud.compute.v1.ManagedInstanceInstanceHealth instance_health = 382667078;

Parameter
Name	Description
`var`	`array<Google\Cloud\Compute\V1\ManagedInstanceInstanceHealth>`

Returns
Type	Description
`$this`

getInstanceStatus

[Output Only] The status of the instance. This field is empty when the instance does not exist.

Check the InstanceStatus enum for the list of possible values.

Generated from protobuf field optional string instance_status = 174577372;

Returns
Type	Description
`string`

hasInstanceStatus

clearInstanceStatus

setInstanceStatus

[Output Only] The status of the instance. This field is empty when the instance does not exist.

Check the InstanceStatus enum for the list of possible values.

Generated from protobuf field optional string instance_status = 174577372;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getLastAttempt

[Output Only] Information about the last attempt to create or delete the instance.

Generated from protobuf field optional .google.cloud.compute.v1.ManagedInstanceLastAttempt last_attempt = 434771492;

Returns
Type	Description
`Google\Cloud\Compute\V1\ManagedInstanceLastAttempt\|null`

hasLastAttempt

clearLastAttempt

setLastAttempt

[Output Only] Information about the last attempt to create or delete the instance.

Generated from protobuf field optional .google.cloud.compute.v1.ManagedInstanceLastAttempt last_attempt = 434771492;

Parameter
Name	Description
`var`	`Google\Cloud\Compute\V1\ManagedInstanceLastAttempt`

Returns
Type	Description
`$this`

getPreservedStateFromConfig

[Output Only] Preserved state applied from per-instance config for this instance.

Generated from protobuf field optional .google.cloud.compute.v1.PreservedState preserved_state_from_config = 98661858;

Returns
Type	Description
`Google\Cloud\Compute\V1\PreservedState\|null`

hasPreservedStateFromConfig

clearPreservedStateFromConfig

setPreservedStateFromConfig

[Output Only] Preserved state applied from per-instance config for this instance.

Generated from protobuf field optional .google.cloud.compute.v1.PreservedState preserved_state_from_config = 98661858;

Parameter
Name	Description
`var`	`Google\Cloud\Compute\V1\PreservedState`

Returns
Type	Description
`$this`

getPreservedStateFromPolicy

[Output Only] Preserved state generated based on stateful policy for this instance.

Generated from protobuf field optional .google.cloud.compute.v1.PreservedState preserved_state_from_policy = 470783954;

Returns
Type	Description
`Google\Cloud\Compute\V1\PreservedState\|null`

hasPreservedStateFromPolicy

clearPreservedStateFromPolicy

setPreservedStateFromPolicy

[Output Only] Preserved state generated based on stateful policy for this instance.

Generated from protobuf field optional .google.cloud.compute.v1.PreservedState preserved_state_from_policy = 470783954;

Parameter
Name	Description
`var`	`Google\Cloud\Compute\V1\PreservedState`

Returns
Type	Description
`$this`

getVersion

[Output Only] Intended version of this instance.

Generated from protobuf field optional .google.cloud.compute.v1.ManagedInstanceVersion version = 351608024;

Returns
Type	Description
`Google\Cloud\Compute\V1\ManagedInstanceVersion\|null`

hasVersion

clearVersion

setVersion

[Output Only] Intended version of this instance.

Generated from protobuf field optional .google.cloud.compute.v1.ManagedInstanceVersion version = 351608024;

Parameter
Name	Description
`var`	`Google\Cloud\Compute\V1\ManagedInstanceVersion`

Returns
Type	Description
`$this`