1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="osconfig_v1beta.html">OS Config API</a> . <a href="osconfig_v1beta.projects.html">projects</a> . <a href="osconfig_v1beta.projects.patchDeployments.html">patchDeployments</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#create">create(parent, body=None, patchDeploymentId=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Create an OS Config patch deployment.</p> 83<p class="toc_element"> 84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 85<p class="firstline">Delete an OS Config patch deployment.</p> 86<p class="toc_element"> 87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 88<p class="firstline">Get an OS Config patch deployment.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Get a page of OS Config patch deployments.</p> 92<p class="toc_element"> 93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 94<p class="firstline">Retrieves the next page of results.</p> 95<p class="toc_element"> 96 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Update an OS Config patch deployment.</p> 98<p class="toc_element"> 99 <code><a href="#pause">pause(name, body=None, x__xgafv=None)</a></code></p> 100<p class="firstline">Change state of patch deployment to "PAUSED". Patch deployment in paused state doesn't generate patch jobs.</p> 101<p class="toc_element"> 102 <code><a href="#resume">resume(name, body=None, x__xgafv=None)</a></code></p> 103<p class="firstline">Change state of patch deployment back to "ACTIVE". Patch deployment in active state continues to generate patch jobs.</p> 104<h3>Method Details</h3> 105<div class="method"> 106 <code class="details" id="close">close()</code> 107 <pre>Close httplib2 connections.</pre> 108</div> 109 110<div class="method"> 111 <code class="details" id="create">create(parent, body=None, patchDeploymentId=None, x__xgafv=None)</code> 112 <pre>Create an OS Config patch deployment. 113 114Args: 115 parent: string, Required. The project to apply this patch deployment to in the form `projects/*`. (required) 116 body: object, The request body. 117 The object takes the form of: 118 119{ # Patch deployments are configurations that individual patch jobs use to complete a patch. These configurations include instance filter, package repository settings, and a schedule. For more information about creating and managing patch deployments, see [Scheduling patch jobs](https://cloud.google.com/compute/docs/os-patch-management/schedule-patch-jobs). 120 "createTime": "A String", # Output only. Time the patch deployment was created. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 121 "description": "A String", # Optional. Description of the patch deployment. Length of the description is limited to 1024 characters. 122 "duration": "A String", # Optional. Duration of the patch. After the duration ends, the patch times out. 123 "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. VM instances to patch. 124 "all": True or False, # Target all VM instances in the project. If true, no other criteria is permitted. 125 "groupLabels": [ # Targets VM instances matching at least one of these label sets. This allows targeting of disparate groups, for example "env=prod or env=staging". 126 { # Represents a group of VMs that can be identified as having all these labels, for example "env=prod and app=web". 127 "labels": { # Compute Engine instance labels that must be present for a VM instance to be targeted by this filter. 128 "a_key": "A String", 129 }, 130 }, 131 ], 132 "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-". 133 "A String", 134 ], 135 "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]` 136 "A String", 137 ], 138 "zones": [ # Targets VM instances in ANY of these zones. Leave empty to target VM instances in any zone. 139 "A String", 140 ], 141 }, 142 "lastExecuteTime": "A String", # Output only. The last time a patch job was started by this deployment. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 143 "name": "A String", # Unique name for the patch deployment resource in a project. The patch deployment name is in the form: `projects/{project_id}/patchDeployments/{patch_deployment_id}`. This field is ignored when you create a new patch deployment. 144 "oneTimeSchedule": { # Sets the time for a one time patch deployment. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. # Required. Schedule a one-time execution. 145 "executeTime": "A String", # Required. The desired patch job execution time. 146 }, 147 "patchConfig": { # Patch configuration specifications. Contains details on how to apply the patch(es) to a VM instance. # Optional. Patch configuration that is applied. 148 "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. 149 "excludes": [ # List of packages to exclude from update. These packages will be excluded 150 "A String", 151 ], 152 "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. 153 "A String", 154 ], 155 "type": "A String", # By changing the type to DIST, the patching is performed using `apt-get dist-upgrade` instead. 156 }, 157 "goo": { # Googet patching is performed by running `googet update`. # Goo update settings. Use this setting to override the default `goo` patch rules. 158 }, 159 "postStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run after the patch update. 160 "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob. 161 "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. 162 42, 163 ], 164 "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. 165 "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. 166 "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. 167 "object": "A String", # Required. Name of the Google Cloud Storage object. 168 }, 169 "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\)). 170 "localPath": "A String", # An absolute path to the executable on the VM. 171 }, 172 "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob. 173 "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. 174 42, 175 ], 176 "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. 177 "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. 178 "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. 179 "object": "A String", # Required. Name of the Google Cloud Storage object. 180 }, 181 "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\)). 182 "localPath": "A String", # An absolute path to the executable on the VM. 183 }, 184 }, 185 "preStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run before the patch update. 186 "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob. 187 "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. 188 42, 189 ], 190 "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. 191 "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. 192 "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. 193 "object": "A String", # Required. Name of the Google Cloud Storage object. 194 }, 195 "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\)). 196 "localPath": "A String", # An absolute path to the executable on the VM. 197 }, 198 "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob. 199 "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. 200 42, 201 ], 202 "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. 203 "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. 204 "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. 205 "object": "A String", # Required. Name of the Google Cloud Storage object. 206 }, 207 "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\)). 208 "localPath": "A String", # An absolute path to the executable on the VM. 209 }, 210 }, 211 "rebootConfig": "A String", # Post-patch reboot settings. 212 "windowsUpdate": { # Windows patching is performed using the Windows Update Agent. # Windows update settings. Use this override the default windows patch rules. 213 "classifications": [ # Only apply updates of these windows update classifications. If empty, all updates are applied. 214 "A String", 215 ], 216 "excludes": [ # List of KBs to exclude from update. 217 "A String", 218 ], 219 "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. 220 "A String", 221 ], 222 }, 223 "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. 224 "excludes": [ # List of packages to exclude from update. These packages are excluded by using the yum `--exclude` flag. 225 "A String", 226 ], 227 "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. 228 "A String", 229 ], 230 "minimal": True or False, # Will cause patch to run `yum update-minimal` instead. 231 "security": True or False, # Adds the `--security` flag to `yum update`. Not supported on all platforms. 232 }, 233 "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. 234 "categories": [ # Install only patches with these categories. Common categories include security, recommended, and feature. 235 "A String", 236 ], 237 "excludes": [ # List of patches to exclude from update. 238 "A String", 239 ], 240 "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. 241 "A String", 242 ], 243 "severities": [ # Install only patches with these severities. Common severities include critical, important, moderate, and low. 244 "A String", 245 ], 246 "withOptional": True or False, # Adds the `--with-optional` flag to `zypper patch`. 247 "withUpdate": True or False, # Adds the `--with-update` flag, to `zypper patch`. 248 }, 249 }, 250 "recurringSchedule": { # Sets the time for recurring patch deployments. # Required. Schedule recurring executions. 251 "endTime": "A String", # Optional. The end time at which a recurring patch deployment schedule is no longer active. 252 "frequency": "A String", # Required. The frequency unit of this recurring schedule. 253 "lastExecuteTime": "A String", # Output only. The time the last patch job ran successfully. 254 "monthly": { # Represents a monthly schedule. An example of a valid monthly schedule is "on the third Tuesday of the month" or "on the 15th of the month". # Required. Schedule with monthly executions. 255 "monthDay": 42, # Required. One day of the month. 1-31 indicates the 1st to the 31st day. -1 indicates the last day of the month. Months without the target day will be skipped. For example, a schedule to run "every month on the 31st" will not run in February, April, June, etc. 256 "weekDayOfMonth": { # Represents one week day in a month. An example is "the 4th Sunday". # Required. Week day in a month. 257 "dayOfWeek": "A String", # Required. A day of the week. 258 "dayOffset": 42, # Optional. Represents the number of days before or after the given week day of month that the patch deployment is scheduled for. For example if `week_ordinal` and `day_of_week` values point to the second day of the month and this `day_offset` value is set to `3`, the patch deployment takes place three days after the second Tuesday of the month. If this value is negative, for example -5, the patches are deployed five days before before the second Tuesday of the month. Allowed values are in range [-30, 30]. 259 "weekOrdinal": 42, # Required. Week number in a month. 1-4 indicates the 1st to 4th week of the month. -1 indicates the last week of the month. 260 }, 261 }, 262 "nextExecuteTime": "A String", # Output only. The time the next patch job is scheduled to run. 263 "startTime": "A String", # Optional. The time that the recurring schedule becomes effective. Defaults to `create_time` of the patch deployment. 264 "timeOfDay": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Time of the day to run a recurring deployment. 265 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. 266 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. 267 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. 268 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. 269 }, 270 "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. Defines the time zone that `time_of_day` is relative to. The rules for daylight saving time are determined by the chosen time zone. 271 "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York". 272 "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a". 273 }, 274 "weekly": { # Represents a weekly schedule. # Required. Schedule with weekly executions. 275 "dayOfWeek": "A String", # Required. Day of the week. 276 }, 277 }, 278 "rollout": { # Patch rollout configuration specifications. Contains details on the concurrency control when applying patch(es) to all targeted VMs. # Optional. Rollout strategy of the patch job. 279 "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. 280 "fixed": 42, # Specifies a fixed value. 281 "percent": 42, # Specifies the relative value defined as a percentage, which will be multiplied by a reference value. 282 }, 283 "mode": "A String", # Mode of the patch rollout. 284 }, 285 "state": "A String", # Output only. Current state of the patch deployment. 286 "updateTime": "A String", # Output only. Time the patch deployment was last updated. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 287} 288 289 patchDeploymentId: string, Required. A name for the patch deployment in the project. When creating a name the following rules apply: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the project. 290 x__xgafv: string, V1 error format. 291 Allowed values 292 1 - v1 error format 293 2 - v2 error format 294 295Returns: 296 An object of the form: 297 298 { # Patch deployments are configurations that individual patch jobs use to complete a patch. These configurations include instance filter, package repository settings, and a schedule. For more information about creating and managing patch deployments, see [Scheduling patch jobs](https://cloud.google.com/compute/docs/os-patch-management/schedule-patch-jobs). 299 "createTime": "A String", # Output only. Time the patch deployment was created. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 300 "description": "A String", # Optional. Description of the patch deployment. Length of the description is limited to 1024 characters. 301 "duration": "A String", # Optional. Duration of the patch. After the duration ends, the patch times out. 302 "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. VM instances to patch. 303 "all": True or False, # Target all VM instances in the project. If true, no other criteria is permitted. 304 "groupLabels": [ # Targets VM instances matching at least one of these label sets. This allows targeting of disparate groups, for example "env=prod or env=staging". 305 { # Represents a group of VMs that can be identified as having all these labels, for example "env=prod and app=web". 306 "labels": { # Compute Engine instance labels that must be present for a VM instance to be targeted by this filter. 307 "a_key": "A String", 308 }, 309 }, 310 ], 311 "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-". 312 "A String", 313 ], 314 "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]` 315 "A String", 316 ], 317 "zones": [ # Targets VM instances in ANY of these zones. Leave empty to target VM instances in any zone. 318 "A String", 319 ], 320 }, 321 "lastExecuteTime": "A String", # Output only. The last time a patch job was started by this deployment. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 322 "name": "A String", # Unique name for the patch deployment resource in a project. The patch deployment name is in the form: `projects/{project_id}/patchDeployments/{patch_deployment_id}`. This field is ignored when you create a new patch deployment. 323 "oneTimeSchedule": { # Sets the time for a one time patch deployment. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. # Required. Schedule a one-time execution. 324 "executeTime": "A String", # Required. The desired patch job execution time. 325 }, 326 "patchConfig": { # Patch configuration specifications. Contains details on how to apply the patch(es) to a VM instance. # Optional. Patch configuration that is applied. 327 "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. 328 "excludes": [ # List of packages to exclude from update. These packages will be excluded 329 "A String", 330 ], 331 "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. 332 "A String", 333 ], 334 "type": "A String", # By changing the type to DIST, the patching is performed using `apt-get dist-upgrade` instead. 335 }, 336 "goo": { # Googet patching is performed by running `googet update`. # Goo update settings. Use this setting to override the default `goo` patch rules. 337 }, 338 "postStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run after the patch update. 339 "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob. 340 "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. 341 42, 342 ], 343 "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. 344 "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. 345 "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. 346 "object": "A String", # Required. Name of the Google Cloud Storage object. 347 }, 348 "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\)). 349 "localPath": "A String", # An absolute path to the executable on the VM. 350 }, 351 "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob. 352 "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. 353 42, 354 ], 355 "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. 356 "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. 357 "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. 358 "object": "A String", # Required. Name of the Google Cloud Storage object. 359 }, 360 "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\)). 361 "localPath": "A String", # An absolute path to the executable on the VM. 362 }, 363 }, 364 "preStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run before the patch update. 365 "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob. 366 "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. 367 42, 368 ], 369 "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. 370 "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. 371 "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. 372 "object": "A String", # Required. Name of the Google Cloud Storage object. 373 }, 374 "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\)). 375 "localPath": "A String", # An absolute path to the executable on the VM. 376 }, 377 "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob. 378 "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. 379 42, 380 ], 381 "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. 382 "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. 383 "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. 384 "object": "A String", # Required. Name of the Google Cloud Storage object. 385 }, 386 "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\)). 387 "localPath": "A String", # An absolute path to the executable on the VM. 388 }, 389 }, 390 "rebootConfig": "A String", # Post-patch reboot settings. 391 "windowsUpdate": { # Windows patching is performed using the Windows Update Agent. # Windows update settings. Use this override the default windows patch rules. 392 "classifications": [ # Only apply updates of these windows update classifications. If empty, all updates are applied. 393 "A String", 394 ], 395 "excludes": [ # List of KBs to exclude from update. 396 "A String", 397 ], 398 "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. 399 "A String", 400 ], 401 }, 402 "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. 403 "excludes": [ # List of packages to exclude from update. These packages are excluded by using the yum `--exclude` flag. 404 "A String", 405 ], 406 "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. 407 "A String", 408 ], 409 "minimal": True or False, # Will cause patch to run `yum update-minimal` instead. 410 "security": True or False, # Adds the `--security` flag to `yum update`. Not supported on all platforms. 411 }, 412 "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. 413 "categories": [ # Install only patches with these categories. Common categories include security, recommended, and feature. 414 "A String", 415 ], 416 "excludes": [ # List of patches to exclude from update. 417 "A String", 418 ], 419 "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. 420 "A String", 421 ], 422 "severities": [ # Install only patches with these severities. Common severities include critical, important, moderate, and low. 423 "A String", 424 ], 425 "withOptional": True or False, # Adds the `--with-optional` flag to `zypper patch`. 426 "withUpdate": True or False, # Adds the `--with-update` flag, to `zypper patch`. 427 }, 428 }, 429 "recurringSchedule": { # Sets the time for recurring patch deployments. # Required. Schedule recurring executions. 430 "endTime": "A String", # Optional. The end time at which a recurring patch deployment schedule is no longer active. 431 "frequency": "A String", # Required. The frequency unit of this recurring schedule. 432 "lastExecuteTime": "A String", # Output only. The time the last patch job ran successfully. 433 "monthly": { # Represents a monthly schedule. An example of a valid monthly schedule is "on the third Tuesday of the month" or "on the 15th of the month". # Required. Schedule with monthly executions. 434 "monthDay": 42, # Required. One day of the month. 1-31 indicates the 1st to the 31st day. -1 indicates the last day of the month. Months without the target day will be skipped. For example, a schedule to run "every month on the 31st" will not run in February, April, June, etc. 435 "weekDayOfMonth": { # Represents one week day in a month. An example is "the 4th Sunday". # Required. Week day in a month. 436 "dayOfWeek": "A String", # Required. A day of the week. 437 "dayOffset": 42, # Optional. Represents the number of days before or after the given week day of month that the patch deployment is scheduled for. For example if `week_ordinal` and `day_of_week` values point to the second day of the month and this `day_offset` value is set to `3`, the patch deployment takes place three days after the second Tuesday of the month. If this value is negative, for example -5, the patches are deployed five days before before the second Tuesday of the month. Allowed values are in range [-30, 30]. 438 "weekOrdinal": 42, # Required. Week number in a month. 1-4 indicates the 1st to 4th week of the month. -1 indicates the last week of the month. 439 }, 440 }, 441 "nextExecuteTime": "A String", # Output only. The time the next patch job is scheduled to run. 442 "startTime": "A String", # Optional. The time that the recurring schedule becomes effective. Defaults to `create_time` of the patch deployment. 443 "timeOfDay": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Time of the day to run a recurring deployment. 444 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. 445 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. 446 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. 447 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. 448 }, 449 "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. Defines the time zone that `time_of_day` is relative to. The rules for daylight saving time are determined by the chosen time zone. 450 "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York". 451 "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a". 452 }, 453 "weekly": { # Represents a weekly schedule. # Required. Schedule with weekly executions. 454 "dayOfWeek": "A String", # Required. Day of the week. 455 }, 456 }, 457 "rollout": { # Patch rollout configuration specifications. Contains details on the concurrency control when applying patch(es) to all targeted VMs. # Optional. Rollout strategy of the patch job. 458 "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. 459 "fixed": 42, # Specifies a fixed value. 460 "percent": 42, # Specifies the relative value defined as a percentage, which will be multiplied by a reference value. 461 }, 462 "mode": "A String", # Mode of the patch rollout. 463 }, 464 "state": "A String", # Output only. Current state of the patch deployment. 465 "updateTime": "A String", # Output only. Time the patch deployment was last updated. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 466}</pre> 467</div> 468 469<div class="method"> 470 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 471 <pre>Delete an OS Config patch deployment. 472 473Args: 474 name: string, Required. The resource name of the patch deployment in the form `projects/*/patchDeployments/*`. (required) 475 x__xgafv: string, V1 error format. 476 Allowed values 477 1 - v1 error format 478 2 - v2 error format 479 480Returns: 481 An object of the form: 482 483 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. 484}</pre> 485</div> 486 487<div class="method"> 488 <code class="details" id="get">get(name, x__xgafv=None)</code> 489 <pre>Get an OS Config patch deployment. 490 491Args: 492 name: string, Required. The resource name of the patch deployment in the form `projects/*/patchDeployments/*`. (required) 493 x__xgafv: string, V1 error format. 494 Allowed values 495 1 - v1 error format 496 2 - v2 error format 497 498Returns: 499 An object of the form: 500 501 { # Patch deployments are configurations that individual patch jobs use to complete a patch. These configurations include instance filter, package repository settings, and a schedule. For more information about creating and managing patch deployments, see [Scheduling patch jobs](https://cloud.google.com/compute/docs/os-patch-management/schedule-patch-jobs). 502 "createTime": "A String", # Output only. Time the patch deployment was created. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 503 "description": "A String", # Optional. Description of the patch deployment. Length of the description is limited to 1024 characters. 504 "duration": "A String", # Optional. Duration of the patch. After the duration ends, the patch times out. 505 "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. VM instances to patch. 506 "all": True or False, # Target all VM instances in the project. If true, no other criteria is permitted. 507 "groupLabels": [ # Targets VM instances matching at least one of these label sets. This allows targeting of disparate groups, for example "env=prod or env=staging". 508 { # Represents a group of VMs that can be identified as having all these labels, for example "env=prod and app=web". 509 "labels": { # Compute Engine instance labels that must be present for a VM instance to be targeted by this filter. 510 "a_key": "A String", 511 }, 512 }, 513 ], 514 "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-". 515 "A String", 516 ], 517 "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]` 518 "A String", 519 ], 520 "zones": [ # Targets VM instances in ANY of these zones. Leave empty to target VM instances in any zone. 521 "A String", 522 ], 523 }, 524 "lastExecuteTime": "A String", # Output only. The last time a patch job was started by this deployment. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 525 "name": "A String", # Unique name for the patch deployment resource in a project. The patch deployment name is in the form: `projects/{project_id}/patchDeployments/{patch_deployment_id}`. This field is ignored when you create a new patch deployment. 526 "oneTimeSchedule": { # Sets the time for a one time patch deployment. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. # Required. Schedule a one-time execution. 527 "executeTime": "A String", # Required. The desired patch job execution time. 528 }, 529 "patchConfig": { # Patch configuration specifications. Contains details on how to apply the patch(es) to a VM instance. # Optional. Patch configuration that is applied. 530 "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. 531 "excludes": [ # List of packages to exclude from update. These packages will be excluded 532 "A String", 533 ], 534 "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. 535 "A String", 536 ], 537 "type": "A String", # By changing the type to DIST, the patching is performed using `apt-get dist-upgrade` instead. 538 }, 539 "goo": { # Googet patching is performed by running `googet update`. # Goo update settings. Use this setting to override the default `goo` patch rules. 540 }, 541 "postStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run after the patch update. 542 "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob. 543 "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. 544 42, 545 ], 546 "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. 547 "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. 548 "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. 549 "object": "A String", # Required. Name of the Google Cloud Storage object. 550 }, 551 "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\)). 552 "localPath": "A String", # An absolute path to the executable on the VM. 553 }, 554 "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob. 555 "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. 556 42, 557 ], 558 "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. 559 "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. 560 "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. 561 "object": "A String", # Required. Name of the Google Cloud Storage object. 562 }, 563 "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\)). 564 "localPath": "A String", # An absolute path to the executable on the VM. 565 }, 566 }, 567 "preStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run before the patch update. 568 "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob. 569 "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. 570 42, 571 ], 572 "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. 573 "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. 574 "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. 575 "object": "A String", # Required. Name of the Google Cloud Storage object. 576 }, 577 "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\)). 578 "localPath": "A String", # An absolute path to the executable on the VM. 579 }, 580 "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob. 581 "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. 582 42, 583 ], 584 "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. 585 "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. 586 "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. 587 "object": "A String", # Required. Name of the Google Cloud Storage object. 588 }, 589 "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\)). 590 "localPath": "A String", # An absolute path to the executable on the VM. 591 }, 592 }, 593 "rebootConfig": "A String", # Post-patch reboot settings. 594 "windowsUpdate": { # Windows patching is performed using the Windows Update Agent. # Windows update settings. Use this override the default windows patch rules. 595 "classifications": [ # Only apply updates of these windows update classifications. If empty, all updates are applied. 596 "A String", 597 ], 598 "excludes": [ # List of KBs to exclude from update. 599 "A String", 600 ], 601 "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. 602 "A String", 603 ], 604 }, 605 "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. 606 "excludes": [ # List of packages to exclude from update. These packages are excluded by using the yum `--exclude` flag. 607 "A String", 608 ], 609 "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. 610 "A String", 611 ], 612 "minimal": True or False, # Will cause patch to run `yum update-minimal` instead. 613 "security": True or False, # Adds the `--security` flag to `yum update`. Not supported on all platforms. 614 }, 615 "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. 616 "categories": [ # Install only patches with these categories. Common categories include security, recommended, and feature. 617 "A String", 618 ], 619 "excludes": [ # List of patches to exclude from update. 620 "A String", 621 ], 622 "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. 623 "A String", 624 ], 625 "severities": [ # Install only patches with these severities. Common severities include critical, important, moderate, and low. 626 "A String", 627 ], 628 "withOptional": True or False, # Adds the `--with-optional` flag to `zypper patch`. 629 "withUpdate": True or False, # Adds the `--with-update` flag, to `zypper patch`. 630 }, 631 }, 632 "recurringSchedule": { # Sets the time for recurring patch deployments. # Required. Schedule recurring executions. 633 "endTime": "A String", # Optional. The end time at which a recurring patch deployment schedule is no longer active. 634 "frequency": "A String", # Required. The frequency unit of this recurring schedule. 635 "lastExecuteTime": "A String", # Output only. The time the last patch job ran successfully. 636 "monthly": { # Represents a monthly schedule. An example of a valid monthly schedule is "on the third Tuesday of the month" or "on the 15th of the month". # Required. Schedule with monthly executions. 637 "monthDay": 42, # Required. One day of the month. 1-31 indicates the 1st to the 31st day. -1 indicates the last day of the month. Months without the target day will be skipped. For example, a schedule to run "every month on the 31st" will not run in February, April, June, etc. 638 "weekDayOfMonth": { # Represents one week day in a month. An example is "the 4th Sunday". # Required. Week day in a month. 639 "dayOfWeek": "A String", # Required. A day of the week. 640 "dayOffset": 42, # Optional. Represents the number of days before or after the given week day of month that the patch deployment is scheduled for. For example if `week_ordinal` and `day_of_week` values point to the second day of the month and this `day_offset` value is set to `3`, the patch deployment takes place three days after the second Tuesday of the month. If this value is negative, for example -5, the patches are deployed five days before before the second Tuesday of the month. Allowed values are in range [-30, 30]. 641 "weekOrdinal": 42, # Required. Week number in a month. 1-4 indicates the 1st to 4th week of the month. -1 indicates the last week of the month. 642 }, 643 }, 644 "nextExecuteTime": "A String", # Output only. The time the next patch job is scheduled to run. 645 "startTime": "A String", # Optional. The time that the recurring schedule becomes effective. Defaults to `create_time` of the patch deployment. 646 "timeOfDay": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Time of the day to run a recurring deployment. 647 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. 648 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. 649 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. 650 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. 651 }, 652 "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. Defines the time zone that `time_of_day` is relative to. The rules for daylight saving time are determined by the chosen time zone. 653 "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York". 654 "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a". 655 }, 656 "weekly": { # Represents a weekly schedule. # Required. Schedule with weekly executions. 657 "dayOfWeek": "A String", # Required. Day of the week. 658 }, 659 }, 660 "rollout": { # Patch rollout configuration specifications. Contains details on the concurrency control when applying patch(es) to all targeted VMs. # Optional. Rollout strategy of the patch job. 661 "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. 662 "fixed": 42, # Specifies a fixed value. 663 "percent": 42, # Specifies the relative value defined as a percentage, which will be multiplied by a reference value. 664 }, 665 "mode": "A String", # Mode of the patch rollout. 666 }, 667 "state": "A String", # Output only. Current state of the patch deployment. 668 "updateTime": "A String", # Output only. Time the patch deployment was last updated. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 669}</pre> 670</div> 671 672<div class="method"> 673 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> 674 <pre>Get a page of OS Config patch deployments. 675 676Args: 677 parent: string, Required. The resource name of the parent in the form `projects/*`. (required) 678 pageSize: integer, Optional. The maximum number of patch deployments to return. Default is 100. 679 pageToken: string, Optional. A pagination token returned from a previous call to ListPatchDeployments that indicates where this listing should continue from. 680 x__xgafv: string, V1 error format. 681 Allowed values 682 1 - v1 error format 683 2 - v2 error format 684 685Returns: 686 An object of the form: 687 688 { # A response message for listing patch deployments. 689 "nextPageToken": "A String", # A pagination token that can be used to get the next page of patch deployments. 690 "patchDeployments": [ # The list of patch deployments. 691 { # Patch deployments are configurations that individual patch jobs use to complete a patch. These configurations include instance filter, package repository settings, and a schedule. For more information about creating and managing patch deployments, see [Scheduling patch jobs](https://cloud.google.com/compute/docs/os-patch-management/schedule-patch-jobs). 692 "createTime": "A String", # Output only. Time the patch deployment was created. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 693 "description": "A String", # Optional. Description of the patch deployment. Length of the description is limited to 1024 characters. 694 "duration": "A String", # Optional. Duration of the patch. After the duration ends, the patch times out. 695 "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. VM instances to patch. 696 "all": True or False, # Target all VM instances in the project. If true, no other criteria is permitted. 697 "groupLabels": [ # Targets VM instances matching at least one of these label sets. This allows targeting of disparate groups, for example "env=prod or env=staging". 698 { # Represents a group of VMs that can be identified as having all these labels, for example "env=prod and app=web". 699 "labels": { # Compute Engine instance labels that must be present for a VM instance to be targeted by this filter. 700 "a_key": "A String", 701 }, 702 }, 703 ], 704 "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-". 705 "A String", 706 ], 707 "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]` 708 "A String", 709 ], 710 "zones": [ # Targets VM instances in ANY of these zones. Leave empty to target VM instances in any zone. 711 "A String", 712 ], 713 }, 714 "lastExecuteTime": "A String", # Output only. The last time a patch job was started by this deployment. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 715 "name": "A String", # Unique name for the patch deployment resource in a project. The patch deployment name is in the form: `projects/{project_id}/patchDeployments/{patch_deployment_id}`. This field is ignored when you create a new patch deployment. 716 "oneTimeSchedule": { # Sets the time for a one time patch deployment. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. # Required. Schedule a one-time execution. 717 "executeTime": "A String", # Required. The desired patch job execution time. 718 }, 719 "patchConfig": { # Patch configuration specifications. Contains details on how to apply the patch(es) to a VM instance. # Optional. Patch configuration that is applied. 720 "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. 721 "excludes": [ # List of packages to exclude from update. These packages will be excluded 722 "A String", 723 ], 724 "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. 725 "A String", 726 ], 727 "type": "A String", # By changing the type to DIST, the patching is performed using `apt-get dist-upgrade` instead. 728 }, 729 "goo": { # Googet patching is performed by running `googet update`. # Goo update settings. Use this setting to override the default `goo` patch rules. 730 }, 731 "postStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run after the patch update. 732 "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob. 733 "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. 734 42, 735 ], 736 "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. 737 "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. 738 "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. 739 "object": "A String", # Required. Name of the Google Cloud Storage object. 740 }, 741 "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\)). 742 "localPath": "A String", # An absolute path to the executable on the VM. 743 }, 744 "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob. 745 "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. 746 42, 747 ], 748 "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. 749 "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. 750 "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. 751 "object": "A String", # Required. Name of the Google Cloud Storage object. 752 }, 753 "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\)). 754 "localPath": "A String", # An absolute path to the executable on the VM. 755 }, 756 }, 757 "preStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run before the patch update. 758 "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob. 759 "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. 760 42, 761 ], 762 "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. 763 "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. 764 "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. 765 "object": "A String", # Required. Name of the Google Cloud Storage object. 766 }, 767 "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\)). 768 "localPath": "A String", # An absolute path to the executable on the VM. 769 }, 770 "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob. 771 "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. 772 42, 773 ], 774 "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. 775 "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. 776 "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. 777 "object": "A String", # Required. Name of the Google Cloud Storage object. 778 }, 779 "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\)). 780 "localPath": "A String", # An absolute path to the executable on the VM. 781 }, 782 }, 783 "rebootConfig": "A String", # Post-patch reboot settings. 784 "windowsUpdate": { # Windows patching is performed using the Windows Update Agent. # Windows update settings. Use this override the default windows patch rules. 785 "classifications": [ # Only apply updates of these windows update classifications. If empty, all updates are applied. 786 "A String", 787 ], 788 "excludes": [ # List of KBs to exclude from update. 789 "A String", 790 ], 791 "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. 792 "A String", 793 ], 794 }, 795 "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. 796 "excludes": [ # List of packages to exclude from update. These packages are excluded by using the yum `--exclude` flag. 797 "A String", 798 ], 799 "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. 800 "A String", 801 ], 802 "minimal": True or False, # Will cause patch to run `yum update-minimal` instead. 803 "security": True or False, # Adds the `--security` flag to `yum update`. Not supported on all platforms. 804 }, 805 "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. 806 "categories": [ # Install only patches with these categories. Common categories include security, recommended, and feature. 807 "A String", 808 ], 809 "excludes": [ # List of patches to exclude from update. 810 "A String", 811 ], 812 "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. 813 "A String", 814 ], 815 "severities": [ # Install only patches with these severities. Common severities include critical, important, moderate, and low. 816 "A String", 817 ], 818 "withOptional": True or False, # Adds the `--with-optional` flag to `zypper patch`. 819 "withUpdate": True or False, # Adds the `--with-update` flag, to `zypper patch`. 820 }, 821 }, 822 "recurringSchedule": { # Sets the time for recurring patch deployments. # Required. Schedule recurring executions. 823 "endTime": "A String", # Optional. The end time at which a recurring patch deployment schedule is no longer active. 824 "frequency": "A String", # Required. The frequency unit of this recurring schedule. 825 "lastExecuteTime": "A String", # Output only. The time the last patch job ran successfully. 826 "monthly": { # Represents a monthly schedule. An example of a valid monthly schedule is "on the third Tuesday of the month" or "on the 15th of the month". # Required. Schedule with monthly executions. 827 "monthDay": 42, # Required. One day of the month. 1-31 indicates the 1st to the 31st day. -1 indicates the last day of the month. Months without the target day will be skipped. For example, a schedule to run "every month on the 31st" will not run in February, April, June, etc. 828 "weekDayOfMonth": { # Represents one week day in a month. An example is "the 4th Sunday". # Required. Week day in a month. 829 "dayOfWeek": "A String", # Required. A day of the week. 830 "dayOffset": 42, # Optional. Represents the number of days before or after the given week day of month that the patch deployment is scheduled for. For example if `week_ordinal` and `day_of_week` values point to the second day of the month and this `day_offset` value is set to `3`, the patch deployment takes place three days after the second Tuesday of the month. If this value is negative, for example -5, the patches are deployed five days before before the second Tuesday of the month. Allowed values are in range [-30, 30]. 831 "weekOrdinal": 42, # Required. Week number in a month. 1-4 indicates the 1st to 4th week of the month. -1 indicates the last week of the month. 832 }, 833 }, 834 "nextExecuteTime": "A String", # Output only. The time the next patch job is scheduled to run. 835 "startTime": "A String", # Optional. The time that the recurring schedule becomes effective. Defaults to `create_time` of the patch deployment. 836 "timeOfDay": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Time of the day to run a recurring deployment. 837 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. 838 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. 839 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. 840 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. 841 }, 842 "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. Defines the time zone that `time_of_day` is relative to. The rules for daylight saving time are determined by the chosen time zone. 843 "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York". 844 "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a". 845 }, 846 "weekly": { # Represents a weekly schedule. # Required. Schedule with weekly executions. 847 "dayOfWeek": "A String", # Required. Day of the week. 848 }, 849 }, 850 "rollout": { # Patch rollout configuration specifications. Contains details on the concurrency control when applying patch(es) to all targeted VMs. # Optional. Rollout strategy of the patch job. 851 "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. 852 "fixed": 42, # Specifies a fixed value. 853 "percent": 42, # Specifies the relative value defined as a percentage, which will be multiplied by a reference value. 854 }, 855 "mode": "A String", # Mode of the patch rollout. 856 }, 857 "state": "A String", # Output only. Current state of the patch deployment. 858 "updateTime": "A String", # Output only. Time the patch deployment was last updated. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 859 }, 860 ], 861}</pre> 862</div> 863 864<div class="method"> 865 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 866 <pre>Retrieves the next page of results. 867 868Args: 869 previous_request: The request for the previous page. (required) 870 previous_response: The response from the request for the previous page. (required) 871 872Returns: 873 A request object that you can call 'execute()' on to request the next 874 page. Returns None if there are no more items in the collection. 875 </pre> 876</div> 877 878<div class="method"> 879 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> 880 <pre>Update an OS Config patch deployment. 881 882Args: 883 name: string, Unique name for the patch deployment resource in a project. The patch deployment name is in the form: `projects/{project_id}/patchDeployments/{patch_deployment_id}`. This field is ignored when you create a new patch deployment. (required) 884 body: object, The request body. 885 The object takes the form of: 886 887{ # Patch deployments are configurations that individual patch jobs use to complete a patch. These configurations include instance filter, package repository settings, and a schedule. For more information about creating and managing patch deployments, see [Scheduling patch jobs](https://cloud.google.com/compute/docs/os-patch-management/schedule-patch-jobs). 888 "createTime": "A String", # Output only. Time the patch deployment was created. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 889 "description": "A String", # Optional. Description of the patch deployment. Length of the description is limited to 1024 characters. 890 "duration": "A String", # Optional. Duration of the patch. After the duration ends, the patch times out. 891 "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. VM instances to patch. 892 "all": True or False, # Target all VM instances in the project. If true, no other criteria is permitted. 893 "groupLabels": [ # Targets VM instances matching at least one of these label sets. This allows targeting of disparate groups, for example "env=prod or env=staging". 894 { # Represents a group of VMs that can be identified as having all these labels, for example "env=prod and app=web". 895 "labels": { # Compute Engine instance labels that must be present for a VM instance to be targeted by this filter. 896 "a_key": "A String", 897 }, 898 }, 899 ], 900 "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-". 901 "A String", 902 ], 903 "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]` 904 "A String", 905 ], 906 "zones": [ # Targets VM instances in ANY of these zones. Leave empty to target VM instances in any zone. 907 "A String", 908 ], 909 }, 910 "lastExecuteTime": "A String", # Output only. The last time a patch job was started by this deployment. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 911 "name": "A String", # Unique name for the patch deployment resource in a project. The patch deployment name is in the form: `projects/{project_id}/patchDeployments/{patch_deployment_id}`. This field is ignored when you create a new patch deployment. 912 "oneTimeSchedule": { # Sets the time for a one time patch deployment. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. # Required. Schedule a one-time execution. 913 "executeTime": "A String", # Required. The desired patch job execution time. 914 }, 915 "patchConfig": { # Patch configuration specifications. Contains details on how to apply the patch(es) to a VM instance. # Optional. Patch configuration that is applied. 916 "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. 917 "excludes": [ # List of packages to exclude from update. These packages will be excluded 918 "A String", 919 ], 920 "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. 921 "A String", 922 ], 923 "type": "A String", # By changing the type to DIST, the patching is performed using `apt-get dist-upgrade` instead. 924 }, 925 "goo": { # Googet patching is performed by running `googet update`. # Goo update settings. Use this setting to override the default `goo` patch rules. 926 }, 927 "postStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run after the patch update. 928 "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob. 929 "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. 930 42, 931 ], 932 "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. 933 "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. 934 "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. 935 "object": "A String", # Required. Name of the Google Cloud Storage object. 936 }, 937 "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\)). 938 "localPath": "A String", # An absolute path to the executable on the VM. 939 }, 940 "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob. 941 "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. 942 42, 943 ], 944 "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. 945 "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. 946 "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. 947 "object": "A String", # Required. Name of the Google Cloud Storage object. 948 }, 949 "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\)). 950 "localPath": "A String", # An absolute path to the executable on the VM. 951 }, 952 }, 953 "preStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run before the patch update. 954 "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob. 955 "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. 956 42, 957 ], 958 "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. 959 "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. 960 "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. 961 "object": "A String", # Required. Name of the Google Cloud Storage object. 962 }, 963 "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\)). 964 "localPath": "A String", # An absolute path to the executable on the VM. 965 }, 966 "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob. 967 "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. 968 42, 969 ], 970 "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. 971 "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. 972 "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. 973 "object": "A String", # Required. Name of the Google Cloud Storage object. 974 }, 975 "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\)). 976 "localPath": "A String", # An absolute path to the executable on the VM. 977 }, 978 }, 979 "rebootConfig": "A String", # Post-patch reboot settings. 980 "windowsUpdate": { # Windows patching is performed using the Windows Update Agent. # Windows update settings. Use this override the default windows patch rules. 981 "classifications": [ # Only apply updates of these windows update classifications. If empty, all updates are applied. 982 "A String", 983 ], 984 "excludes": [ # List of KBs to exclude from update. 985 "A String", 986 ], 987 "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. 988 "A String", 989 ], 990 }, 991 "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. 992 "excludes": [ # List of packages to exclude from update. These packages are excluded by using the yum `--exclude` flag. 993 "A String", 994 ], 995 "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. 996 "A String", 997 ], 998 "minimal": True or False, # Will cause patch to run `yum update-minimal` instead. 999 "security": True or False, # Adds the `--security` flag to `yum update`. Not supported on all platforms. 1000 }, 1001 "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. 1002 "categories": [ # Install only patches with these categories. Common categories include security, recommended, and feature. 1003 "A String", 1004 ], 1005 "excludes": [ # List of patches to exclude from update. 1006 "A String", 1007 ], 1008 "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. 1009 "A String", 1010 ], 1011 "severities": [ # Install only patches with these severities. Common severities include critical, important, moderate, and low. 1012 "A String", 1013 ], 1014 "withOptional": True or False, # Adds the `--with-optional` flag to `zypper patch`. 1015 "withUpdate": True or False, # Adds the `--with-update` flag, to `zypper patch`. 1016 }, 1017 }, 1018 "recurringSchedule": { # Sets the time for recurring patch deployments. # Required. Schedule recurring executions. 1019 "endTime": "A String", # Optional. The end time at which a recurring patch deployment schedule is no longer active. 1020 "frequency": "A String", # Required. The frequency unit of this recurring schedule. 1021 "lastExecuteTime": "A String", # Output only. The time the last patch job ran successfully. 1022 "monthly": { # Represents a monthly schedule. An example of a valid monthly schedule is "on the third Tuesday of the month" or "on the 15th of the month". # Required. Schedule with monthly executions. 1023 "monthDay": 42, # Required. One day of the month. 1-31 indicates the 1st to the 31st day. -1 indicates the last day of the month. Months without the target day will be skipped. For example, a schedule to run "every month on the 31st" will not run in February, April, June, etc. 1024 "weekDayOfMonth": { # Represents one week day in a month. An example is "the 4th Sunday". # Required. Week day in a month. 1025 "dayOfWeek": "A String", # Required. A day of the week. 1026 "dayOffset": 42, # Optional. Represents the number of days before or after the given week day of month that the patch deployment is scheduled for. For example if `week_ordinal` and `day_of_week` values point to the second day of the month and this `day_offset` value is set to `3`, the patch deployment takes place three days after the second Tuesday of the month. If this value is negative, for example -5, the patches are deployed five days before before the second Tuesday of the month. Allowed values are in range [-30, 30]. 1027 "weekOrdinal": 42, # Required. Week number in a month. 1-4 indicates the 1st to 4th week of the month. -1 indicates the last week of the month. 1028 }, 1029 }, 1030 "nextExecuteTime": "A String", # Output only. The time the next patch job is scheduled to run. 1031 "startTime": "A String", # Optional. The time that the recurring schedule becomes effective. Defaults to `create_time` of the patch deployment. 1032 "timeOfDay": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Time of the day to run a recurring deployment. 1033 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. 1034 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. 1035 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. 1036 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. 1037 }, 1038 "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. Defines the time zone that `time_of_day` is relative to. The rules for daylight saving time are determined by the chosen time zone. 1039 "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York". 1040 "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a". 1041 }, 1042 "weekly": { # Represents a weekly schedule. # Required. Schedule with weekly executions. 1043 "dayOfWeek": "A String", # Required. Day of the week. 1044 }, 1045 }, 1046 "rollout": { # Patch rollout configuration specifications. Contains details on the concurrency control when applying patch(es) to all targeted VMs. # Optional. Rollout strategy of the patch job. 1047 "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. 1048 "fixed": 42, # Specifies a fixed value. 1049 "percent": 42, # Specifies the relative value defined as a percentage, which will be multiplied by a reference value. 1050 }, 1051 "mode": "A String", # Mode of the patch rollout. 1052 }, 1053 "state": "A String", # Output only. Current state of the patch deployment. 1054 "updateTime": "A String", # Output only. Time the patch deployment was last updated. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 1055} 1056 1057 updateMask: string, Optional. Field mask that controls which fields of the patch deployment should be updated. 1058 x__xgafv: string, V1 error format. 1059 Allowed values 1060 1 - v1 error format 1061 2 - v2 error format 1062 1063Returns: 1064 An object of the form: 1065 1066 { # Patch deployments are configurations that individual patch jobs use to complete a patch. These configurations include instance filter, package repository settings, and a schedule. For more information about creating and managing patch deployments, see [Scheduling patch jobs](https://cloud.google.com/compute/docs/os-patch-management/schedule-patch-jobs). 1067 "createTime": "A String", # Output only. Time the patch deployment was created. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 1068 "description": "A String", # Optional. Description of the patch deployment. Length of the description is limited to 1024 characters. 1069 "duration": "A String", # Optional. Duration of the patch. After the duration ends, the patch times out. 1070 "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. VM instances to patch. 1071 "all": True or False, # Target all VM instances in the project. If true, no other criteria is permitted. 1072 "groupLabels": [ # Targets VM instances matching at least one of these label sets. This allows targeting of disparate groups, for example "env=prod or env=staging". 1073 { # Represents a group of VMs that can be identified as having all these labels, for example "env=prod and app=web". 1074 "labels": { # Compute Engine instance labels that must be present for a VM instance to be targeted by this filter. 1075 "a_key": "A String", 1076 }, 1077 }, 1078 ], 1079 "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-". 1080 "A String", 1081 ], 1082 "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]` 1083 "A String", 1084 ], 1085 "zones": [ # Targets VM instances in ANY of these zones. Leave empty to target VM instances in any zone. 1086 "A String", 1087 ], 1088 }, 1089 "lastExecuteTime": "A String", # Output only. The last time a patch job was started by this deployment. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 1090 "name": "A String", # Unique name for the patch deployment resource in a project. The patch deployment name is in the form: `projects/{project_id}/patchDeployments/{patch_deployment_id}`. This field is ignored when you create a new patch deployment. 1091 "oneTimeSchedule": { # Sets the time for a one time patch deployment. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. # Required. Schedule a one-time execution. 1092 "executeTime": "A String", # Required. The desired patch job execution time. 1093 }, 1094 "patchConfig": { # Patch configuration specifications. Contains details on how to apply the patch(es) to a VM instance. # Optional. Patch configuration that is applied. 1095 "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. 1096 "excludes": [ # List of packages to exclude from update. These packages will be excluded 1097 "A String", 1098 ], 1099 "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. 1100 "A String", 1101 ], 1102 "type": "A String", # By changing the type to DIST, the patching is performed using `apt-get dist-upgrade` instead. 1103 }, 1104 "goo": { # Googet patching is performed by running `googet update`. # Goo update settings. Use this setting to override the default `goo` patch rules. 1105 }, 1106 "postStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run after the patch update. 1107 "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob. 1108 "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. 1109 42, 1110 ], 1111 "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. 1112 "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. 1113 "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. 1114 "object": "A String", # Required. Name of the Google Cloud Storage object. 1115 }, 1116 "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\)). 1117 "localPath": "A String", # An absolute path to the executable on the VM. 1118 }, 1119 "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob. 1120 "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. 1121 42, 1122 ], 1123 "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. 1124 "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. 1125 "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. 1126 "object": "A String", # Required. Name of the Google Cloud Storage object. 1127 }, 1128 "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\)). 1129 "localPath": "A String", # An absolute path to the executable on the VM. 1130 }, 1131 }, 1132 "preStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run before the patch update. 1133 "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob. 1134 "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. 1135 42, 1136 ], 1137 "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. 1138 "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. 1139 "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. 1140 "object": "A String", # Required. Name of the Google Cloud Storage object. 1141 }, 1142 "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\)). 1143 "localPath": "A String", # An absolute path to the executable on the VM. 1144 }, 1145 "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob. 1146 "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. 1147 42, 1148 ], 1149 "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. 1150 "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. 1151 "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. 1152 "object": "A String", # Required. Name of the Google Cloud Storage object. 1153 }, 1154 "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\)). 1155 "localPath": "A String", # An absolute path to the executable on the VM. 1156 }, 1157 }, 1158 "rebootConfig": "A String", # Post-patch reboot settings. 1159 "windowsUpdate": { # Windows patching is performed using the Windows Update Agent. # Windows update settings. Use this override the default windows patch rules. 1160 "classifications": [ # Only apply updates of these windows update classifications. If empty, all updates are applied. 1161 "A String", 1162 ], 1163 "excludes": [ # List of KBs to exclude from update. 1164 "A String", 1165 ], 1166 "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. 1167 "A String", 1168 ], 1169 }, 1170 "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. 1171 "excludes": [ # List of packages to exclude from update. These packages are excluded by using the yum `--exclude` flag. 1172 "A String", 1173 ], 1174 "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. 1175 "A String", 1176 ], 1177 "minimal": True or False, # Will cause patch to run `yum update-minimal` instead. 1178 "security": True or False, # Adds the `--security` flag to `yum update`. Not supported on all platforms. 1179 }, 1180 "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. 1181 "categories": [ # Install only patches with these categories. Common categories include security, recommended, and feature. 1182 "A String", 1183 ], 1184 "excludes": [ # List of patches to exclude from update. 1185 "A String", 1186 ], 1187 "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. 1188 "A String", 1189 ], 1190 "severities": [ # Install only patches with these severities. Common severities include critical, important, moderate, and low. 1191 "A String", 1192 ], 1193 "withOptional": True or False, # Adds the `--with-optional` flag to `zypper patch`. 1194 "withUpdate": True or False, # Adds the `--with-update` flag, to `zypper patch`. 1195 }, 1196 }, 1197 "recurringSchedule": { # Sets the time for recurring patch deployments. # Required. Schedule recurring executions. 1198 "endTime": "A String", # Optional. The end time at which a recurring patch deployment schedule is no longer active. 1199 "frequency": "A String", # Required. The frequency unit of this recurring schedule. 1200 "lastExecuteTime": "A String", # Output only. The time the last patch job ran successfully. 1201 "monthly": { # Represents a monthly schedule. An example of a valid monthly schedule is "on the third Tuesday of the month" or "on the 15th of the month". # Required. Schedule with monthly executions. 1202 "monthDay": 42, # Required. One day of the month. 1-31 indicates the 1st to the 31st day. -1 indicates the last day of the month. Months without the target day will be skipped. For example, a schedule to run "every month on the 31st" will not run in February, April, June, etc. 1203 "weekDayOfMonth": { # Represents one week day in a month. An example is "the 4th Sunday". # Required. Week day in a month. 1204 "dayOfWeek": "A String", # Required. A day of the week. 1205 "dayOffset": 42, # Optional. Represents the number of days before or after the given week day of month that the patch deployment is scheduled for. For example if `week_ordinal` and `day_of_week` values point to the second day of the month and this `day_offset` value is set to `3`, the patch deployment takes place three days after the second Tuesday of the month. If this value is negative, for example -5, the patches are deployed five days before before the second Tuesday of the month. Allowed values are in range [-30, 30]. 1206 "weekOrdinal": 42, # Required. Week number in a month. 1-4 indicates the 1st to 4th week of the month. -1 indicates the last week of the month. 1207 }, 1208 }, 1209 "nextExecuteTime": "A String", # Output only. The time the next patch job is scheduled to run. 1210 "startTime": "A String", # Optional. The time that the recurring schedule becomes effective. Defaults to `create_time` of the patch deployment. 1211 "timeOfDay": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Time of the day to run a recurring deployment. 1212 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. 1213 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. 1214 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. 1215 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. 1216 }, 1217 "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. Defines the time zone that `time_of_day` is relative to. The rules for daylight saving time are determined by the chosen time zone. 1218 "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York". 1219 "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a". 1220 }, 1221 "weekly": { # Represents a weekly schedule. # Required. Schedule with weekly executions. 1222 "dayOfWeek": "A String", # Required. Day of the week. 1223 }, 1224 }, 1225 "rollout": { # Patch rollout configuration specifications. Contains details on the concurrency control when applying patch(es) to all targeted VMs. # Optional. Rollout strategy of the patch job. 1226 "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. 1227 "fixed": 42, # Specifies a fixed value. 1228 "percent": 42, # Specifies the relative value defined as a percentage, which will be multiplied by a reference value. 1229 }, 1230 "mode": "A String", # Mode of the patch rollout. 1231 }, 1232 "state": "A String", # Output only. Current state of the patch deployment. 1233 "updateTime": "A String", # Output only. Time the patch deployment was last updated. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 1234}</pre> 1235</div> 1236 1237<div class="method"> 1238 <code class="details" id="pause">pause(name, body=None, x__xgafv=None)</code> 1239 <pre>Change state of patch deployment to "PAUSED". Patch deployment in paused state doesn't generate patch jobs. 1240 1241Args: 1242 name: string, Required. The resource name of the patch deployment in the form `projects/*/patchDeployments/*`. (required) 1243 body: object, The request body. 1244 The object takes the form of: 1245 1246{ # A request message for pausing a patch deployment. 1247} 1248 1249 x__xgafv: string, V1 error format. 1250 Allowed values 1251 1 - v1 error format 1252 2 - v2 error format 1253 1254Returns: 1255 An object of the form: 1256 1257 { # Patch deployments are configurations that individual patch jobs use to complete a patch. These configurations include instance filter, package repository settings, and a schedule. For more information about creating and managing patch deployments, see [Scheduling patch jobs](https://cloud.google.com/compute/docs/os-patch-management/schedule-patch-jobs). 1258 "createTime": "A String", # Output only. Time the patch deployment was created. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 1259 "description": "A String", # Optional. Description of the patch deployment. Length of the description is limited to 1024 characters. 1260 "duration": "A String", # Optional. Duration of the patch. After the duration ends, the patch times out. 1261 "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. VM instances to patch. 1262 "all": True or False, # Target all VM instances in the project. If true, no other criteria is permitted. 1263 "groupLabels": [ # Targets VM instances matching at least one of these label sets. This allows targeting of disparate groups, for example "env=prod or env=staging". 1264 { # Represents a group of VMs that can be identified as having all these labels, for example "env=prod and app=web". 1265 "labels": { # Compute Engine instance labels that must be present for a VM instance to be targeted by this filter. 1266 "a_key": "A String", 1267 }, 1268 }, 1269 ], 1270 "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-". 1271 "A String", 1272 ], 1273 "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]` 1274 "A String", 1275 ], 1276 "zones": [ # Targets VM instances in ANY of these zones. Leave empty to target VM instances in any zone. 1277 "A String", 1278 ], 1279 }, 1280 "lastExecuteTime": "A String", # Output only. The last time a patch job was started by this deployment. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 1281 "name": "A String", # Unique name for the patch deployment resource in a project. The patch deployment name is in the form: `projects/{project_id}/patchDeployments/{patch_deployment_id}`. This field is ignored when you create a new patch deployment. 1282 "oneTimeSchedule": { # Sets the time for a one time patch deployment. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. # Required. Schedule a one-time execution. 1283 "executeTime": "A String", # Required. The desired patch job execution time. 1284 }, 1285 "patchConfig": { # Patch configuration specifications. Contains details on how to apply the patch(es) to a VM instance. # Optional. Patch configuration that is applied. 1286 "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. 1287 "excludes": [ # List of packages to exclude from update. These packages will be excluded 1288 "A String", 1289 ], 1290 "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. 1291 "A String", 1292 ], 1293 "type": "A String", # By changing the type to DIST, the patching is performed using `apt-get dist-upgrade` instead. 1294 }, 1295 "goo": { # Googet patching is performed by running `googet update`. # Goo update settings. Use this setting to override the default `goo` patch rules. 1296 }, 1297 "postStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run after the patch update. 1298 "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob. 1299 "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. 1300 42, 1301 ], 1302 "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. 1303 "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. 1304 "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. 1305 "object": "A String", # Required. Name of the Google Cloud Storage object. 1306 }, 1307 "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\)). 1308 "localPath": "A String", # An absolute path to the executable on the VM. 1309 }, 1310 "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob. 1311 "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. 1312 42, 1313 ], 1314 "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. 1315 "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. 1316 "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. 1317 "object": "A String", # Required. Name of the Google Cloud Storage object. 1318 }, 1319 "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\)). 1320 "localPath": "A String", # An absolute path to the executable on the VM. 1321 }, 1322 }, 1323 "preStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run before the patch update. 1324 "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob. 1325 "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. 1326 42, 1327 ], 1328 "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. 1329 "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. 1330 "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. 1331 "object": "A String", # Required. Name of the Google Cloud Storage object. 1332 }, 1333 "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\)). 1334 "localPath": "A String", # An absolute path to the executable on the VM. 1335 }, 1336 "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob. 1337 "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. 1338 42, 1339 ], 1340 "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. 1341 "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. 1342 "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. 1343 "object": "A String", # Required. Name of the Google Cloud Storage object. 1344 }, 1345 "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\)). 1346 "localPath": "A String", # An absolute path to the executable on the VM. 1347 }, 1348 }, 1349 "rebootConfig": "A String", # Post-patch reboot settings. 1350 "windowsUpdate": { # Windows patching is performed using the Windows Update Agent. # Windows update settings. Use this override the default windows patch rules. 1351 "classifications": [ # Only apply updates of these windows update classifications. If empty, all updates are applied. 1352 "A String", 1353 ], 1354 "excludes": [ # List of KBs to exclude from update. 1355 "A String", 1356 ], 1357 "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. 1358 "A String", 1359 ], 1360 }, 1361 "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. 1362 "excludes": [ # List of packages to exclude from update. These packages are excluded by using the yum `--exclude` flag. 1363 "A String", 1364 ], 1365 "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. 1366 "A String", 1367 ], 1368 "minimal": True or False, # Will cause patch to run `yum update-minimal` instead. 1369 "security": True or False, # Adds the `--security` flag to `yum update`. Not supported on all platforms. 1370 }, 1371 "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. 1372 "categories": [ # Install only patches with these categories. Common categories include security, recommended, and feature. 1373 "A String", 1374 ], 1375 "excludes": [ # List of patches to exclude from update. 1376 "A String", 1377 ], 1378 "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. 1379 "A String", 1380 ], 1381 "severities": [ # Install only patches with these severities. Common severities include critical, important, moderate, and low. 1382 "A String", 1383 ], 1384 "withOptional": True or False, # Adds the `--with-optional` flag to `zypper patch`. 1385 "withUpdate": True or False, # Adds the `--with-update` flag, to `zypper patch`. 1386 }, 1387 }, 1388 "recurringSchedule": { # Sets the time for recurring patch deployments. # Required. Schedule recurring executions. 1389 "endTime": "A String", # Optional. The end time at which a recurring patch deployment schedule is no longer active. 1390 "frequency": "A String", # Required. The frequency unit of this recurring schedule. 1391 "lastExecuteTime": "A String", # Output only. The time the last patch job ran successfully. 1392 "monthly": { # Represents a monthly schedule. An example of a valid monthly schedule is "on the third Tuesday of the month" or "on the 15th of the month". # Required. Schedule with monthly executions. 1393 "monthDay": 42, # Required. One day of the month. 1-31 indicates the 1st to the 31st day. -1 indicates the last day of the month. Months without the target day will be skipped. For example, a schedule to run "every month on the 31st" will not run in February, April, June, etc. 1394 "weekDayOfMonth": { # Represents one week day in a month. An example is "the 4th Sunday". # Required. Week day in a month. 1395 "dayOfWeek": "A String", # Required. A day of the week. 1396 "dayOffset": 42, # Optional. Represents the number of days before or after the given week day of month that the patch deployment is scheduled for. For example if `week_ordinal` and `day_of_week` values point to the second day of the month and this `day_offset` value is set to `3`, the patch deployment takes place three days after the second Tuesday of the month. If this value is negative, for example -5, the patches are deployed five days before before the second Tuesday of the month. Allowed values are in range [-30, 30]. 1397 "weekOrdinal": 42, # Required. Week number in a month. 1-4 indicates the 1st to 4th week of the month. -1 indicates the last week of the month. 1398 }, 1399 }, 1400 "nextExecuteTime": "A String", # Output only. The time the next patch job is scheduled to run. 1401 "startTime": "A String", # Optional. The time that the recurring schedule becomes effective. Defaults to `create_time` of the patch deployment. 1402 "timeOfDay": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Time of the day to run a recurring deployment. 1403 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. 1404 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. 1405 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. 1406 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. 1407 }, 1408 "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. Defines the time zone that `time_of_day` is relative to. The rules for daylight saving time are determined by the chosen time zone. 1409 "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York". 1410 "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a". 1411 }, 1412 "weekly": { # Represents a weekly schedule. # Required. Schedule with weekly executions. 1413 "dayOfWeek": "A String", # Required. Day of the week. 1414 }, 1415 }, 1416 "rollout": { # Patch rollout configuration specifications. Contains details on the concurrency control when applying patch(es) to all targeted VMs. # Optional. Rollout strategy of the patch job. 1417 "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. 1418 "fixed": 42, # Specifies a fixed value. 1419 "percent": 42, # Specifies the relative value defined as a percentage, which will be multiplied by a reference value. 1420 }, 1421 "mode": "A String", # Mode of the patch rollout. 1422 }, 1423 "state": "A String", # Output only. Current state of the patch deployment. 1424 "updateTime": "A String", # Output only. Time the patch deployment was last updated. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 1425}</pre> 1426</div> 1427 1428<div class="method"> 1429 <code class="details" id="resume">resume(name, body=None, x__xgafv=None)</code> 1430 <pre>Change state of patch deployment back to "ACTIVE". Patch deployment in active state continues to generate patch jobs. 1431 1432Args: 1433 name: string, Required. The resource name of the patch deployment in the form `projects/*/patchDeployments/*`. (required) 1434 body: object, The request body. 1435 The object takes the form of: 1436 1437{ # A request message for resuming a patch deployment. 1438} 1439 1440 x__xgafv: string, V1 error format. 1441 Allowed values 1442 1 - v1 error format 1443 2 - v2 error format 1444 1445Returns: 1446 An object of the form: 1447 1448 { # Patch deployments are configurations that individual patch jobs use to complete a patch. These configurations include instance filter, package repository settings, and a schedule. For more information about creating and managing patch deployments, see [Scheduling patch jobs](https://cloud.google.com/compute/docs/os-patch-management/schedule-patch-jobs). 1449 "createTime": "A String", # Output only. Time the patch deployment was created. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 1450 "description": "A String", # Optional. Description of the patch deployment. Length of the description is limited to 1024 characters. 1451 "duration": "A String", # Optional. Duration of the patch. After the duration ends, the patch times out. 1452 "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. VM instances to patch. 1453 "all": True or False, # Target all VM instances in the project. If true, no other criteria is permitted. 1454 "groupLabels": [ # Targets VM instances matching at least one of these label sets. This allows targeting of disparate groups, for example "env=prod or env=staging". 1455 { # Represents a group of VMs that can be identified as having all these labels, for example "env=prod and app=web". 1456 "labels": { # Compute Engine instance labels that must be present for a VM instance to be targeted by this filter. 1457 "a_key": "A String", 1458 }, 1459 }, 1460 ], 1461 "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-". 1462 "A String", 1463 ], 1464 "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]` 1465 "A String", 1466 ], 1467 "zones": [ # Targets VM instances in ANY of these zones. Leave empty to target VM instances in any zone. 1468 "A String", 1469 ], 1470 }, 1471 "lastExecuteTime": "A String", # Output only. The last time a patch job was started by this deployment. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 1472 "name": "A String", # Unique name for the patch deployment resource in a project. The patch deployment name is in the form: `projects/{project_id}/patchDeployments/{patch_deployment_id}`. This field is ignored when you create a new patch deployment. 1473 "oneTimeSchedule": { # Sets the time for a one time patch deployment. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. # Required. Schedule a one-time execution. 1474 "executeTime": "A String", # Required. The desired patch job execution time. 1475 }, 1476 "patchConfig": { # Patch configuration specifications. Contains details on how to apply the patch(es) to a VM instance. # Optional. Patch configuration that is applied. 1477 "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. 1478 "excludes": [ # List of packages to exclude from update. These packages will be excluded 1479 "A String", 1480 ], 1481 "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. 1482 "A String", 1483 ], 1484 "type": "A String", # By changing the type to DIST, the patching is performed using `apt-get dist-upgrade` instead. 1485 }, 1486 "goo": { # Googet patching is performed by running `googet update`. # Goo update settings. Use this setting to override the default `goo` patch rules. 1487 }, 1488 "postStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run after the patch update. 1489 "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob. 1490 "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. 1491 42, 1492 ], 1493 "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. 1494 "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. 1495 "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. 1496 "object": "A String", # Required. Name of the Google Cloud Storage object. 1497 }, 1498 "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\)). 1499 "localPath": "A String", # An absolute path to the executable on the VM. 1500 }, 1501 "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob. 1502 "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. 1503 42, 1504 ], 1505 "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. 1506 "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. 1507 "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. 1508 "object": "A String", # Required. Name of the Google Cloud Storage object. 1509 }, 1510 "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\)). 1511 "localPath": "A String", # An absolute path to the executable on the VM. 1512 }, 1513 }, 1514 "preStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run before the patch update. 1515 "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob. 1516 "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. 1517 42, 1518 ], 1519 "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. 1520 "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. 1521 "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. 1522 "object": "A String", # Required. Name of the Google Cloud Storage object. 1523 }, 1524 "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\)). 1525 "localPath": "A String", # An absolute path to the executable on the VM. 1526 }, 1527 "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob. 1528 "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. 1529 42, 1530 ], 1531 "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. 1532 "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. 1533 "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. 1534 "object": "A String", # Required. Name of the Google Cloud Storage object. 1535 }, 1536 "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\)). 1537 "localPath": "A String", # An absolute path to the executable on the VM. 1538 }, 1539 }, 1540 "rebootConfig": "A String", # Post-patch reboot settings. 1541 "windowsUpdate": { # Windows patching is performed using the Windows Update Agent. # Windows update settings. Use this override the default windows patch rules. 1542 "classifications": [ # Only apply updates of these windows update classifications. If empty, all updates are applied. 1543 "A String", 1544 ], 1545 "excludes": [ # List of KBs to exclude from update. 1546 "A String", 1547 ], 1548 "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. 1549 "A String", 1550 ], 1551 }, 1552 "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. 1553 "excludes": [ # List of packages to exclude from update. These packages are excluded by using the yum `--exclude` flag. 1554 "A String", 1555 ], 1556 "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. 1557 "A String", 1558 ], 1559 "minimal": True or False, # Will cause patch to run `yum update-minimal` instead. 1560 "security": True or False, # Adds the `--security` flag to `yum update`. Not supported on all platforms. 1561 }, 1562 "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. 1563 "categories": [ # Install only patches with these categories. Common categories include security, recommended, and feature. 1564 "A String", 1565 ], 1566 "excludes": [ # List of patches to exclude from update. 1567 "A String", 1568 ], 1569 "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. 1570 "A String", 1571 ], 1572 "severities": [ # Install only patches with these severities. Common severities include critical, important, moderate, and low. 1573 "A String", 1574 ], 1575 "withOptional": True or False, # Adds the `--with-optional` flag to `zypper patch`. 1576 "withUpdate": True or False, # Adds the `--with-update` flag, to `zypper patch`. 1577 }, 1578 }, 1579 "recurringSchedule": { # Sets the time for recurring patch deployments. # Required. Schedule recurring executions. 1580 "endTime": "A String", # Optional. The end time at which a recurring patch deployment schedule is no longer active. 1581 "frequency": "A String", # Required. The frequency unit of this recurring schedule. 1582 "lastExecuteTime": "A String", # Output only. The time the last patch job ran successfully. 1583 "monthly": { # Represents a monthly schedule. An example of a valid monthly schedule is "on the third Tuesday of the month" or "on the 15th of the month". # Required. Schedule with monthly executions. 1584 "monthDay": 42, # Required. One day of the month. 1-31 indicates the 1st to the 31st day. -1 indicates the last day of the month. Months without the target day will be skipped. For example, a schedule to run "every month on the 31st" will not run in February, April, June, etc. 1585 "weekDayOfMonth": { # Represents one week day in a month. An example is "the 4th Sunday". # Required. Week day in a month. 1586 "dayOfWeek": "A String", # Required. A day of the week. 1587 "dayOffset": 42, # Optional. Represents the number of days before or after the given week day of month that the patch deployment is scheduled for. For example if `week_ordinal` and `day_of_week` values point to the second day of the month and this `day_offset` value is set to `3`, the patch deployment takes place three days after the second Tuesday of the month. If this value is negative, for example -5, the patches are deployed five days before before the second Tuesday of the month. Allowed values are in range [-30, 30]. 1588 "weekOrdinal": 42, # Required. Week number in a month. 1-4 indicates the 1st to 4th week of the month. -1 indicates the last week of the month. 1589 }, 1590 }, 1591 "nextExecuteTime": "A String", # Output only. The time the next patch job is scheduled to run. 1592 "startTime": "A String", # Optional. The time that the recurring schedule becomes effective. Defaults to `create_time` of the patch deployment. 1593 "timeOfDay": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Time of the day to run a recurring deployment. 1594 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. 1595 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. 1596 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. 1597 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. 1598 }, 1599 "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. Defines the time zone that `time_of_day` is relative to. The rules for daylight saving time are determined by the chosen time zone. 1600 "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York". 1601 "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a". 1602 }, 1603 "weekly": { # Represents a weekly schedule. # Required. Schedule with weekly executions. 1604 "dayOfWeek": "A String", # Required. Day of the week. 1605 }, 1606 }, 1607 "rollout": { # Patch rollout configuration specifications. Contains details on the concurrency control when applying patch(es) to all targeted VMs. # Optional. Rollout strategy of the patch job. 1608 "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. 1609 "fixed": 42, # Specifies a fixed value. 1610 "percent": 42, # Specifies the relative value defined as a percentage, which will be multiplied by a reference value. 1611 }, 1612 "mode": "A String", # Mode of the patch rollout. 1613 }, 1614 "state": "A String", # Output only. Current state of the patch deployment. 1615 "updateTime": "A String", # Output only. Time the patch deployment was last updated. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 1616}</pre> 1617</div> 1618 1619</body></html>