docs: update docs/dyn (#1096)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/6f0f288a-a1e8-4b2d-a85f-00b1c6150185/targets
- [ ] To automatically regenerate this PR, check this box.
Source-Link: https://github.com/googleapis/synthtool/commit/39b7149da4026765385403632db3c6f63db96b2c
Source-Link: https://github.com/googleapis/synthtool/commit/9a7d9fbb7045c34c9d3d22c1ff766eeae51f04c9
Source-Link: https://github.com/googleapis/synthtool/commit/dc9903a8c30c3662b6098f0e4a97f221d67268b2
Source-Link: https://github.com/googleapis/synthtool/commit/7fcc405a579d5d53a726ff3da1b7c8c08f0f2d58
Source-Link: https://github.com/googleapis/synthtool/commit/d5fc0bcf9ea9789c5b0e3154a9e3b29e5cea6116
Source-Link: https://github.com/googleapis/synthtool/commit/e89175cf074dccc4babb4eca66ae913696e47a71
Source-Link: https://github.com/googleapis/synthtool/commit/7d652819519dfa24da9e14548232e4aaba71a11c
Source-Link: https://github.com/googleapis/synthtool/commit/7db8a6c5ffb12a6e4c2f799c18f00f7f3d60e279
Source-Link: https://github.com/googleapis/synthtool/commit/1f1148d3c7a7a52f0c98077f976bd9b3c948ee2b
Source-Link: https://github.com/googleapis/synthtool/commit/2c8aecedd55b0480fb4e123b6e07fa5b12953862
Source-Link: https://github.com/googleapis/synthtool/commit/3d3e94c4e02370f307a9a200b0c743c3d8d19f29
Source-Link: https://github.com/googleapis/synthtool/commit/c7824ea48ff6d4d42dfae0849aec8a85acd90bd9
Source-Link: https://github.com/googleapis/synthtool/commit/ba9918cd22874245b55734f57470c719b577e591
Source-Link: https://github.com/googleapis/synthtool/commit/b19b401571e77192f8dd38eab5fb2300a0de9324
Source-Link: https://github.com/googleapis/synthtool/commit/6542bd723403513626f61642fc02ddca528409aa
diff --git a/docs/dyn/osconfig_v1.projects.patchJobs.html b/docs/dyn/osconfig_v1.projects.patchJobs.html
index 21b9a9d..1f98399 100644
--- a/docs/dyn/osconfig_v1.projects.patchJobs.html
+++ b/docs/dyn/osconfig_v1.projects.patchJobs.html
@@ -92,7 +92,7 @@
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Get the patch job. This can be used to track the progress of an ongoing patch job or review the details of completed jobs.</p>
<p class="toc_element">
- <code><a href="#list">list(parent, pageToken=None, filter=None, pageSize=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Get a list of patch jobs.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -119,149 +119,10 @@
An object of the form:
{ # A high level representation of a patch job that is either in progress or has completed. Instance details are not included in the job. To paginate through instance details, use ListPatchJobInstanceDetails. For more information about patch jobs, see [Creating patch jobs](https://cloud.google.com/compute/docs/os-patch-management/create-patch-job).
- "patchConfig": { # Patch configuration specifications. Contains details on how to apply the patch(es) to a VM instance. # Patch configuration being applied.
- "rebootConfig": "A String", # Post-patch reboot settings.
- "postStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run after the patch update.
- "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob.
- "localPath": "A String", # An absolute path to the executable on the VM.
- "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
- "object": "A String", # Required. Name of the Cloud Storage object.
- "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
- "bucket": "A String", # Required. Bucket of the Cloud Storage object.
- },
- "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
- 42,
- ],
- "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
- },
- "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob.
- "localPath": "A String", # An absolute path to the executable on the VM.
- "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
- "object": "A String", # Required. Name of the Cloud Storage object.
- "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
- "bucket": "A String", # Required. Bucket of the Cloud Storage object.
- },
- "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
- 42,
- ],
- "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
- },
- },
- "yum": { # Yum patching is performed by executing `yum update`. Additional options can be set to control how this is executed. Note that not all settings are supported on all platforms. # Yum update settings. Use this setting to override the default `yum` patch rules.
- "minimal": True or False, # Will cause patch to run `yum update-minimal` instead.
- "security": True or False, # Adds the `--security` flag to `yum update`. Not supported on all platforms.
- "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field must not be specified with any other patch configuration fields.
- "A String",
- ],
- "excludes": [ # List of packages to exclude from update. These packages are excluded by using the yum `--exclude` flag.
- "A String",
- ],
- },
- "apt": { # Apt patching is completed by executing `apt-get update && apt-get upgrade`. Additional options can be set to control how this is executed. # Apt update settings. Use this setting to override the default `apt` patch rules.
- "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field cannot be specified with any other patch configuration fields.
- "A String",
- ],
- "type": "A String", # By changing the type to DIST, the patching is performed using `apt-get dist-upgrade` instead.
- "excludes": [ # List of packages to exclude from update. These packages will be excluded
- "A String",
- ],
- },
- "preStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run before the patch update.
- "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob.
- "localPath": "A String", # An absolute path to the executable on the VM.
- "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
- "object": "A String", # Required. Name of the Cloud Storage object.
- "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
- "bucket": "A String", # Required. Bucket of the Cloud Storage object.
- },
- "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
- 42,
- ],
- "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
- },
- "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob.
- "localPath": "A String", # An absolute path to the executable on the VM.
- "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
- "object": "A String", # Required. Name of the Cloud Storage object.
- "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
- "bucket": "A String", # Required. Bucket of the Cloud Storage object.
- },
- "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
- 42,
- ],
- "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
- },
- },
- "goo": { # Googet patching is performed by running `googet update`. # Goo update settings. Use this setting to override the default `goo` patch rules.
- },
- "windowsUpdate": { # Windows patching is performed using the Windows Update Agent. # Windows update settings. Use this override the default windows patch rules.
- "exclusivePatches": [ # An exclusive list of kbs to be updated. These are the only patches that will be updated. This field must not be used with other patch configurations.
- "A String",
- ],
- "classifications": [ # Only apply updates of these windows update classifications. If empty, all updates are applied.
- "A String",
- ],
- "excludes": [ # List of KBs to exclude from update.
- "A String",
- ],
- },
- "zypper": { # Zypper patching is performed by running `zypper patch`. See also https://en.opensuse.org/SDB:Zypper_manual. # Zypper update settings. Use this setting to override the default `zypper` patch rules.
- "exclusivePatches": [ # An exclusive list of patches to be updated. These are the only patches that will be installed using 'zypper patch patch:' command. This field must not be used with any other patch configuration fields.
- "A String",
- ],
- "excludes": [ # List of patches to exclude from update.
- "A String",
- ],
- "categories": [ # Install only patches with these categories. Common categories include security, recommended, and feature.
- "A String",
- ],
- "withUpdate": True or False, # Adds the `--with-update` flag, to `zypper patch`.
- "severities": [ # Install only patches with these severities. Common severities include critical, important, moderate, and low.
- "A String",
- ],
- "withOptional": True or False, # Adds the `--with-optional` flag to `zypper patch`.
- },
- },
- "rollout": { # Patch rollout configuration specifications. Contains details on the concurrency control when applying patch(es) to all targeted VMs. # Rollout strategy being applied.
- "disruptionBudget": { # Message encapsulating a value that can be either absolute ("fixed") or relative ("percent") to a value. # The maximum number (or percentage) of VMs per zone to disrupt at any given moment. The number of VMs calculated from multiplying the percentage by the total number of VMs in a zone is rounded up. During patching, a VM is considered disrupted from the time the agent is notified to begin until patching has completed. This disruption time includes the time to complete reboot and any post-patch steps. A VM contributes to the disruption budget if its patching operation fails either when applying the patches, running pre or post patch steps, or if it fails to respond with a success notification before timing out. VMs that are not running or do not have an active agent do not count toward this disruption budget. For zone-by-zone rollouts, if the disruption budget in a zone is exceeded, the patch job stops, because continuing to the next zone requires completion of the patch process in the previous zone. For example, if the disruption budget has a fixed value of `10`, and 8 VMs fail to patch in the current zone, the patch job continues to patch 2 VMs at a time until the zone is completed. When that zone is completed successfully, patching begins with 10 VMs at a time in the next zone. If 10 VMs in the next zone fail to patch, the patch job stops.
- "fixed": 42, # Specifies a fixed value.
- "percent": 42, # Specifies the relative value defined as a percentage, which will be multiplied by a reference value.
- },
- "mode": "A String", # Mode of the patch rollout.
- },
- "errorMessage": "A String", # If this patch job failed, this message provides information about the failure.
- "patchDeployment": "A String", # Output only. Name of the patch deployment that created this patch job.
- "name": "A String", # Unique identifier for this patch job in the form `projects/*/patchJobs/*`
- "updateTime": "A String", # Last time this patch job was updated.
- "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. # Summary of instance details.
- "applyingPatchesInstanceCount": "A String", # Number of instances that are applying patches.
- "timedOutInstanceCount": "A String", # Number of instances that exceeded the time out while applying the patch.
- "downloadingPatchesInstanceCount": "A String", # Number of instances that are downloading patches.
- "startedInstanceCount": "A String", # Number of instances that have started.
- "ackedInstanceCount": "A String", # Number of instances that have acked and will start shortly.
- "noAgentDetectedInstanceCount": "A 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.
- "succeededRebootRequiredInstanceCount": "A String", # Number of instances that require reboot.
- "rebootingInstanceCount": "A String", # Number of instances rebooting.
- "succeededInstanceCount": "A String", # Number of instances that have completed successfully.
- "postPatchStepInstanceCount": "A String", # Number of instances that are running the post-patch step.
- "notifiedInstanceCount": "A String", # Number of instances notified about patch job.
- "prePatchStepInstanceCount": "A String", # Number of instances that are running the pre-patch step.
- "failedInstanceCount": "A String", # Number of instances that failed.
- "inactiveInstanceCount": "A String", # Number of instances that are inactive.
- "pendingInstanceCount": "A String", # Number of instances pending patch job.
- },
- "state": "A String", # The current state of the PatchJob.
- "percentComplete": 3.14, # Reflects the overall progress of the patch job in the range of 0.0 being no progress to 100.0 being complete.
- "description": "A String", # Description of the patch job. Length of the description is limited to 1024 characters.
- "duration": "A String", # Duration of the patch job. After the duration ends, the patch job times out.
- "displayName": "A String", # Display name for this patch job. This is not a unique identifier.
"instanceFilter": { # A filter to target VM instances for patching. The targeted VMs must meet all criteria specified. So if both labels and zones are specified, the patch job targets only VMs with those labels and in those zones. # Instances to patch.
"zones": [ # Targets VM instances in ANY of these zones. Leave empty to target VM instances in any zone.
"A String",
],
- "instances": [ # Targets any of the VM instances specified. Instances are specified by their URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME]`, `projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`, or `https://www.googleapis.com/compute/v1/projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`
- "A String",
- ],
"groupLabels": [ # Targets VM instances matching ANY of these GroupLabels. This allows targeting of disparate groups of VM instances.
{ # Targets a group of VM instances by using their [assigned labels](https://cloud.google.com/compute/docs/labeling-resources). Labels are key-value pairs. A `GroupLabel` is a combination of labels that is used to target VMs for a patch job. For example, a patch job can target VMs that have the following `GroupLabel`: `{"env":"test", "app":"web"}`. This means that the patch job is applied to VMs that have both the labels `env=test` and `app=web`.
"labels": { # Compute Engine instance labels that must be present for a VM instance to be targeted by this filter.
@@ -269,13 +130,152 @@
},
},
],
- "all": True or False, # Target all VM instances in the project. If true, no other criteria is permitted.
+ "instances": [ # Targets any of the VM instances specified. Instances are specified by their URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME]`, `projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`, or `https://www.googleapis.com/compute/v1/projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`
+ "A String",
+ ],
"instanceNamePrefixes": [ # Targets VMs whose name starts with one of these prefixes. Similar to labels, this is another way to group VMs when targeting configs, for example prefix="prod-".
"A String",
],
+ "all": True or False, # Target all VM instances in the project. If true, no other criteria is permitted.
},
+ "patchConfig": { # Patch configuration specifications. Contains details on how to apply the patch(es) to a VM instance. # Patch configuration being applied.
+ "zypper": { # Zypper patching is performed by running `zypper patch`. See also https://en.opensuse.org/SDB:Zypper_manual. # Zypper update settings. Use this setting to override the default `zypper` patch rules.
+ "categories": [ # Install only patches with these categories. Common categories include security, recommended, and feature.
+ "A String",
+ ],
+ "withUpdate": True or False, # Adds the `--with-update` flag, to `zypper patch`.
+ "withOptional": True or False, # Adds the `--with-optional` flag to `zypper patch`.
+ "excludes": [ # List of patches to exclude from update.
+ "A String",
+ ],
+ "exclusivePatches": [ # An exclusive list of patches to be updated. These are the only patches that will be installed using 'zypper patch patch:' command. This field must not be used with any other patch configuration fields.
+ "A String",
+ ],
+ "severities": [ # Install only patches with these severities. Common severities include critical, important, moderate, and low.
+ "A String",
+ ],
+ },
+ "postStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run after the patch update.
+ "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob.
+ "localPath": "A String", # An absolute path to the executable on the VM.
+ "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
+ "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
+ "bucket": "A String", # Required. Bucket of the Cloud Storage object.
+ "object": "A String", # Required. Name of the Cloud Storage object.
+ },
+ "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
+ "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
+ 42,
+ ],
+ },
+ "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob.
+ "localPath": "A String", # An absolute path to the executable on the VM.
+ "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
+ "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
+ "bucket": "A String", # Required. Bucket of the Cloud Storage object.
+ "object": "A String", # Required. Name of the Cloud Storage object.
+ },
+ "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
+ "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
+ 42,
+ ],
+ },
+ },
+ "rebootConfig": "A String", # Post-patch reboot settings.
+ "apt": { # Apt patching is completed by executing `apt-get update && apt-get upgrade`. Additional options can be set to control how this is executed. # Apt update settings. Use this setting to override the default `apt` patch rules.
+ "excludes": [ # List of packages to exclude from update. These packages will be excluded
+ "A String",
+ ],
+ "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field cannot be specified with any other patch configuration fields.
+ "A String",
+ ],
+ "type": "A String", # By changing the type to DIST, the patching is performed using `apt-get dist-upgrade` instead.
+ },
+ "goo": { # Googet patching is performed by running `googet update`. # Goo update settings. Use this setting to override the default `goo` patch rules.
+ },
+ "windowsUpdate": { # Windows patching is performed using the Windows Update Agent. # Windows update settings. Use this override the default windows patch rules.
+ "exclusivePatches": [ # An exclusive list of kbs to be updated. These are the only patches that will be updated. This field must not be used with other patch configurations.
+ "A String",
+ ],
+ "excludes": [ # List of KBs to exclude from update.
+ "A String",
+ ],
+ "classifications": [ # Only apply updates of these windows update classifications. If empty, all updates are applied.
+ "A String",
+ ],
+ },
+ "preStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run before the patch update.
+ "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob.
+ "localPath": "A String", # An absolute path to the executable on the VM.
+ "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
+ "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
+ "bucket": "A String", # Required. Bucket of the Cloud Storage object.
+ "object": "A String", # Required. Name of the Cloud Storage object.
+ },
+ "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
+ "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
+ 42,
+ ],
+ },
+ "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob.
+ "localPath": "A String", # An absolute path to the executable on the VM.
+ "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
+ "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
+ "bucket": "A String", # Required. Bucket of the Cloud Storage object.
+ "object": "A String", # Required. Name of the Cloud Storage object.
+ },
+ "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
+ "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
+ 42,
+ ],
+ },
+ },
+ "yum": { # Yum patching is performed by executing `yum update`. Additional options can be set to control how this is executed. Note that not all settings are supported on all platforms. # Yum update settings. Use this setting to override the default `yum` patch rules.
+ "minimal": True or False, # Will cause patch to run `yum update-minimal` instead.
+ "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field must not be specified with any other patch configuration fields.
+ "A String",
+ ],
+ "security": True or False, # Adds the `--security` flag to `yum update`. Not supported on all platforms.
+ "excludes": [ # List of packages to exclude from update. These packages are excluded by using the yum `--exclude` flag.
+ "A String",
+ ],
+ },
+ },
+ "errorMessage": "A String", # If this patch job failed, this message provides information about the failure.
+ "state": "A String", # The current state of the PatchJob.
+ "description": "A String", # Description of the patch job. Length of the description is limited to 1024 characters.
+ "patchDeployment": "A String", # Output only. Name of the patch deployment that created this patch job.
"dryRun": True or False, # If this patch job is a dry run, the agent reports that it has finished without running any updates on the VM instance.
+ "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. # Summary of instance details.
+ "ackedInstanceCount": "A String", # Number of instances that have acked and will start shortly.
+ "rebootingInstanceCount": "A String", # Number of instances rebooting.
+ "postPatchStepInstanceCount": "A String", # Number of instances that are running the post-patch step.
+ "inactiveInstanceCount": "A String", # Number of instances that are inactive.
+ "notifiedInstanceCount": "A String", # Number of instances notified about patch job.
+ "startedInstanceCount": "A String", # Number of instances that have started.
+ "prePatchStepInstanceCount": "A String", # Number of instances that are running the pre-patch step.
+ "succeededRebootRequiredInstanceCount": "A String", # Number of instances that require reboot.
+ "pendingInstanceCount": "A String", # Number of instances pending patch job.
+ "noAgentDetectedInstanceCount": "A 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.
+ "succeededInstanceCount": "A String", # Number of instances that have completed successfully.
+ "failedInstanceCount": "A String", # Number of instances that failed.
+ "applyingPatchesInstanceCount": "A String", # Number of instances that are applying patches.
+ "downloadingPatchesInstanceCount": "A String", # Number of instances that are downloading patches.
+ "timedOutInstanceCount": "A String", # Number of instances that exceeded the time out while applying the patch.
+ },
+ "updateTime": "A String", # Last time this patch job was updated.
+ "rollout": { # Patch rollout configuration specifications. Contains details on the concurrency control when applying patch(es) to all targeted VMs. # Rollout strategy being applied.
+ "mode": "A String", # Mode of the patch rollout.
+ "disruptionBudget": { # Message encapsulating a value that can be either absolute ("fixed") or relative ("percent") to a value. # The maximum number (or percentage) of VMs per zone to disrupt at any given moment. The number of VMs calculated from multiplying the percentage by the total number of VMs in a zone is rounded up. During patching, a VM is considered disrupted from the time the agent is notified to begin until patching has completed. This disruption time includes the time to complete reboot and any post-patch steps. A VM contributes to the disruption budget if its patching operation fails either when applying the patches, running pre or post patch steps, or if it fails to respond with a success notification before timing out. VMs that are not running or do not have an active agent do not count toward this disruption budget. For zone-by-zone rollouts, if the disruption budget in a zone is exceeded, the patch job stops, because continuing to the next zone requires completion of the patch process in the previous zone. For example, if the disruption budget has a fixed value of `10`, and 8 VMs fail to patch in the current zone, the patch job continues to patch 2 VMs at a time until the zone is completed. When that zone is completed successfully, patching begins with 10 VMs at a time in the next zone. If 10 VMs in the next zone fail to patch, the patch job stops.
+ "fixed": 42, # Specifies a fixed value.
+ "percent": 42, # Specifies the relative value defined as a percentage, which will be multiplied by a reference value.
+ },
+ },
+ "name": "A String", # Unique identifier for this patch job in the form `projects/*/patchJobs/*`
"createTime": "A String", # Time this patch job was created.
+ "displayName": "A String", # Display name for this patch job. This is not a unique identifier.
+ "duration": "A String", # Duration of the patch job. After the duration ends, the patch job times out.
+ "percentComplete": 3.14, # Reflects the overall progress of the patch job in the range of 0.0 being no progress to 100.0 being complete.
}</pre>
</div>
@@ -294,87 +294,60 @@
The object takes the form of:
{ # A request message to initiate patching across Compute Engine instances.
- "description": "A String", # Description of the patch job. Length of the description is limited to 1024 characters.
- "duration": "A String", # Duration of the patch job. After the duration ends, the patch job times out.
- "rollout": { # Patch rollout configuration specifications. Contains details on the concurrency control when applying patch(es) to all targeted VMs. # Rollout strategy of the patch job.
- "disruptionBudget": { # Message encapsulating a value that can be either absolute ("fixed") or relative ("percent") to a value. # The maximum number (or percentage) of VMs per zone to disrupt at any given moment. The number of VMs calculated from multiplying the percentage by the total number of VMs in a zone is rounded up. During patching, a VM is considered disrupted from the time the agent is notified to begin until patching has completed. This disruption time includes the time to complete reboot and any post-patch steps. A VM contributes to the disruption budget if its patching operation fails either when applying the patches, running pre or post patch steps, or if it fails to respond with a success notification before timing out. VMs that are not running or do not have an active agent do not count toward this disruption budget. For zone-by-zone rollouts, if the disruption budget in a zone is exceeded, the patch job stops, because continuing to the next zone requires completion of the patch process in the previous zone. For example, if the disruption budget has a fixed value of `10`, and 8 VMs fail to patch in the current zone, the patch job continues to patch 2 VMs at a time until the zone is completed. When that zone is completed successfully, patching begins with 10 VMs at a time in the next zone. If 10 VMs in the next zone fail to patch, the patch job stops.
- "fixed": 42, # Specifies a fixed value.
- "percent": 42, # Specifies the relative value defined as a percentage, which will be multiplied by a reference value.
- },
- "mode": "A String", # Mode of the patch rollout.
- },
+ "dryRun": True or False, # If this patch is a dry-run only, instances are contacted but will do nothing.
+ "displayName": "A String", # Display name for this patch job. This does not have to be unique.
"patchConfig": { # Patch configuration specifications. Contains details on how to apply the patch(es) to a VM instance. # Patch configuration being applied. If omitted, instances are patched using the default configurations.
- "rebootConfig": "A String", # Post-patch reboot settings.
+ "zypper": { # Zypper patching is performed by running `zypper patch`. See also https://en.opensuse.org/SDB:Zypper_manual. # Zypper update settings. Use this setting to override the default `zypper` patch rules.
+ "categories": [ # Install only patches with these categories. Common categories include security, recommended, and feature.
+ "A String",
+ ],
+ "withUpdate": True or False, # Adds the `--with-update` flag, to `zypper patch`.
+ "withOptional": True or False, # Adds the `--with-optional` flag to `zypper patch`.
+ "excludes": [ # List of patches to exclude from update.
+ "A String",
+ ],
+ "exclusivePatches": [ # An exclusive list of patches to be updated. These are the only patches that will be installed using 'zypper patch patch:' command. This field must not be used with any other patch configuration fields.
+ "A String",
+ ],
+ "severities": [ # Install only patches with these severities. Common severities include critical, important, moderate, and low.
+ "A String",
+ ],
+ },
"postStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run after the patch update.
- "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob.
- "localPath": "A String", # An absolute path to the executable on the VM.
- "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
- "object": "A String", # Required. Name of the Cloud Storage object.
- "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
- "bucket": "A String", # Required. Bucket of the Cloud Storage object.
- },
- "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
- 42,
- ],
- "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
- },
"linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob.
"localPath": "A String", # An absolute path to the executable on the VM.
"gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
- "object": "A String", # Required. Name of the Cloud Storage object.
"generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
"bucket": "A String", # Required. Bucket of the Cloud Storage object.
+ "object": "A String", # Required. Name of the Cloud Storage object.
},
+ "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
"allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
42,
],
+ },
+ "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob.
+ "localPath": "A String", # An absolute path to the executable on the VM.
+ "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
+ "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
+ "bucket": "A String", # Required. Bucket of the Cloud Storage object.
+ "object": "A String", # Required. Name of the Cloud Storage object.
+ },
"interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
+ "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
+ 42,
+ ],
},
},
- "yum": { # Yum patching is performed by executing `yum update`. Additional options can be set to control how this is executed. Note that not all settings are supported on all platforms. # Yum update settings. Use this setting to override the default `yum` patch rules.
- "minimal": True or False, # Will cause patch to run `yum update-minimal` instead.
- "security": True or False, # Adds the `--security` flag to `yum update`. Not supported on all platforms.
- "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field must not be specified with any other patch configuration fields.
- "A String",
- ],
- "excludes": [ # List of packages to exclude from update. These packages are excluded by using the yum `--exclude` flag.
- "A String",
- ],
- },
+ "rebootConfig": "A String", # Post-patch reboot settings.
"apt": { # Apt patching is completed by executing `apt-get update && apt-get upgrade`. Additional options can be set to control how this is executed. # Apt update settings. Use this setting to override the default `apt` patch rules.
+ "excludes": [ # List of packages to exclude from update. These packages will be excluded
+ "A String",
+ ],
"exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field cannot be specified with any other patch configuration fields.
"A String",
],
"type": "A String", # By changing the type to DIST, the patching is performed using `apt-get dist-upgrade` instead.
- "excludes": [ # List of packages to exclude from update. These packages will be excluded
- "A String",
- ],
- },
- "preStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run before the patch update.
- "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob.
- "localPath": "A String", # An absolute path to the executable on the VM.
- "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
- "object": "A String", # Required. Name of the Cloud Storage object.
- "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
- "bucket": "A String", # Required. Bucket of the Cloud Storage object.
- },
- "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
- 42,
- ],
- "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
- },
- "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob.
- "localPath": "A String", # An absolute path to the executable on the VM.
- "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
- "object": "A String", # Required. Name of the Cloud Storage object.
- "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
- "bucket": "A String", # Required. Bucket of the Cloud Storage object.
- },
- "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
- 42,
- ],
- "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
- },
},
"goo": { # Googet patching is performed by running `googet update`. # Goo update settings. Use this setting to override the default `goo` patch rules.
},
@@ -382,38 +355,54 @@
"exclusivePatches": [ # An exclusive list of kbs to be updated. These are the only patches that will be updated. This field must not be used with other patch configurations.
"A String",
],
- "classifications": [ # Only apply updates of these windows update classifications. If empty, all updates are applied.
- "A String",
- ],
"excludes": [ # List of KBs to exclude from update.
"A String",
],
+ "classifications": [ # Only apply updates of these windows update classifications. If empty, all updates are applied.
+ "A String",
+ ],
},
- "zypper": { # Zypper patching is performed by running `zypper patch`. See also https://en.opensuse.org/SDB:Zypper_manual. # Zypper update settings. Use this setting to override the default `zypper` patch rules.
- "exclusivePatches": [ # An exclusive list of patches to be updated. These are the only patches that will be installed using 'zypper patch patch:' command. This field must not be used with any other patch configuration fields.
+ "preStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run before the patch update.
+ "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob.
+ "localPath": "A String", # An absolute path to the executable on the VM.
+ "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
+ "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
+ "bucket": "A String", # Required. Bucket of the Cloud Storage object.
+ "object": "A String", # Required. Name of the Cloud Storage object.
+ },
+ "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
+ "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
+ 42,
+ ],
+ },
+ "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob.
+ "localPath": "A String", # An absolute path to the executable on the VM.
+ "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
+ "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
+ "bucket": "A String", # Required. Bucket of the Cloud Storage object.
+ "object": "A String", # Required. Name of the Cloud Storage object.
+ },
+ "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
+ "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
+ 42,
+ ],
+ },
+ },
+ "yum": { # Yum patching is performed by executing `yum update`. Additional options can be set to control how this is executed. Note that not all settings are supported on all platforms. # Yum update settings. Use this setting to override the default `yum` patch rules.
+ "minimal": True or False, # Will cause patch to run `yum update-minimal` instead.
+ "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field must not be specified with any other patch configuration fields.
"A String",
],
- "excludes": [ # List of patches to exclude from update.
+ "security": True or False, # Adds the `--security` flag to `yum update`. Not supported on all platforms.
+ "excludes": [ # List of packages to exclude from update. These packages are excluded by using the yum `--exclude` flag.
"A String",
],
- "categories": [ # Install only patches with these categories. Common categories include security, recommended, and feature.
- "A String",
- ],
- "withUpdate": True or False, # Adds the `--with-update` flag, to `zypper patch`.
- "severities": [ # Install only patches with these severities. Common severities include critical, important, moderate, and low.
- "A String",
- ],
- "withOptional": True or False, # Adds the `--with-optional` flag to `zypper patch`.
},
},
- "dryRun": True or False, # If this patch is a dry-run only, instances are contacted but will do nothing.
"instanceFilter": { # A filter to target VM instances for patching. The targeted VMs must meet all criteria specified. So if both labels and zones are specified, the patch job targets only VMs with those labels and in those zones. # Required. Instances to patch, either explicitly or filtered by some criteria such as zone or labels.
"zones": [ # Targets VM instances in ANY of these zones. Leave empty to target VM instances in any zone.
"A String",
],
- "instances": [ # Targets any of the VM instances specified. Instances are specified by their URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME]`, `projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`, or `https://www.googleapis.com/compute/v1/projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`
- "A String",
- ],
"groupLabels": [ # Targets VM instances matching ANY of these GroupLabels. This allows targeting of disparate groups of VM instances.
{ # Targets a group of VM instances by using their [assigned labels](https://cloud.google.com/compute/docs/labeling-resources). Labels are key-value pairs. A `GroupLabel` is a combination of labels that is used to target VMs for a patch job. For example, a patch job can target VMs that have the following `GroupLabel`: `{"env":"test", "app":"web"}`. This means that the patch job is applied to VMs that have both the labels `env=test` and `app=web`.
"labels": { # Compute Engine instance labels that must be present for a VM instance to be targeted by this filter.
@@ -421,12 +410,23 @@
},
},
],
- "all": True or False, # Target all VM instances in the project. If true, no other criteria is permitted.
+ "instances": [ # Targets any of the VM instances specified. Instances are specified by their URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME]`, `projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`, or `https://www.googleapis.com/compute/v1/projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`
+ "A String",
+ ],
"instanceNamePrefixes": [ # Targets VMs whose name starts with one of these prefixes. Similar to labels, this is another way to group VMs when targeting configs, for example prefix="prod-".
"A String",
],
+ "all": True or False, # Target all VM instances in the project. If true, no other criteria is permitted.
},
- "displayName": "A String", # Display name for this patch job. This does not have to be unique.
+ "duration": "A String", # Duration of the patch job. After the duration ends, the patch job times out.
+ "rollout": { # Patch rollout configuration specifications. Contains details on the concurrency control when applying patch(es) to all targeted VMs. # Rollout strategy of the patch job.
+ "mode": "A String", # Mode of the patch rollout.
+ "disruptionBudget": { # Message encapsulating a value that can be either absolute ("fixed") or relative ("percent") to a value. # The maximum number (or percentage) of VMs per zone to disrupt at any given moment. The number of VMs calculated from multiplying the percentage by the total number of VMs in a zone is rounded up. During patching, a VM is considered disrupted from the time the agent is notified to begin until patching has completed. This disruption time includes the time to complete reboot and any post-patch steps. A VM contributes to the disruption budget if its patching operation fails either when applying the patches, running pre or post patch steps, or if it fails to respond with a success notification before timing out. VMs that are not running or do not have an active agent do not count toward this disruption budget. For zone-by-zone rollouts, if the disruption budget in a zone is exceeded, the patch job stops, because continuing to the next zone requires completion of the patch process in the previous zone. For example, if the disruption budget has a fixed value of `10`, and 8 VMs fail to patch in the current zone, the patch job continues to patch 2 VMs at a time until the zone is completed. When that zone is completed successfully, patching begins with 10 VMs at a time in the next zone. If 10 VMs in the next zone fail to patch, the patch job stops.
+ "fixed": 42, # Specifies a fixed value.
+ "percent": 42, # Specifies the relative value defined as a percentage, which will be multiplied by a reference value.
+ },
+ },
+ "description": "A String", # Description of the patch job. Length of the description is limited to 1024 characters.
}
x__xgafv: string, V1 error format.
@@ -438,149 +438,10 @@
An object of the form:
{ # A high level representation of a patch job that is either in progress or has completed. Instance details are not included in the job. To paginate through instance details, use ListPatchJobInstanceDetails. For more information about patch jobs, see [Creating patch jobs](https://cloud.google.com/compute/docs/os-patch-management/create-patch-job).
- "patchConfig": { # Patch configuration specifications. Contains details on how to apply the patch(es) to a VM instance. # Patch configuration being applied.
- "rebootConfig": "A String", # Post-patch reboot settings.
- "postStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run after the patch update.
- "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob.
- "localPath": "A String", # An absolute path to the executable on the VM.
- "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
- "object": "A String", # Required. Name of the Cloud Storage object.
- "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
- "bucket": "A String", # Required. Bucket of the Cloud Storage object.
- },
- "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
- 42,
- ],
- "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
- },
- "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob.
- "localPath": "A String", # An absolute path to the executable on the VM.
- "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
- "object": "A String", # Required. Name of the Cloud Storage object.
- "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
- "bucket": "A String", # Required. Bucket of the Cloud Storage object.
- },
- "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
- 42,
- ],
- "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
- },
- },
- "yum": { # Yum patching is performed by executing `yum update`. Additional options can be set to control how this is executed. Note that not all settings are supported on all platforms. # Yum update settings. Use this setting to override the default `yum` patch rules.
- "minimal": True or False, # Will cause patch to run `yum update-minimal` instead.
- "security": True or False, # Adds the `--security` flag to `yum update`. Not supported on all platforms.
- "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field must not be specified with any other patch configuration fields.
- "A String",
- ],
- "excludes": [ # List of packages to exclude from update. These packages are excluded by using the yum `--exclude` flag.
- "A String",
- ],
- },
- "apt": { # Apt patching is completed by executing `apt-get update && apt-get upgrade`. Additional options can be set to control how this is executed. # Apt update settings. Use this setting to override the default `apt` patch rules.
- "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field cannot be specified with any other patch configuration fields.
- "A String",
- ],
- "type": "A String", # By changing the type to DIST, the patching is performed using `apt-get dist-upgrade` instead.
- "excludes": [ # List of packages to exclude from update. These packages will be excluded
- "A String",
- ],
- },
- "preStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run before the patch update.
- "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob.
- "localPath": "A String", # An absolute path to the executable on the VM.
- "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
- "object": "A String", # Required. Name of the Cloud Storage object.
- "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
- "bucket": "A String", # Required. Bucket of the Cloud Storage object.
- },
- "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
- 42,
- ],
- "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
- },
- "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob.
- "localPath": "A String", # An absolute path to the executable on the VM.
- "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
- "object": "A String", # Required. Name of the Cloud Storage object.
- "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
- "bucket": "A String", # Required. Bucket of the Cloud Storage object.
- },
- "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
- 42,
- ],
- "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
- },
- },
- "goo": { # Googet patching is performed by running `googet update`. # Goo update settings. Use this setting to override the default `goo` patch rules.
- },
- "windowsUpdate": { # Windows patching is performed using the Windows Update Agent. # Windows update settings. Use this override the default windows patch rules.
- "exclusivePatches": [ # An exclusive list of kbs to be updated. These are the only patches that will be updated. This field must not be used with other patch configurations.
- "A String",
- ],
- "classifications": [ # Only apply updates of these windows update classifications. If empty, all updates are applied.
- "A String",
- ],
- "excludes": [ # List of KBs to exclude from update.
- "A String",
- ],
- },
- "zypper": { # Zypper patching is performed by running `zypper patch`. See also https://en.opensuse.org/SDB:Zypper_manual. # Zypper update settings. Use this setting to override the default `zypper` patch rules.
- "exclusivePatches": [ # An exclusive list of patches to be updated. These are the only patches that will be installed using 'zypper patch patch:' command. This field must not be used with any other patch configuration fields.
- "A String",
- ],
- "excludes": [ # List of patches to exclude from update.
- "A String",
- ],
- "categories": [ # Install only patches with these categories. Common categories include security, recommended, and feature.
- "A String",
- ],
- "withUpdate": True or False, # Adds the `--with-update` flag, to `zypper patch`.
- "severities": [ # Install only patches with these severities. Common severities include critical, important, moderate, and low.
- "A String",
- ],
- "withOptional": True or False, # Adds the `--with-optional` flag to `zypper patch`.
- },
- },
- "rollout": { # Patch rollout configuration specifications. Contains details on the concurrency control when applying patch(es) to all targeted VMs. # Rollout strategy being applied.
- "disruptionBudget": { # Message encapsulating a value that can be either absolute ("fixed") or relative ("percent") to a value. # The maximum number (or percentage) of VMs per zone to disrupt at any given moment. The number of VMs calculated from multiplying the percentage by the total number of VMs in a zone is rounded up. During patching, a VM is considered disrupted from the time the agent is notified to begin until patching has completed. This disruption time includes the time to complete reboot and any post-patch steps. A VM contributes to the disruption budget if its patching operation fails either when applying the patches, running pre or post patch steps, or if it fails to respond with a success notification before timing out. VMs that are not running or do not have an active agent do not count toward this disruption budget. For zone-by-zone rollouts, if the disruption budget in a zone is exceeded, the patch job stops, because continuing to the next zone requires completion of the patch process in the previous zone. For example, if the disruption budget has a fixed value of `10`, and 8 VMs fail to patch in the current zone, the patch job continues to patch 2 VMs at a time until the zone is completed. When that zone is completed successfully, patching begins with 10 VMs at a time in the next zone. If 10 VMs in the next zone fail to patch, the patch job stops.
- "fixed": 42, # Specifies a fixed value.
- "percent": 42, # Specifies the relative value defined as a percentage, which will be multiplied by a reference value.
- },
- "mode": "A String", # Mode of the patch rollout.
- },
- "errorMessage": "A String", # If this patch job failed, this message provides information about the failure.
- "patchDeployment": "A String", # Output only. Name of the patch deployment that created this patch job.
- "name": "A String", # Unique identifier for this patch job in the form `projects/*/patchJobs/*`
- "updateTime": "A String", # Last time this patch job was updated.
- "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. # Summary of instance details.
- "applyingPatchesInstanceCount": "A String", # Number of instances that are applying patches.
- "timedOutInstanceCount": "A String", # Number of instances that exceeded the time out while applying the patch.
- "downloadingPatchesInstanceCount": "A String", # Number of instances that are downloading patches.
- "startedInstanceCount": "A String", # Number of instances that have started.
- "ackedInstanceCount": "A String", # Number of instances that have acked and will start shortly.
- "noAgentDetectedInstanceCount": "A 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.
- "succeededRebootRequiredInstanceCount": "A String", # Number of instances that require reboot.
- "rebootingInstanceCount": "A String", # Number of instances rebooting.
- "succeededInstanceCount": "A String", # Number of instances that have completed successfully.
- "postPatchStepInstanceCount": "A String", # Number of instances that are running the post-patch step.
- "notifiedInstanceCount": "A String", # Number of instances notified about patch job.
- "prePatchStepInstanceCount": "A String", # Number of instances that are running the pre-patch step.
- "failedInstanceCount": "A String", # Number of instances that failed.
- "inactiveInstanceCount": "A String", # Number of instances that are inactive.
- "pendingInstanceCount": "A String", # Number of instances pending patch job.
- },
- "state": "A String", # The current state of the PatchJob.
- "percentComplete": 3.14, # Reflects the overall progress of the patch job in the range of 0.0 being no progress to 100.0 being complete.
- "description": "A String", # Description of the patch job. Length of the description is limited to 1024 characters.
- "duration": "A String", # Duration of the patch job. After the duration ends, the patch job times out.
- "displayName": "A String", # Display name for this patch job. This is not a unique identifier.
"instanceFilter": { # A filter to target VM instances for patching. The targeted VMs must meet all criteria specified. So if both labels and zones are specified, the patch job targets only VMs with those labels and in those zones. # Instances to patch.
"zones": [ # Targets VM instances in ANY of these zones. Leave empty to target VM instances in any zone.
"A String",
],
- "instances": [ # Targets any of the VM instances specified. Instances are specified by their URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME]`, `projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`, or `https://www.googleapis.com/compute/v1/projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`
- "A String",
- ],
"groupLabels": [ # Targets VM instances matching ANY of these GroupLabels. This allows targeting of disparate groups of VM instances.
{ # Targets a group of VM instances by using their [assigned labels](https://cloud.google.com/compute/docs/labeling-resources). Labels are key-value pairs. A `GroupLabel` is a combination of labels that is used to target VMs for a patch job. For example, a patch job can target VMs that have the following `GroupLabel`: `{"env":"test", "app":"web"}`. This means that the patch job is applied to VMs that have both the labels `env=test` and `app=web`.
"labels": { # Compute Engine instance labels that must be present for a VM instance to be targeted by this filter.
@@ -588,13 +449,152 @@
},
},
],
- "all": True or False, # Target all VM instances in the project. If true, no other criteria is permitted.
+ "instances": [ # Targets any of the VM instances specified. Instances are specified by their URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME]`, `projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`, or `https://www.googleapis.com/compute/v1/projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`
+ "A String",
+ ],
"instanceNamePrefixes": [ # Targets VMs whose name starts with one of these prefixes. Similar to labels, this is another way to group VMs when targeting configs, for example prefix="prod-".
"A String",
],
+ "all": True or False, # Target all VM instances in the project. If true, no other criteria is permitted.
},
+ "patchConfig": { # Patch configuration specifications. Contains details on how to apply the patch(es) to a VM instance. # Patch configuration being applied.
+ "zypper": { # Zypper patching is performed by running `zypper patch`. See also https://en.opensuse.org/SDB:Zypper_manual. # Zypper update settings. Use this setting to override the default `zypper` patch rules.
+ "categories": [ # Install only patches with these categories. Common categories include security, recommended, and feature.
+ "A String",
+ ],
+ "withUpdate": True or False, # Adds the `--with-update` flag, to `zypper patch`.
+ "withOptional": True or False, # Adds the `--with-optional` flag to `zypper patch`.
+ "excludes": [ # List of patches to exclude from update.
+ "A String",
+ ],
+ "exclusivePatches": [ # An exclusive list of patches to be updated. These are the only patches that will be installed using 'zypper patch patch:' command. This field must not be used with any other patch configuration fields.
+ "A String",
+ ],
+ "severities": [ # Install only patches with these severities. Common severities include critical, important, moderate, and low.
+ "A String",
+ ],
+ },
+ "postStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run after the patch update.
+ "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob.
+ "localPath": "A String", # An absolute path to the executable on the VM.
+ "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
+ "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
+ "bucket": "A String", # Required. Bucket of the Cloud Storage object.
+ "object": "A String", # Required. Name of the Cloud Storage object.
+ },
+ "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
+ "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
+ 42,
+ ],
+ },
+ "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob.
+ "localPath": "A String", # An absolute path to the executable on the VM.
+ "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
+ "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
+ "bucket": "A String", # Required. Bucket of the Cloud Storage object.
+ "object": "A String", # Required. Name of the Cloud Storage object.
+ },
+ "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
+ "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
+ 42,
+ ],
+ },
+ },
+ "rebootConfig": "A String", # Post-patch reboot settings.
+ "apt": { # Apt patching is completed by executing `apt-get update && apt-get upgrade`. Additional options can be set to control how this is executed. # Apt update settings. Use this setting to override the default `apt` patch rules.
+ "excludes": [ # List of packages to exclude from update. These packages will be excluded
+ "A String",
+ ],
+ "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field cannot be specified with any other patch configuration fields.
+ "A String",
+ ],
+ "type": "A String", # By changing the type to DIST, the patching is performed using `apt-get dist-upgrade` instead.
+ },
+ "goo": { # Googet patching is performed by running `googet update`. # Goo update settings. Use this setting to override the default `goo` patch rules.
+ },
+ "windowsUpdate": { # Windows patching is performed using the Windows Update Agent. # Windows update settings. Use this override the default windows patch rules.
+ "exclusivePatches": [ # An exclusive list of kbs to be updated. These are the only patches that will be updated. This field must not be used with other patch configurations.
+ "A String",
+ ],
+ "excludes": [ # List of KBs to exclude from update.
+ "A String",
+ ],
+ "classifications": [ # Only apply updates of these windows update classifications. If empty, all updates are applied.
+ "A String",
+ ],
+ },
+ "preStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run before the patch update.
+ "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob.
+ "localPath": "A String", # An absolute path to the executable on the VM.
+ "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
+ "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
+ "bucket": "A String", # Required. Bucket of the Cloud Storage object.
+ "object": "A String", # Required. Name of the Cloud Storage object.
+ },
+ "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
+ "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
+ 42,
+ ],
+ },
+ "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob.
+ "localPath": "A String", # An absolute path to the executable on the VM.
+ "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
+ "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
+ "bucket": "A String", # Required. Bucket of the Cloud Storage object.
+ "object": "A String", # Required. Name of the Cloud Storage object.
+ },
+ "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
+ "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
+ 42,
+ ],
+ },
+ },
+ "yum": { # Yum patching is performed by executing `yum update`. Additional options can be set to control how this is executed. Note that not all settings are supported on all platforms. # Yum update settings. Use this setting to override the default `yum` patch rules.
+ "minimal": True or False, # Will cause patch to run `yum update-minimal` instead.
+ "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field must not be specified with any other patch configuration fields.
+ "A String",
+ ],
+ "security": True or False, # Adds the `--security` flag to `yum update`. Not supported on all platforms.
+ "excludes": [ # List of packages to exclude from update. These packages are excluded by using the yum `--exclude` flag.
+ "A String",
+ ],
+ },
+ },
+ "errorMessage": "A String", # If this patch job failed, this message provides information about the failure.
+ "state": "A String", # The current state of the PatchJob.
+ "description": "A String", # Description of the patch job. Length of the description is limited to 1024 characters.
+ "patchDeployment": "A String", # Output only. Name of the patch deployment that created this patch job.
"dryRun": True or False, # If this patch job is a dry run, the agent reports that it has finished without running any updates on the VM instance.
+ "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. # Summary of instance details.
+ "ackedInstanceCount": "A String", # Number of instances that have acked and will start shortly.
+ "rebootingInstanceCount": "A String", # Number of instances rebooting.
+ "postPatchStepInstanceCount": "A String", # Number of instances that are running the post-patch step.
+ "inactiveInstanceCount": "A String", # Number of instances that are inactive.
+ "notifiedInstanceCount": "A String", # Number of instances notified about patch job.
+ "startedInstanceCount": "A String", # Number of instances that have started.
+ "prePatchStepInstanceCount": "A String", # Number of instances that are running the pre-patch step.
+ "succeededRebootRequiredInstanceCount": "A String", # Number of instances that require reboot.
+ "pendingInstanceCount": "A String", # Number of instances pending patch job.
+ "noAgentDetectedInstanceCount": "A 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.
+ "succeededInstanceCount": "A String", # Number of instances that have completed successfully.
+ "failedInstanceCount": "A String", # Number of instances that failed.
+ "applyingPatchesInstanceCount": "A String", # Number of instances that are applying patches.
+ "downloadingPatchesInstanceCount": "A String", # Number of instances that are downloading patches.
+ "timedOutInstanceCount": "A String", # Number of instances that exceeded the time out while applying the patch.
+ },
+ "updateTime": "A String", # Last time this patch job was updated.
+ "rollout": { # Patch rollout configuration specifications. Contains details on the concurrency control when applying patch(es) to all targeted VMs. # Rollout strategy being applied.
+ "mode": "A String", # Mode of the patch rollout.
+ "disruptionBudget": { # Message encapsulating a value that can be either absolute ("fixed") or relative ("percent") to a value. # The maximum number (or percentage) of VMs per zone to disrupt at any given moment. The number of VMs calculated from multiplying the percentage by the total number of VMs in a zone is rounded up. During patching, a VM is considered disrupted from the time the agent is notified to begin until patching has completed. This disruption time includes the time to complete reboot and any post-patch steps. A VM contributes to the disruption budget if its patching operation fails either when applying the patches, running pre or post patch steps, or if it fails to respond with a success notification before timing out. VMs that are not running or do not have an active agent do not count toward this disruption budget. For zone-by-zone rollouts, if the disruption budget in a zone is exceeded, the patch job stops, because continuing to the next zone requires completion of the patch process in the previous zone. For example, if the disruption budget has a fixed value of `10`, and 8 VMs fail to patch in the current zone, the patch job continues to patch 2 VMs at a time until the zone is completed. When that zone is completed successfully, patching begins with 10 VMs at a time in the next zone. If 10 VMs in the next zone fail to patch, the patch job stops.
+ "fixed": 42, # Specifies a fixed value.
+ "percent": 42, # Specifies the relative value defined as a percentage, which will be multiplied by a reference value.
+ },
+ },
+ "name": "A String", # Unique identifier for this patch job in the form `projects/*/patchJobs/*`
"createTime": "A String", # Time this patch job was created.
+ "displayName": "A String", # Display name for this patch job. This is not a unique identifier.
+ "duration": "A String", # Duration of the patch job. After the duration ends, the patch job times out.
+ "percentComplete": 3.14, # Reflects the overall progress of the patch job in the range of 0.0 being no progress to 100.0 being complete.
}</pre>
</div>
@@ -613,149 +613,10 @@
An object of the form:
{ # A high level representation of a patch job that is either in progress or has completed. Instance details are not included in the job. To paginate through instance details, use ListPatchJobInstanceDetails. For more information about patch jobs, see [Creating patch jobs](https://cloud.google.com/compute/docs/os-patch-management/create-patch-job).
- "patchConfig": { # Patch configuration specifications. Contains details on how to apply the patch(es) to a VM instance. # Patch configuration being applied.
- "rebootConfig": "A String", # Post-patch reboot settings.
- "postStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run after the patch update.
- "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob.
- "localPath": "A String", # An absolute path to the executable on the VM.
- "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
- "object": "A String", # Required. Name of the Cloud Storage object.
- "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
- "bucket": "A String", # Required. Bucket of the Cloud Storage object.
- },
- "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
- 42,
- ],
- "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
- },
- "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob.
- "localPath": "A String", # An absolute path to the executable on the VM.
- "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
- "object": "A String", # Required. Name of the Cloud Storage object.
- "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
- "bucket": "A String", # Required. Bucket of the Cloud Storage object.
- },
- "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
- 42,
- ],
- "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
- },
- },
- "yum": { # Yum patching is performed by executing `yum update`. Additional options can be set to control how this is executed. Note that not all settings are supported on all platforms. # Yum update settings. Use this setting to override the default `yum` patch rules.
- "minimal": True or False, # Will cause patch to run `yum update-minimal` instead.
- "security": True or False, # Adds the `--security` flag to `yum update`. Not supported on all platforms.
- "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field must not be specified with any other patch configuration fields.
- "A String",
- ],
- "excludes": [ # List of packages to exclude from update. These packages are excluded by using the yum `--exclude` flag.
- "A String",
- ],
- },
- "apt": { # Apt patching is completed by executing `apt-get update && apt-get upgrade`. Additional options can be set to control how this is executed. # Apt update settings. Use this setting to override the default `apt` patch rules.
- "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field cannot be specified with any other patch configuration fields.
- "A String",
- ],
- "type": "A String", # By changing the type to DIST, the patching is performed using `apt-get dist-upgrade` instead.
- "excludes": [ # List of packages to exclude from update. These packages will be excluded
- "A String",
- ],
- },
- "preStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run before the patch update.
- "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob.
- "localPath": "A String", # An absolute path to the executable on the VM.
- "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
- "object": "A String", # Required. Name of the Cloud Storage object.
- "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
- "bucket": "A String", # Required. Bucket of the Cloud Storage object.
- },
- "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
- 42,
- ],
- "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
- },
- "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob.
- "localPath": "A String", # An absolute path to the executable on the VM.
- "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
- "object": "A String", # Required. Name of the Cloud Storage object.
- "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
- "bucket": "A String", # Required. Bucket of the Cloud Storage object.
- },
- "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
- 42,
- ],
- "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
- },
- },
- "goo": { # Googet patching is performed by running `googet update`. # Goo update settings. Use this setting to override the default `goo` patch rules.
- },
- "windowsUpdate": { # Windows patching is performed using the Windows Update Agent. # Windows update settings. Use this override the default windows patch rules.
- "exclusivePatches": [ # An exclusive list of kbs to be updated. These are the only patches that will be updated. This field must not be used with other patch configurations.
- "A String",
- ],
- "classifications": [ # Only apply updates of these windows update classifications. If empty, all updates are applied.
- "A String",
- ],
- "excludes": [ # List of KBs to exclude from update.
- "A String",
- ],
- },
- "zypper": { # Zypper patching is performed by running `zypper patch`. See also https://en.opensuse.org/SDB:Zypper_manual. # Zypper update settings. Use this setting to override the default `zypper` patch rules.
- "exclusivePatches": [ # An exclusive list of patches to be updated. These are the only patches that will be installed using 'zypper patch patch:' command. This field must not be used with any other patch configuration fields.
- "A String",
- ],
- "excludes": [ # List of patches to exclude from update.
- "A String",
- ],
- "categories": [ # Install only patches with these categories. Common categories include security, recommended, and feature.
- "A String",
- ],
- "withUpdate": True or False, # Adds the `--with-update` flag, to `zypper patch`.
- "severities": [ # Install only patches with these severities. Common severities include critical, important, moderate, and low.
- "A String",
- ],
- "withOptional": True or False, # Adds the `--with-optional` flag to `zypper patch`.
- },
- },
- "rollout": { # Patch rollout configuration specifications. Contains details on the concurrency control when applying patch(es) to all targeted VMs. # Rollout strategy being applied.
- "disruptionBudget": { # Message encapsulating a value that can be either absolute ("fixed") or relative ("percent") to a value. # The maximum number (or percentage) of VMs per zone to disrupt at any given moment. The number of VMs calculated from multiplying the percentage by the total number of VMs in a zone is rounded up. During patching, a VM is considered disrupted from the time the agent is notified to begin until patching has completed. This disruption time includes the time to complete reboot and any post-patch steps. A VM contributes to the disruption budget if its patching operation fails either when applying the patches, running pre or post patch steps, or if it fails to respond with a success notification before timing out. VMs that are not running or do not have an active agent do not count toward this disruption budget. For zone-by-zone rollouts, if the disruption budget in a zone is exceeded, the patch job stops, because continuing to the next zone requires completion of the patch process in the previous zone. For example, if the disruption budget has a fixed value of `10`, and 8 VMs fail to patch in the current zone, the patch job continues to patch 2 VMs at a time until the zone is completed. When that zone is completed successfully, patching begins with 10 VMs at a time in the next zone. If 10 VMs in the next zone fail to patch, the patch job stops.
- "fixed": 42, # Specifies a fixed value.
- "percent": 42, # Specifies the relative value defined as a percentage, which will be multiplied by a reference value.
- },
- "mode": "A String", # Mode of the patch rollout.
- },
- "errorMessage": "A String", # If this patch job failed, this message provides information about the failure.
- "patchDeployment": "A String", # Output only. Name of the patch deployment that created this patch job.
- "name": "A String", # Unique identifier for this patch job in the form `projects/*/patchJobs/*`
- "updateTime": "A String", # Last time this patch job was updated.
- "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. # Summary of instance details.
- "applyingPatchesInstanceCount": "A String", # Number of instances that are applying patches.
- "timedOutInstanceCount": "A String", # Number of instances that exceeded the time out while applying the patch.
- "downloadingPatchesInstanceCount": "A String", # Number of instances that are downloading patches.
- "startedInstanceCount": "A String", # Number of instances that have started.
- "ackedInstanceCount": "A String", # Number of instances that have acked and will start shortly.
- "noAgentDetectedInstanceCount": "A 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.
- "succeededRebootRequiredInstanceCount": "A String", # Number of instances that require reboot.
- "rebootingInstanceCount": "A String", # Number of instances rebooting.
- "succeededInstanceCount": "A String", # Number of instances that have completed successfully.
- "postPatchStepInstanceCount": "A String", # Number of instances that are running the post-patch step.
- "notifiedInstanceCount": "A String", # Number of instances notified about patch job.
- "prePatchStepInstanceCount": "A String", # Number of instances that are running the pre-patch step.
- "failedInstanceCount": "A String", # Number of instances that failed.
- "inactiveInstanceCount": "A String", # Number of instances that are inactive.
- "pendingInstanceCount": "A String", # Number of instances pending patch job.
- },
- "state": "A String", # The current state of the PatchJob.
- "percentComplete": 3.14, # Reflects the overall progress of the patch job in the range of 0.0 being no progress to 100.0 being complete.
- "description": "A String", # Description of the patch job. Length of the description is limited to 1024 characters.
- "duration": "A String", # Duration of the patch job. After the duration ends, the patch job times out.
- "displayName": "A String", # Display name for this patch job. This is not a unique identifier.
"instanceFilter": { # A filter to target VM instances for patching. The targeted VMs must meet all criteria specified. So if both labels and zones are specified, the patch job targets only VMs with those labels and in those zones. # Instances to patch.
"zones": [ # Targets VM instances in ANY of these zones. Leave empty to target VM instances in any zone.
"A String",
],
- "instances": [ # Targets any of the VM instances specified. Instances are specified by their URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME]`, `projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`, or `https://www.googleapis.com/compute/v1/projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`
- "A String",
- ],
"groupLabels": [ # Targets VM instances matching ANY of these GroupLabels. This allows targeting of disparate groups of VM instances.
{ # Targets a group of VM instances by using their [assigned labels](https://cloud.google.com/compute/docs/labeling-resources). Labels are key-value pairs. A `GroupLabel` is a combination of labels that is used to target VMs for a patch job. For example, a patch job can target VMs that have the following `GroupLabel`: `{"env":"test", "app":"web"}`. This means that the patch job is applied to VMs that have both the labels `env=test` and `app=web`.
"labels": { # Compute Engine instance labels that must be present for a VM instance to be targeted by this filter.
@@ -763,25 +624,164 @@
},
},
],
- "all": True or False, # Target all VM instances in the project. If true, no other criteria is permitted.
+ "instances": [ # Targets any of the VM instances specified. Instances are specified by their URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME]`, `projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`, or `https://www.googleapis.com/compute/v1/projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`
+ "A String",
+ ],
"instanceNamePrefixes": [ # Targets VMs whose name starts with one of these prefixes. Similar to labels, this is another way to group VMs when targeting configs, for example prefix="prod-".
"A String",
],
+ "all": True or False, # Target all VM instances in the project. If true, no other criteria is permitted.
},
+ "patchConfig": { # Patch configuration specifications. Contains details on how to apply the patch(es) to a VM instance. # Patch configuration being applied.
+ "zypper": { # Zypper patching is performed by running `zypper patch`. See also https://en.opensuse.org/SDB:Zypper_manual. # Zypper update settings. Use this setting to override the default `zypper` patch rules.
+ "categories": [ # Install only patches with these categories. Common categories include security, recommended, and feature.
+ "A String",
+ ],
+ "withUpdate": True or False, # Adds the `--with-update` flag, to `zypper patch`.
+ "withOptional": True or False, # Adds the `--with-optional` flag to `zypper patch`.
+ "excludes": [ # List of patches to exclude from update.
+ "A String",
+ ],
+ "exclusivePatches": [ # An exclusive list of patches to be updated. These are the only patches that will be installed using 'zypper patch patch:' command. This field must not be used with any other patch configuration fields.
+ "A String",
+ ],
+ "severities": [ # Install only patches with these severities. Common severities include critical, important, moderate, and low.
+ "A String",
+ ],
+ },
+ "postStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run after the patch update.
+ "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob.
+ "localPath": "A String", # An absolute path to the executable on the VM.
+ "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
+ "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
+ "bucket": "A String", # Required. Bucket of the Cloud Storage object.
+ "object": "A String", # Required. Name of the Cloud Storage object.
+ },
+ "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
+ "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
+ 42,
+ ],
+ },
+ "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob.
+ "localPath": "A String", # An absolute path to the executable on the VM.
+ "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
+ "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
+ "bucket": "A String", # Required. Bucket of the Cloud Storage object.
+ "object": "A String", # Required. Name of the Cloud Storage object.
+ },
+ "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
+ "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
+ 42,
+ ],
+ },
+ },
+ "rebootConfig": "A String", # Post-patch reboot settings.
+ "apt": { # Apt patching is completed by executing `apt-get update && apt-get upgrade`. Additional options can be set to control how this is executed. # Apt update settings. Use this setting to override the default `apt` patch rules.
+ "excludes": [ # List of packages to exclude from update. These packages will be excluded
+ "A String",
+ ],
+ "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field cannot be specified with any other patch configuration fields.
+ "A String",
+ ],
+ "type": "A String", # By changing the type to DIST, the patching is performed using `apt-get dist-upgrade` instead.
+ },
+ "goo": { # Googet patching is performed by running `googet update`. # Goo update settings. Use this setting to override the default `goo` patch rules.
+ },
+ "windowsUpdate": { # Windows patching is performed using the Windows Update Agent. # Windows update settings. Use this override the default windows patch rules.
+ "exclusivePatches": [ # An exclusive list of kbs to be updated. These are the only patches that will be updated. This field must not be used with other patch configurations.
+ "A String",
+ ],
+ "excludes": [ # List of KBs to exclude from update.
+ "A String",
+ ],
+ "classifications": [ # Only apply updates of these windows update classifications. If empty, all updates are applied.
+ "A String",
+ ],
+ },
+ "preStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run before the patch update.
+ "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob.
+ "localPath": "A String", # An absolute path to the executable on the VM.
+ "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
+ "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
+ "bucket": "A String", # Required. Bucket of the Cloud Storage object.
+ "object": "A String", # Required. Name of the Cloud Storage object.
+ },
+ "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
+ "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
+ 42,
+ ],
+ },
+ "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob.
+ "localPath": "A String", # An absolute path to the executable on the VM.
+ "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
+ "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
+ "bucket": "A String", # Required. Bucket of the Cloud Storage object.
+ "object": "A String", # Required. Name of the Cloud Storage object.
+ },
+ "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
+ "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
+ 42,
+ ],
+ },
+ },
+ "yum": { # Yum patching is performed by executing `yum update`. Additional options can be set to control how this is executed. Note that not all settings are supported on all platforms. # Yum update settings. Use this setting to override the default `yum` patch rules.
+ "minimal": True or False, # Will cause patch to run `yum update-minimal` instead.
+ "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field must not be specified with any other patch configuration fields.
+ "A String",
+ ],
+ "security": True or False, # Adds the `--security` flag to `yum update`. Not supported on all platforms.
+ "excludes": [ # List of packages to exclude from update. These packages are excluded by using the yum `--exclude` flag.
+ "A String",
+ ],
+ },
+ },
+ "errorMessage": "A String", # If this patch job failed, this message provides information about the failure.
+ "state": "A String", # The current state of the PatchJob.
+ "description": "A String", # Description of the patch job. Length of the description is limited to 1024 characters.
+ "patchDeployment": "A String", # Output only. Name of the patch deployment that created this patch job.
"dryRun": True or False, # If this patch job is a dry run, the agent reports that it has finished without running any updates on the VM instance.
+ "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. # Summary of instance details.
+ "ackedInstanceCount": "A String", # Number of instances that have acked and will start shortly.
+ "rebootingInstanceCount": "A String", # Number of instances rebooting.
+ "postPatchStepInstanceCount": "A String", # Number of instances that are running the post-patch step.
+ "inactiveInstanceCount": "A String", # Number of instances that are inactive.
+ "notifiedInstanceCount": "A String", # Number of instances notified about patch job.
+ "startedInstanceCount": "A String", # Number of instances that have started.
+ "prePatchStepInstanceCount": "A String", # Number of instances that are running the pre-patch step.
+ "succeededRebootRequiredInstanceCount": "A String", # Number of instances that require reboot.
+ "pendingInstanceCount": "A String", # Number of instances pending patch job.
+ "noAgentDetectedInstanceCount": "A 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.
+ "succeededInstanceCount": "A String", # Number of instances that have completed successfully.
+ "failedInstanceCount": "A String", # Number of instances that failed.
+ "applyingPatchesInstanceCount": "A String", # Number of instances that are applying patches.
+ "downloadingPatchesInstanceCount": "A String", # Number of instances that are downloading patches.
+ "timedOutInstanceCount": "A String", # Number of instances that exceeded the time out while applying the patch.
+ },
+ "updateTime": "A String", # Last time this patch job was updated.
+ "rollout": { # Patch rollout configuration specifications. Contains details on the concurrency control when applying patch(es) to all targeted VMs. # Rollout strategy being applied.
+ "mode": "A String", # Mode of the patch rollout.
+ "disruptionBudget": { # Message encapsulating a value that can be either absolute ("fixed") or relative ("percent") to a value. # The maximum number (or percentage) of VMs per zone to disrupt at any given moment. The number of VMs calculated from multiplying the percentage by the total number of VMs in a zone is rounded up. During patching, a VM is considered disrupted from the time the agent is notified to begin until patching has completed. This disruption time includes the time to complete reboot and any post-patch steps. A VM contributes to the disruption budget if its patching operation fails either when applying the patches, running pre or post patch steps, or if it fails to respond with a success notification before timing out. VMs that are not running or do not have an active agent do not count toward this disruption budget. For zone-by-zone rollouts, if the disruption budget in a zone is exceeded, the patch job stops, because continuing to the next zone requires completion of the patch process in the previous zone. For example, if the disruption budget has a fixed value of `10`, and 8 VMs fail to patch in the current zone, the patch job continues to patch 2 VMs at a time until the zone is completed. When that zone is completed successfully, patching begins with 10 VMs at a time in the next zone. If 10 VMs in the next zone fail to patch, the patch job stops.
+ "fixed": 42, # Specifies a fixed value.
+ "percent": 42, # Specifies the relative value defined as a percentage, which will be multiplied by a reference value.
+ },
+ },
+ "name": "A String", # Unique identifier for this patch job in the form `projects/*/patchJobs/*`
"createTime": "A String", # Time this patch job was created.
+ "displayName": "A String", # Display name for this patch job. This is not a unique identifier.
+ "duration": "A String", # Duration of the patch job. After the duration ends, the patch job times out.
+ "percentComplete": 3.14, # Reflects the overall progress of the patch job in the range of 0.0 being no progress to 100.0 being complete.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, pageToken=None, filter=None, pageSize=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Get a list of patch jobs.
Args:
parent: string, Required. In the form of `projects/*` (required)
- pageToken: string, A pagination token returned from a previous call that indicates where this listing should continue from.
filter: string, If provided, this field specifies the criteria that must be met by patch jobs to be included in the response. Currently, filtering is only available on the patch_deployment field.
pageSize: integer, The maximum number of instance status to return.
+ pageToken: string, A pagination token returned from a previous call that indicates where this listing should continue from.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -793,149 +793,10 @@
{ # A response message for listing patch jobs.
"patchJobs": [ # The list of patch jobs.
{ # A high level representation of a patch job that is either in progress or has completed. Instance details are not included in the job. To paginate through instance details, use ListPatchJobInstanceDetails. For more information about patch jobs, see [Creating patch jobs](https://cloud.google.com/compute/docs/os-patch-management/create-patch-job).
- "patchConfig": { # Patch configuration specifications. Contains details on how to apply the patch(es) to a VM instance. # Patch configuration being applied.
- "rebootConfig": "A String", # Post-patch reboot settings.
- "postStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run after the patch update.
- "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob.
- "localPath": "A String", # An absolute path to the executable on the VM.
- "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
- "object": "A String", # Required. Name of the Cloud Storage object.
- "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
- "bucket": "A String", # Required. Bucket of the Cloud Storage object.
- },
- "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
- 42,
- ],
- "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
- },
- "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob.
- "localPath": "A String", # An absolute path to the executable on the VM.
- "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
- "object": "A String", # Required. Name of the Cloud Storage object.
- "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
- "bucket": "A String", # Required. Bucket of the Cloud Storage object.
- },
- "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
- 42,
- ],
- "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
- },
- },
- "yum": { # Yum patching is performed by executing `yum update`. Additional options can be set to control how this is executed. Note that not all settings are supported on all platforms. # Yum update settings. Use this setting to override the default `yum` patch rules.
- "minimal": True or False, # Will cause patch to run `yum update-minimal` instead.
- "security": True or False, # Adds the `--security` flag to `yum update`. Not supported on all platforms.
- "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field must not be specified with any other patch configuration fields.
- "A String",
- ],
- "excludes": [ # List of packages to exclude from update. These packages are excluded by using the yum `--exclude` flag.
- "A String",
- ],
- },
- "apt": { # Apt patching is completed by executing `apt-get update && apt-get upgrade`. Additional options can be set to control how this is executed. # Apt update settings. Use this setting to override the default `apt` patch rules.
- "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field cannot be specified with any other patch configuration fields.
- "A String",
- ],
- "type": "A String", # By changing the type to DIST, the patching is performed using `apt-get dist-upgrade` instead.
- "excludes": [ # List of packages to exclude from update. These packages will be excluded
- "A String",
- ],
- },
- "preStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run before the patch update.
- "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob.
- "localPath": "A String", # An absolute path to the executable on the VM.
- "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
- "object": "A String", # Required. Name of the Cloud Storage object.
- "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
- "bucket": "A String", # Required. Bucket of the Cloud Storage object.
- },
- "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
- 42,
- ],
- "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
- },
- "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob.
- "localPath": "A String", # An absolute path to the executable on the VM.
- "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
- "object": "A String", # Required. Name of the Cloud Storage object.
- "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
- "bucket": "A String", # Required. Bucket of the Cloud Storage object.
- },
- "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
- 42,
- ],
- "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
- },
- },
- "goo": { # Googet patching is performed by running `googet update`. # Goo update settings. Use this setting to override the default `goo` patch rules.
- },
- "windowsUpdate": { # Windows patching is performed using the Windows Update Agent. # Windows update settings. Use this override the default windows patch rules.
- "exclusivePatches": [ # An exclusive list of kbs to be updated. These are the only patches that will be updated. This field must not be used with other patch configurations.
- "A String",
- ],
- "classifications": [ # Only apply updates of these windows update classifications. If empty, all updates are applied.
- "A String",
- ],
- "excludes": [ # List of KBs to exclude from update.
- "A String",
- ],
- },
- "zypper": { # Zypper patching is performed by running `zypper patch`. See also https://en.opensuse.org/SDB:Zypper_manual. # Zypper update settings. Use this setting to override the default `zypper` patch rules.
- "exclusivePatches": [ # An exclusive list of patches to be updated. These are the only patches that will be installed using 'zypper patch patch:' command. This field must not be used with any other patch configuration fields.
- "A String",
- ],
- "excludes": [ # List of patches to exclude from update.
- "A String",
- ],
- "categories": [ # Install only patches with these categories. Common categories include security, recommended, and feature.
- "A String",
- ],
- "withUpdate": True or False, # Adds the `--with-update` flag, to `zypper patch`.
- "severities": [ # Install only patches with these severities. Common severities include critical, important, moderate, and low.
- "A String",
- ],
- "withOptional": True or False, # Adds the `--with-optional` flag to `zypper patch`.
- },
- },
- "rollout": { # Patch rollout configuration specifications. Contains details on the concurrency control when applying patch(es) to all targeted VMs. # Rollout strategy being applied.
- "disruptionBudget": { # Message encapsulating a value that can be either absolute ("fixed") or relative ("percent") to a value. # The maximum number (or percentage) of VMs per zone to disrupt at any given moment. The number of VMs calculated from multiplying the percentage by the total number of VMs in a zone is rounded up. During patching, a VM is considered disrupted from the time the agent is notified to begin until patching has completed. This disruption time includes the time to complete reboot and any post-patch steps. A VM contributes to the disruption budget if its patching operation fails either when applying the patches, running pre or post patch steps, or if it fails to respond with a success notification before timing out. VMs that are not running or do not have an active agent do not count toward this disruption budget. For zone-by-zone rollouts, if the disruption budget in a zone is exceeded, the patch job stops, because continuing to the next zone requires completion of the patch process in the previous zone. For example, if the disruption budget has a fixed value of `10`, and 8 VMs fail to patch in the current zone, the patch job continues to patch 2 VMs at a time until the zone is completed. When that zone is completed successfully, patching begins with 10 VMs at a time in the next zone. If 10 VMs in the next zone fail to patch, the patch job stops.
- "fixed": 42, # Specifies a fixed value.
- "percent": 42, # Specifies the relative value defined as a percentage, which will be multiplied by a reference value.
- },
- "mode": "A String", # Mode of the patch rollout.
- },
- "errorMessage": "A String", # If this patch job failed, this message provides information about the failure.
- "patchDeployment": "A String", # Output only. Name of the patch deployment that created this patch job.
- "name": "A String", # Unique identifier for this patch job in the form `projects/*/patchJobs/*`
- "updateTime": "A String", # Last time this patch job was updated.
- "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. # Summary of instance details.
- "applyingPatchesInstanceCount": "A String", # Number of instances that are applying patches.
- "timedOutInstanceCount": "A String", # Number of instances that exceeded the time out while applying the patch.
- "downloadingPatchesInstanceCount": "A String", # Number of instances that are downloading patches.
- "startedInstanceCount": "A String", # Number of instances that have started.
- "ackedInstanceCount": "A String", # Number of instances that have acked and will start shortly.
- "noAgentDetectedInstanceCount": "A 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.
- "succeededRebootRequiredInstanceCount": "A String", # Number of instances that require reboot.
- "rebootingInstanceCount": "A String", # Number of instances rebooting.
- "succeededInstanceCount": "A String", # Number of instances that have completed successfully.
- "postPatchStepInstanceCount": "A String", # Number of instances that are running the post-patch step.
- "notifiedInstanceCount": "A String", # Number of instances notified about patch job.
- "prePatchStepInstanceCount": "A String", # Number of instances that are running the pre-patch step.
- "failedInstanceCount": "A String", # Number of instances that failed.
- "inactiveInstanceCount": "A String", # Number of instances that are inactive.
- "pendingInstanceCount": "A String", # Number of instances pending patch job.
- },
- "state": "A String", # The current state of the PatchJob.
- "percentComplete": 3.14, # Reflects the overall progress of the patch job in the range of 0.0 being no progress to 100.0 being complete.
- "description": "A String", # Description of the patch job. Length of the description is limited to 1024 characters.
- "duration": "A String", # Duration of the patch job. After the duration ends, the patch job times out.
- "displayName": "A String", # Display name for this patch job. This is not a unique identifier.
"instanceFilter": { # A filter to target VM instances for patching. The targeted VMs must meet all criteria specified. So if both labels and zones are specified, the patch job targets only VMs with those labels and in those zones. # Instances to patch.
"zones": [ # Targets VM instances in ANY of these zones. Leave empty to target VM instances in any zone.
"A String",
],
- "instances": [ # Targets any of the VM instances specified. Instances are specified by their URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME]`, `projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`, or `https://www.googleapis.com/compute/v1/projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`
- "A String",
- ],
"groupLabels": [ # Targets VM instances matching ANY of these GroupLabels. This allows targeting of disparate groups of VM instances.
{ # Targets a group of VM instances by using their [assigned labels](https://cloud.google.com/compute/docs/labeling-resources). Labels are key-value pairs. A `GroupLabel` is a combination of labels that is used to target VMs for a patch job. For example, a patch job can target VMs that have the following `GroupLabel`: `{"env":"test", "app":"web"}`. This means that the patch job is applied to VMs that have both the labels `env=test` and `app=web`.
"labels": { # Compute Engine instance labels that must be present for a VM instance to be targeted by this filter.
@@ -943,13 +804,152 @@
},
},
],
- "all": True or False, # Target all VM instances in the project. If true, no other criteria is permitted.
+ "instances": [ # Targets any of the VM instances specified. Instances are specified by their URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME]`, `projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`, or `https://www.googleapis.com/compute/v1/projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`
+ "A String",
+ ],
"instanceNamePrefixes": [ # Targets VMs whose name starts with one of these prefixes. Similar to labels, this is another way to group VMs when targeting configs, for example prefix="prod-".
"A String",
],
+ "all": True or False, # Target all VM instances in the project. If true, no other criteria is permitted.
},
+ "patchConfig": { # Patch configuration specifications. Contains details on how to apply the patch(es) to a VM instance. # Patch configuration being applied.
+ "zypper": { # Zypper patching is performed by running `zypper patch`. See also https://en.opensuse.org/SDB:Zypper_manual. # Zypper update settings. Use this setting to override the default `zypper` patch rules.
+ "categories": [ # Install only patches with these categories. Common categories include security, recommended, and feature.
+ "A String",
+ ],
+ "withUpdate": True or False, # Adds the `--with-update` flag, to `zypper patch`.
+ "withOptional": True or False, # Adds the `--with-optional` flag to `zypper patch`.
+ "excludes": [ # List of patches to exclude from update.
+ "A String",
+ ],
+ "exclusivePatches": [ # An exclusive list of patches to be updated. These are the only patches that will be installed using 'zypper patch patch:' command. This field must not be used with any other patch configuration fields.
+ "A String",
+ ],
+ "severities": [ # Install only patches with these severities. Common severities include critical, important, moderate, and low.
+ "A String",
+ ],
+ },
+ "postStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run after the patch update.
+ "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob.
+ "localPath": "A String", # An absolute path to the executable on the VM.
+ "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
+ "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
+ "bucket": "A String", # Required. Bucket of the Cloud Storage object.
+ "object": "A String", # Required. Name of the Cloud Storage object.
+ },
+ "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
+ "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
+ 42,
+ ],
+ },
+ "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob.
+ "localPath": "A String", # An absolute path to the executable on the VM.
+ "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
+ "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
+ "bucket": "A String", # Required. Bucket of the Cloud Storage object.
+ "object": "A String", # Required. Name of the Cloud Storage object.
+ },
+ "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
+ "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
+ 42,
+ ],
+ },
+ },
+ "rebootConfig": "A String", # Post-patch reboot settings.
+ "apt": { # Apt patching is completed by executing `apt-get update && apt-get upgrade`. Additional options can be set to control how this is executed. # Apt update settings. Use this setting to override the default `apt` patch rules.
+ "excludes": [ # List of packages to exclude from update. These packages will be excluded
+ "A String",
+ ],
+ "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field cannot be specified with any other patch configuration fields.
+ "A String",
+ ],
+ "type": "A String", # By changing the type to DIST, the patching is performed using `apt-get dist-upgrade` instead.
+ },
+ "goo": { # Googet patching is performed by running `googet update`. # Goo update settings. Use this setting to override the default `goo` patch rules.
+ },
+ "windowsUpdate": { # Windows patching is performed using the Windows Update Agent. # Windows update settings. Use this override the default windows patch rules.
+ "exclusivePatches": [ # An exclusive list of kbs to be updated. These are the only patches that will be updated. This field must not be used with other patch configurations.
+ "A String",
+ ],
+ "excludes": [ # List of KBs to exclude from update.
+ "A String",
+ ],
+ "classifications": [ # Only apply updates of these windows update classifications. If empty, all updates are applied.
+ "A String",
+ ],
+ },
+ "preStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run before the patch update.
+ "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob.
+ "localPath": "A String", # An absolute path to the executable on the VM.
+ "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
+ "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
+ "bucket": "A String", # Required. Bucket of the Cloud Storage object.
+ "object": "A String", # Required. Name of the Cloud Storage object.
+ },
+ "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
+ "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
+ 42,
+ ],
+ },
+ "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob.
+ "localPath": "A String", # An absolute path to the executable on the VM.
+ "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
+ "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
+ "bucket": "A String", # Required. Bucket of the Cloud Storage object.
+ "object": "A String", # Required. Name of the Cloud Storage object.
+ },
+ "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
+ "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
+ 42,
+ ],
+ },
+ },
+ "yum": { # Yum patching is performed by executing `yum update`. Additional options can be set to control how this is executed. Note that not all settings are supported on all platforms. # Yum update settings. Use this setting to override the default `yum` patch rules.
+ "minimal": True or False, # Will cause patch to run `yum update-minimal` instead.
+ "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field must not be specified with any other patch configuration fields.
+ "A String",
+ ],
+ "security": True or False, # Adds the `--security` flag to `yum update`. Not supported on all platforms.
+ "excludes": [ # List of packages to exclude from update. These packages are excluded by using the yum `--exclude` flag.
+ "A String",
+ ],
+ },
+ },
+ "errorMessage": "A String", # If this patch job failed, this message provides information about the failure.
+ "state": "A String", # The current state of the PatchJob.
+ "description": "A String", # Description of the patch job. Length of the description is limited to 1024 characters.
+ "patchDeployment": "A String", # Output only. Name of the patch deployment that created this patch job.
"dryRun": True or False, # If this patch job is a dry run, the agent reports that it has finished without running any updates on the VM instance.
+ "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. # Summary of instance details.
+ "ackedInstanceCount": "A String", # Number of instances that have acked and will start shortly.
+ "rebootingInstanceCount": "A String", # Number of instances rebooting.
+ "postPatchStepInstanceCount": "A String", # Number of instances that are running the post-patch step.
+ "inactiveInstanceCount": "A String", # Number of instances that are inactive.
+ "notifiedInstanceCount": "A String", # Number of instances notified about patch job.
+ "startedInstanceCount": "A String", # Number of instances that have started.
+ "prePatchStepInstanceCount": "A String", # Number of instances that are running the pre-patch step.
+ "succeededRebootRequiredInstanceCount": "A String", # Number of instances that require reboot.
+ "pendingInstanceCount": "A String", # Number of instances pending patch job.
+ "noAgentDetectedInstanceCount": "A 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.
+ "succeededInstanceCount": "A String", # Number of instances that have completed successfully.
+ "failedInstanceCount": "A String", # Number of instances that failed.
+ "applyingPatchesInstanceCount": "A String", # Number of instances that are applying patches.
+ "downloadingPatchesInstanceCount": "A String", # Number of instances that are downloading patches.
+ "timedOutInstanceCount": "A String", # Number of instances that exceeded the time out while applying the patch.
+ },
+ "updateTime": "A String", # Last time this patch job was updated.
+ "rollout": { # Patch rollout configuration specifications. Contains details on the concurrency control when applying patch(es) to all targeted VMs. # Rollout strategy being applied.
+ "mode": "A String", # Mode of the patch rollout.
+ "disruptionBudget": { # Message encapsulating a value that can be either absolute ("fixed") or relative ("percent") to a value. # The maximum number (or percentage) of VMs per zone to disrupt at any given moment. The number of VMs calculated from multiplying the percentage by the total number of VMs in a zone is rounded up. During patching, a VM is considered disrupted from the time the agent is notified to begin until patching has completed. This disruption time includes the time to complete reboot and any post-patch steps. A VM contributes to the disruption budget if its patching operation fails either when applying the patches, running pre or post patch steps, or if it fails to respond with a success notification before timing out. VMs that are not running or do not have an active agent do not count toward this disruption budget. For zone-by-zone rollouts, if the disruption budget in a zone is exceeded, the patch job stops, because continuing to the next zone requires completion of the patch process in the previous zone. For example, if the disruption budget has a fixed value of `10`, and 8 VMs fail to patch in the current zone, the patch job continues to patch 2 VMs at a time until the zone is completed. When that zone is completed successfully, patching begins with 10 VMs at a time in the next zone. If 10 VMs in the next zone fail to patch, the patch job stops.
+ "fixed": 42, # Specifies a fixed value.
+ "percent": 42, # Specifies the relative value defined as a percentage, which will be multiplied by a reference value.
+ },
+ },
+ "name": "A String", # Unique identifier for this patch job in the form `projects/*/patchJobs/*`
"createTime": "A String", # Time this patch job was created.
+ "displayName": "A String", # Display name for this patch job. This is not a unique identifier.
+ "duration": "A String", # Duration of the patch job. After the duration ends, the patch job times out.
+ "percentComplete": 3.14, # Reflects the overall progress of the patch job in the range of 0.0 being no progress to 100.0 being complete.
},
],
"nextPageToken": "A String", # A pagination token that can be used to get the next page of results.