Compute V1 Client - Class InstanceGroupManagerStatusInstanceStatusSummary (2.9.0)

2.9.0 (latest) 2.8.0 2.7.0 2.6.0 2.5.0 2.4.0 2.3.0 2.2.0 2.1.1 2.0.0 1.36.0 1.35.0 1.34.0 1.33.0 1.32.0 1.31.0 1.30.0 1.29.0 1.28.0 1.27.0 1.26.0 1.25.0 1.24.0 1.23.0 1.22.1 1.21.0 1.20.0 1.19.0 1.18.1 1.17.0 1.16.2 1.14.0 1.13.0 1.12.1 1.11.1 1.10.1 1.9.1 1.8.3 1.7.1 1.6.1 1.5.0

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

The list of instance statuses and the number of instances in this managed instance group that have the status. For more information about how to interpret each status check the instance lifecycle documentation.

Currently only shown for TPU MIGs.

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

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ deprovisioning	int Output only. The number of instances in the managed instance group that have DEPROVISIONING status.
↳ non_existent	int Output only. The number of instances that have not been created yet or have been deleted. Includes only instances that would be shown in the listManagedInstances method and not all instances that have been deleted in the lifetime of the MIG. Does not include FlexStart instances that are waiting for the resources availability, they are considered as 'pending'.
↳ pending	int Output only. The number of instances in the managed instance group that have PENDING status, that is FlexStart instances that are waiting for resources. Instances that do not exist because of the other reasons are counted as 'non_existent'.
↳ pending_stop	int Output only. The number of instances in the managed instance group that have PENDING_STOP status.
↳ provisioning	int Output only. The number of instances in the managed instance group that have PROVISIONING status.
↳ repairing	int Output only. The number of instances in the managed instance group that have REPAIRING status.
↳ running	int Output only. The number of instances in the managed instance group that have RUNNING status.
↳ staging	int Output only. The number of instances in the managed instance group that have STAGING status.
↳ stopped	int Output only. The number of instances in the managed instance group that have STOPPED status.
↳ stopping	int Output only. The number of instances in the managed instance group that have STOPPING status.
↳ suspended	int Output only. The number of instances in the managed instance group that have SUSPENDED status.
↳ suspending	int Output only. The number of instances in the managed instance group that have SUSPENDING status.
↳ terminated	int Output only. The number of instances in the managed instance group that have TERMINATED status.

getDeprovisioning

Output only. The number of instances in the managed instance group that have DEPROVISIONING status.

Returns
Type	Description
int

hasDeprovisioning

clearDeprovisioning

setDeprovisioning

Output only. The number of instances in the managed instance group that have DEPROVISIONING status.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getNonExistent

Output only. The number of instances that have not been created yet or have been deleted. Includes only instances that would be shown in the listManagedInstances method and not all instances that have been deleted in the lifetime of the MIG.

Does not include FlexStart instances that are waiting for the resources availability, they are considered as 'pending'.

Returns
Type	Description
int

hasNonExistent

clearNonExistent

setNonExistent

Output only. The number of instances that have not been created yet or have been deleted. Includes only instances that would be shown in the listManagedInstances method and not all instances that have been deleted in the lifetime of the MIG.

Does not include FlexStart instances that are waiting for the resources availability, they are considered as 'pending'.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getPending

Output only. The number of instances in the managed instance group that have PENDING status, that is FlexStart instances that are waiting for resources. Instances that do not exist because of the other reasons are counted as 'non_existent'.

Returns
Type	Description
int

hasPending

clearPending

setPending

Output only. The number of instances in the managed instance group that have PENDING status, that is FlexStart instances that are waiting for resources. Instances that do not exist because of the other reasons are counted as 'non_existent'.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getPendingStop

Output only. The number of instances in the managed instance group that have PENDING_STOP status.

Returns
Type	Description
int

hasPendingStop

clearPendingStop

setPendingStop

Output only. The number of instances in the managed instance group that have PENDING_STOP status.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getProvisioning

Output only. The number of instances in the managed instance group that have PROVISIONING status.

Returns
Type	Description
int

hasProvisioning

clearProvisioning

setProvisioning

Output only. The number of instances in the managed instance group that have PROVISIONING status.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getRepairing

Output only. The number of instances in the managed instance group that have REPAIRING status.

Returns
Type	Description
int

hasRepairing

clearRepairing

setRepairing

Output only. The number of instances in the managed instance group that have REPAIRING status.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getRunning

Output only. The number of instances in the managed instance group that have RUNNING status.

Returns
Type	Description
int

hasRunning

clearRunning

setRunning

Output only. The number of instances in the managed instance group that have RUNNING status.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getStaging

Output only. The number of instances in the managed instance group that have STAGING status.

Returns
Type	Description
int

hasStaging

clearStaging

setStaging

Output only. The number of instances in the managed instance group that have STAGING status.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getStopped

Output only. The number of instances in the managed instance group that have STOPPED status.

Returns
Type	Description
int

hasStopped

clearStopped

setStopped

Output only. The number of instances in the managed instance group that have STOPPED status.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getStopping

Output only. The number of instances in the managed instance group that have STOPPING status.

Returns
Type	Description
int

hasStopping

clearStopping

setStopping

Output only. The number of instances in the managed instance group that have STOPPING status.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getSuspended

Output only. The number of instances in the managed instance group that have SUSPENDED status.

Returns
Type	Description
int

hasSuspended

clearSuspended

setSuspended

Output only. The number of instances in the managed instance group that have SUSPENDED status.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getSuspending

Output only. The number of instances in the managed instance group that have SUSPENDING status.

Returns
Type	Description
int

hasSuspending

clearSuspending

setSuspending

Output only. The number of instances in the managed instance group that have SUSPENDING status.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getTerminated

Output only. The number of instances in the managed instance group that have TERMINATED status.

Returns
Type	Description
int

hasTerminated

clearTerminated

setTerminated

Output only. The number of instances in the managed instance group that have TERMINATED status.

Parameter
Name	Description
var	int

Returns
Type	Description
$this