Skip to content

Commit edaafb7

Browse files
feat(osconfig): update the API
#### osconfig:v1beta The following keys were added: - schemas.PatchConfig.properties.skipUnpatchableVms.description - schemas.PatchConfig.properties.skipUnpatchableVms.type - schemas.PatchJobInstanceDetailsSummary.properties.skippedInstanceCount.description - schemas.PatchJobInstanceDetailsSummary.properties.skippedInstanceCount.format - schemas.PatchJobInstanceDetailsSummary.properties.skippedInstanceCount.type The following keys were changed: - schemas.PatchJob.properties.state.enum - schemas.PatchJob.properties.state.enumDescriptions - schemas.PatchJobInstanceDetails.properties.state.enum - schemas.PatchJobInstanceDetails.properties.state.enumDescriptions #### osconfig:v1 The following keys were added: - schemas.PatchConfig.properties.skipUnpatchableVms.description - schemas.PatchConfig.properties.skipUnpatchableVms.type - schemas.PatchJobInstanceDetailsSummary.properties.skippedInstanceCount.description - schemas.PatchJobInstanceDetailsSummary.properties.skippedInstanceCount.format - schemas.PatchJobInstanceDetailsSummary.properties.skippedInstanceCount.type The following keys were changed: - schemas.PatchJob.properties.state.enum - schemas.PatchJob.properties.state.enumDescriptions - schemas.PatchJobInstanceDetails.properties.state.enum - schemas.PatchJobInstanceDetails.properties.state.enumDescriptions
1 parent 01ef29b commit edaafb7

File tree

4 files changed

+48
-6
lines changed

4 files changed

+48
-6
lines changed

discovery/osconfig-v1.json

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1083,7 +1083,7 @@
10831083
}
10841084
}
10851085
},
1086-
"revision": "20250727",
1086+
"revision": "20251030",
10871087
"rootUrl": "https://osconfig.googleapis.com/",
10881088
"schemas": {
10891089
"AptSettings": {
@@ -3061,6 +3061,10 @@
30613061
],
30623062
"type": "string"
30633063
},
3064+
"skipUnpatchableVms": {
3065+
"description": "Optional. Enables enhanced reporting for the patch job: 1. Allows the patch job to skip unpatchable instances, reporting them as SKIPPED. An instance can be unpatchable for two reasons: a. The instance runs Container-Optimized OS (COS), which cannot be patched. b. The patch job's configuration prohibits patching on Managed Instance Groups (MIGs) through the PatchConfig.migInstancesAllowed field, and the instance is part of one. 2. The system reports the patch job as SUCCEEDED if it completes without errors, regardless of whether any instances were SKIPPED. 3. The system reports the patch job as COMPLETED_WITH_INACTIVE_VMS if it completes without errors, but some instances were INACTIVE and therefore not patched.",
3066+
"type": "boolean"
3067+
},
30643068
"windowsUpdate": {
30653069
"$ref": "WindowsUpdateSettings",
30663070
"description": "Windows update settings. Use this override the default windows patch rules."
@@ -3270,6 +3274,7 @@
32703274
"INSTANCE_LOOKUP",
32713275
"PATCHING",
32723276
"SUCCEEDED",
3277+
"COMPLETED_WITH_INACTIVE_VMS",
32733278
"COMPLETED_WITH_ERRORS",
32743279
"CANCELED",
32753280
"TIMED_OUT"
@@ -3280,6 +3285,7 @@
32803285
"The patch job is looking up instances to run the patch on.",
32813286
"Instances are being patched.",
32823287
"Patch job completed successfully.",
3288+
"The patch job completed without errors, but some instances were inactive and therefore not patched.",
32833289
"Patch job completed but there were errors.",
32843290
"The patch job was canceled.",
32853291
"The patch job timed out."
@@ -3333,7 +3339,8 @@
33333339
"TIMED_OUT",
33343340
"RUNNING_PRE_PATCH_STEP",
33353341
"RUNNING_POST_PATCH_STEP",
3336-
"NO_AGENT_DETECTED"
3342+
"NO_AGENT_DETECTED",
3343+
"SKIPPED"
33373344
],
33383345
"enumDescriptions": [
33393346
"Unspecified.",
@@ -3351,7 +3358,8 @@
33513358
"The instance exceeded the time out while applying the patch.",
33523359
"The instance is running the pre-patch step.",
33533360
"The instance is running the post-patch step.",
3354-
"The service could not detect the presence of the agent. Check to ensure that the agent is installed, running, and able to communicate with the service."
3361+
"The service could not detect the presence of the agent. Check to ensure that the agent is installed, running, and able to communicate with the service.",
3362+
"The instance was skipped during patching due to one of two reasons: 1. The instance runs Container-Optimized OS (COS), which cannot be patched. 2. The patch job's configuration prohibits patching on Managed Instance Groups (MIGs), and the instance is part of one."
33553363
],
33563364
"type": "string"
33573365
}
@@ -3417,6 +3425,11 @@
34173425
"format": "int64",
34183426
"type": "string"
34193427
},
3428+
"skippedInstanceCount": {
3429+
"description": "Number of instances that were skipped during patching.",
3430+
"format": "int64",
3431+
"type": "string"
3432+
},
34203433
"startedInstanceCount": {
34213434
"description": "Number of instances that have started.",
34223435
"format": "int64",

discovery/osconfig-v1beta.json

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -689,7 +689,7 @@
689689
}
690690
}
691691
},
692-
"revision": "20250511",
692+
"revision": "20251030",
693693
"rootUrl": "https://osconfig.googleapis.com/",
694694
"schemas": {
695695
"AptRepository": {
@@ -1565,6 +1565,10 @@
15651565
],
15661566
"type": "string"
15671567
},
1568+
"skipUnpatchableVms": {
1569+
"description": "Optional. Enables enhanced reporting for the patch job: 1. Allows the patch job to skip unpatchable instances, reporting them as SKIPPED. An instance can be unpatchable for two reasons: a. The instance runs Container-Optimized OS (COS), which cannot be patched. b. The patch job's configuration prohibits patching on Managed Instance Groups (MIGs) through the PatchConfig.migInstancesAllowed field, and the instance is part of one. 2. The system reports the patch job as SUCCEEDED if it completes without errors, regardless of whether any instances were SKIPPED. 3. The system reports the patch job as COMPLETED_WITH_INACTIVE_VMS if it completes without errors, but some instances were INACTIVE and therefore not patched.",
1570+
"type": "boolean"
1571+
},
15681572
"windowsUpdate": {
15691573
"$ref": "WindowsUpdateSettings",
15701574
"description": "Windows update settings. Use this override the default windows patch rules."
@@ -1774,6 +1778,7 @@
17741778
"INSTANCE_LOOKUP",
17751779
"PATCHING",
17761780
"SUCCEEDED",
1781+
"COMPLETED_WITH_INACTIVE_VMS",
17771782
"COMPLETED_WITH_ERRORS",
17781783
"CANCELED",
17791784
"TIMED_OUT"
@@ -1784,6 +1789,7 @@
17841789
"The patch job is looking up instances to run the patch on.",
17851790
"Instances are being patched.",
17861791
"Patch job completed successfully.",
1792+
"The patch job completed without errors, but some instances were inactive and therefore not patched.",
17871793
"Patch job completed but there were errors.",
17881794
"The patch job was canceled.",
17891795
"The patch job timed out."
@@ -1837,7 +1843,8 @@
18371843
"TIMED_OUT",
18381844
"RUNNING_PRE_PATCH_STEP",
18391845
"RUNNING_POST_PATCH_STEP",
1840-
"NO_AGENT_DETECTED"
1846+
"NO_AGENT_DETECTED",
1847+
"SKIPPED"
18411848
],
18421849
"enumDescriptions": [
18431850
"Unspecified.",
@@ -1855,7 +1862,8 @@
18551862
"The instance exceeded the time out while applying the patch.",
18561863
"The instance is running the pre-patch step.",
18571864
"The instance is running the post-patch step.",
1858-
"The service could not detect the presence of the agent. Check to ensure that the agent is installed, running, and able to communicate with the service."
1865+
"The service could not detect the presence of the agent. Check to ensure that the agent is installed, running, and able to communicate with the service.",
1866+
"The instance was skipped during patching due to one of two reasons: 1. The instance runs Container-Optimized OS (COS), which cannot be patched. 2. The patch job's configuration prohibits patching on Managed Instance Groups (MIGs), and the instance is part of one."
18591867
],
18601868
"type": "string"
18611869
}
@@ -1921,6 +1929,11 @@
19211929
"format": "int64",
19221930
"type": "string"
19231931
},
1932+
"skippedInstanceCount": {
1933+
"description": "Number of instances that were skipped during patching.",
1934+
"format": "int64",
1935+
"type": "string"
1936+
},
19241937
"startedInstanceCount": {
19251938
"description": "Number of instances that have started.",
19261939
"format": "int64",

src/apis/osconfig/v1.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1502,6 +1502,10 @@ export namespace osconfig_v1 {
15021502
* Post-patch reboot settings.
15031503
*/
15041504
rebootConfig?: string | null;
1505+
/**
1506+
* Optional. Enables enhanced reporting for the patch job: 1. Allows the patch job to skip unpatchable instances, reporting them as SKIPPED. An instance can be unpatchable for two reasons: a. The instance runs Container-Optimized OS (COS), which cannot be patched. b. The patch job's configuration prohibits patching on Managed Instance Groups (MIGs) through the PatchConfig.migInstancesAllowed field, and the instance is part of one. 2. The system reports the patch job as SUCCEEDED if it completes without errors, regardless of whether any instances were SKIPPED. 3. The system reports the patch job as COMPLETED_WITH_INACTIVE_VMS if it completes without errors, but some instances were INACTIVE and therefore not patched.
1507+
*/
1508+
skipUnpatchableVms?: boolean | null;
15051509
/**
15061510
* Windows update settings. Use this override the default windows patch rules.
15071511
*/
@@ -1740,6 +1744,10 @@ export namespace osconfig_v1 {
17401744
* Number of instances rebooting.
17411745
*/
17421746
rebootingInstanceCount?: string | null;
1747+
/**
1748+
* Number of instances that were skipped during patching.
1749+
*/
1750+
skippedInstanceCount?: string | null;
17431751
/**
17441752
* Number of instances that have started.
17451753
*/

src/apis/osconfig/v1beta.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -713,6 +713,10 @@ export namespace osconfig_v1beta {
713713
* Post-patch reboot settings.
714714
*/
715715
rebootConfig?: string | null;
716+
/**
717+
* Optional. Enables enhanced reporting for the patch job: 1. Allows the patch job to skip unpatchable instances, reporting them as SKIPPED. An instance can be unpatchable for two reasons: a. The instance runs Container-Optimized OS (COS), which cannot be patched. b. The patch job's configuration prohibits patching on Managed Instance Groups (MIGs) through the PatchConfig.migInstancesAllowed field, and the instance is part of one. 2. The system reports the patch job as SUCCEEDED if it completes without errors, regardless of whether any instances were SKIPPED. 3. The system reports the patch job as COMPLETED_WITH_INACTIVE_VMS if it completes without errors, but some instances were INACTIVE and therefore not patched.
718+
*/
719+
skipUnpatchableVms?: boolean | null;
716720
/**
717721
* Windows update settings. Use this override the default windows patch rules.
718722
*/
@@ -951,6 +955,10 @@ export namespace osconfig_v1beta {
951955
* Number of instances rebooting.
952956
*/
953957
rebootingInstanceCount?: string | null;
958+
/**
959+
* Number of instances that were skipped during patching.
960+
*/
961+
skippedInstanceCount?: string | null;
954962
/**
955963
* Number of instances that have started.
956964
*/

0 commit comments

Comments
 (0)