Reference documentation and code samples for the Google Cloud OsConfig V1 Client class InstanceDetailsSummary.
A summary of the current patch state across all instances that this patch
job affects. Contains counts of instances in different states. These states
map to InstancePatchState. List patch job instance details to see the
specific states of each instance.
Generated from protobuf message google.cloud.osconfig.v1.PatchJob.InstanceDetailsSummary
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ pending_instance_count |
int|string
Number of instances pending patch job. |
↳ inactive_instance_count |
int|string
Number of instances that are inactive. |
↳ notified_instance_count |
int|string
Number of instances notified about patch job. |
↳ started_instance_count |
int|string
Number of instances that have started. |
↳ downloading_patches_instance_count |
int|string
Number of instances that are downloading patches. |
↳ applying_patches_instance_count |
int|string
Number of instances that are applying patches. |
↳ rebooting_instance_count |
int|string
Number of instances rebooting. |
↳ succeeded_instance_count |
int|string
Number of instances that have completed successfully. |
↳ succeeded_reboot_required_instance_count |
int|string
Number of instances that require reboot. |
↳ failed_instance_count |
int|string
Number of instances that failed. |
↳ acked_instance_count |
int|string
Number of instances that have acked and will start shortly. |
↳ timed_out_instance_count |
int|string
Number of instances that exceeded the time out while applying the patch. |
↳ pre_patch_step_instance_count |
int|string
Number of instances that are running the pre-patch step. |
↳ post_patch_step_instance_count |
int|string
Number of instances that are running the post-patch step. |
↳ no_agent_detected_instance_count |
int|string
Number of instances that do not appear to be running the agent. Check to ensure that the agent is installed, running, and able to communicate with the service. |
getPendingInstanceCount
Number of instances pending patch job.
| Returns | |
|---|---|
| Type | Description |
int|string | |
setPendingInstanceCount
Number of instances pending patch job.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getInactiveInstanceCount
Number of instances that are inactive.
| Returns | |
|---|---|
| Type | Description |
int|string | |
setInactiveInstanceCount
Number of instances that are inactive.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getNotifiedInstanceCount
Number of instances notified about patch job.
| Returns | |
|---|---|
| Type | Description |
int|string | |
setNotifiedInstanceCount
Number of instances notified about patch job.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStartedInstanceCount
Number of instances that have started.
| Returns | |
|---|---|
| Type | Description |
int|string | |
setStartedInstanceCount
Number of instances that have started.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDownloadingPatchesInstanceCount
Number of instances that are downloading patches.
| Returns | |
|---|---|
| Type | Description |
int|string | |
setDownloadingPatchesInstanceCount
Number of instances that are downloading patches.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getApplyingPatchesInstanceCount
Number of instances that are applying patches.
| Returns | |
|---|---|
| Type | Description |
int|string | |
setApplyingPatchesInstanceCount
Number of instances that are applying patches.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRebootingInstanceCount
Number of instances rebooting.
| Returns | |
|---|---|
| Type | Description |
int|string | |
setRebootingInstanceCount
Number of instances rebooting.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSucceededInstanceCount
Number of instances that have completed successfully.
| Returns | |
|---|---|
| Type | Description |
int|string | |
setSucceededInstanceCount
Number of instances that have completed successfully.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSucceededRebootRequiredInstanceCount
Number of instances that require reboot.
| Returns | |
|---|---|
| Type | Description |
int|string | |
setSucceededRebootRequiredInstanceCount
Number of instances that require reboot.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFailedInstanceCount
Number of instances that failed.
| Returns | |
|---|---|
| Type | Description |
int|string | |
setFailedInstanceCount
Number of instances that failed.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAckedInstanceCount
Number of instances that have acked and will start shortly.
| Returns | |
|---|---|
| Type | Description |
int|string | |
setAckedInstanceCount
Number of instances that have acked and will start shortly.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getTimedOutInstanceCount
Number of instances that exceeded the time out while applying the patch.
| Returns | |
|---|---|
| Type | Description |
int|string | |
setTimedOutInstanceCount
Number of instances that exceeded the time out while applying the patch.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPrePatchStepInstanceCount
Number of instances that are running the pre-patch step.
| Returns | |
|---|---|
| Type | Description |
int|string | |
setPrePatchStepInstanceCount
Number of instances that are running the pre-patch step.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPostPatchStepInstanceCount
Number of instances that are running the post-patch step.
| Returns | |
|---|---|
| Type | Description |
int|string | |
setPostPatchStepInstanceCount
Number of instances that are running the post-patch step.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getNoAgentDetectedInstanceCount
Number of instances that do not appear to be running the agent. Check to ensure that the agent is installed, running, and able to communicate with the service.
| Returns | |
|---|---|
| Type | Description |
int|string | |
setNoAgentDetectedInstanceCount
Number of instances that do not appear to be running the agent. Check to ensure that the agent is installed, running, and able to communicate with the service.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this | |