| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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">Cloud 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="#create">create(parent, body=None, patchDeploymentId=None, x__xgafv=None)</a></code></p> |
| 79 | <p class="firstline">Create an OS Config patch deployment.</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Delete an OS Config patch deployment.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 85 | <p class="firstline">Get an OS Config patch deployment.</p> |
| 86 | <p class="toc_element"> |
| 87 | <code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p> |
| 88 | <p class="firstline">Get a page of OS Config patch deployments.</p> |
| 89 | <p class="toc_element"> |
| 90 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 91 | <p class="firstline">Retrieves the next page of results.</p> |
| 92 | <h3>Method Details</h3> |
| 93 | <div class="method"> |
| 94 | <code class="details" id="create">create(parent, body=None, patchDeploymentId=None, x__xgafv=None)</code> |
| 95 | <pre>Create an OS Config patch deployment. |
| 96 | |
| 97 | Args: |
| 98 | parent: string, Required. The project to apply this patch deployment to in the form `projects/*`. (required) |
| 99 | body: object, The request body. |
| 100 | The object takes the form of: |
| 101 | |
| 102 | { # Patch deployments are configurations that individual patch jobs use to |
| 103 | # complete a patch. These configurations include instance filter, package |
| 104 | # repository settings, and a schedule. For more information about creating and |
| 105 | # managing patch deployments, see [Scheduling patch |
| 106 | # jobs](https://cloud.google.com/compute/docs/os-patch-management/schedule-patch-jobs). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 107 | "patchConfig": { # Patch configuration specifications. Contains details on how to apply the # Optional. Patch configuration that is applied. |
| 108 | # patch(es) to a VM instance. |
| 109 | "yum": { # Yum patching is performed by executing `yum update`. Additional options # Yum update settings. Use this setting to override the default `yum` patch |
| 110 | # rules. |
| 111 | # can be set to control how this is executed. |
| 112 | # |
| 113 | # Note that not all settings are supported on all platforms. |
| 114 | "excludes": [ # List of packages to exclude from update. These packages are excluded by |
| 115 | # using the yum `--exclude` flag. |
| 116 | "A String", |
| 117 | ], |
| 118 | "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages |
| 119 | # that will be updated. If these packages are not installed, they will be |
| 120 | # ignored. This field must not be specified with any other patch |
| 121 | # configuration fields. |
| 122 | "A String", |
| 123 | ], |
| 124 | "minimal": True or False, # Will cause patch to run `yum update-minimal` instead. |
| 125 | "security": True or False, # Adds the `--security` flag to `yum update`. Not supported on |
| 126 | # all platforms. |
| 127 | }, |
| 128 | "postStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run after the patch update. |
| 129 | "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob. |
| 130 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is |
| 131 | # specified the script will be executed directly, which will likely |
| 132 | # only succeed for scripts with [shebang lines] |
| 133 | # (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| 134 | "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. |
| 135 | "object": "A String", # Required. Name of the Google Cloud Storage object. |
| 136 | "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. |
| 137 | "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to |
| 138 | # ensure that the ExecStep specified by this PatchJob does not change. |
| 139 | }, |
| 140 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the |
| 141 | # execution can return to indicate a success. |
| 142 | 42, |
| 143 | ], |
| 144 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 145 | }, |
| 146 | "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob. |
| 147 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is |
| 148 | # specified the script will be executed directly, which will likely |
| 149 | # only succeed for scripts with [shebang lines] |
| 150 | # (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| 151 | "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. |
| 152 | "object": "A String", # Required. Name of the Google Cloud Storage object. |
| 153 | "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. |
| 154 | "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to |
| 155 | # ensure that the ExecStep specified by this PatchJob does not change. |
| 156 | }, |
| 157 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the |
| 158 | # execution can return to indicate a success. |
| 159 | 42, |
| 160 | ], |
| 161 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 162 | }, |
| 163 | }, |
| 164 | "goo": { # Googet patching is performed by running `googet update`. # Goo update settings. Use this setting to override the default `goo` patch |
| 165 | # rules. |
| 166 | }, |
| 167 | "rebootConfig": "A String", # Post-patch reboot settings. |
| 168 | "apt": { # Apt patching is completed by executing `apt-get update && apt-get # Apt update settings. Use this setting to override the default `apt` patch |
| 169 | # rules. |
| 170 | # upgrade`. Additional options can be set to control how this is executed. |
| 171 | "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages |
| 172 | # that will be updated. If these packages are not installed, they will be |
| 173 | # ignored. This field cannot be specified with any other patch configuration |
| 174 | # fields. |
| 175 | "A String", |
| 176 | ], |
| 177 | "type": "A String", # By changing the type to DIST, the patching is performed |
| 178 | # using `apt-get dist-upgrade` instead. |
| 179 | "excludes": [ # List of packages to exclude from update. These packages will be excluded |
| 180 | "A String", |
| 181 | ], |
| 182 | }, |
| 183 | "windowsUpdate": { # Windows patching is performed using the Windows Update Agent. # Windows update settings. Use this override the default windows patch rules. |
| 184 | "exclusivePatches": [ # An exclusive list of kbs to be updated. These are the only patches |
| 185 | # that will be updated. This field must not be used with other |
| 186 | # patch configurations. |
| 187 | "A String", |
| 188 | ], |
| 189 | "excludes": [ # List of KBs to exclude from update. |
| 190 | "A String", |
| 191 | ], |
| 192 | "classifications": [ # Only apply updates of these windows update classifications. If empty, all |
| 193 | # updates are applied. |
| 194 | "A String", |
| 195 | ], |
| 196 | }, |
| 197 | "preStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run before the patch update. |
| 198 | "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob. |
| 199 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is |
| 200 | # specified the script will be executed directly, which will likely |
| 201 | # only succeed for scripts with [shebang lines] |
| 202 | # (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| 203 | "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. |
| 204 | "object": "A String", # Required. Name of the Google Cloud Storage object. |
| 205 | "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. |
| 206 | "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to |
| 207 | # ensure that the ExecStep specified by this PatchJob does not change. |
| 208 | }, |
| 209 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the |
| 210 | # execution can return to indicate a success. |
| 211 | 42, |
| 212 | ], |
| 213 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 214 | }, |
| 215 | "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob. |
| 216 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is |
| 217 | # specified the script will be executed directly, which will likely |
| 218 | # only succeed for scripts with [shebang lines] |
| 219 | # (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| 220 | "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. |
| 221 | "object": "A String", # Required. Name of the Google Cloud Storage object. |
| 222 | "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. |
| 223 | "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to |
| 224 | # ensure that the ExecStep specified by this PatchJob does not change. |
| 225 | }, |
| 226 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the |
| 227 | # execution can return to indicate a success. |
| 228 | 42, |
| 229 | ], |
| 230 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 231 | }, |
| 232 | }, |
| 233 | "zypper": { # Zypper patching is performed by running `zypper patch`. # Zypper update settings. Use this setting to override the default `zypper` |
| 234 | # patch rules. |
| 235 | # See also https://en.opensuse.org/SDB:Zypper_manual. |
| 236 | "exclusivePatches": [ # An exclusive list of patches to be updated. These are the only patches |
| 237 | # that will be installed using 'zypper patch patch:<patch_name>' command. |
| 238 | # This field must not be used with any other patch configuration fields. |
| 239 | "A String", |
| 240 | ], |
| 241 | "withUpdate": True or False, # Adds the `--with-update` flag, to `zypper patch`. |
| 242 | "excludes": [ # List of patches to exclude from update. |
| 243 | "A String", |
| 244 | ], |
| 245 | "severities": [ # Install only patches with these severities. |
| 246 | # Common severities include critical, important, moderate, and low. |
| 247 | "A String", |
| 248 | ], |
| 249 | "withOptional": True or False, # Adds the `--with-optional` flag to `zypper patch`. |
| 250 | "categories": [ # Install only patches with these categories. |
| 251 | # Common categories include security, recommended, and feature. |
| 252 | "A String", |
| 253 | ], |
| 254 | }, |
| 255 | }, |
| 256 | "lastExecuteTime": "A String", # Output only. The last time a patch job was started by this deployment. |
| 257 | # Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text |
| 258 | # format. |
| 259 | "instanceFilter": { # A filter to target VM instances for patching. The targeted # Required. VM instances to patch. |
| 260 | # VMs must meet all criteria specified. So if both labels and zones are |
| 261 | # specified, the patch job targets only VMs with those labels and in those |
| 262 | # zones. |
| 263 | "all": True or False, # Target all VM instances in the project. If true, no other criteria is |
| 264 | # permitted. |
| 265 | "zones": [ # Targets VM instances in ANY of these zones. Leave empty to target VM |
| 266 | # instances in any zone. |
| 267 | "A String", |
| 268 | ], |
| 269 | "instances": [ # Targets any of the VM instances specified. Instances are specified by their |
| 270 | # URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME]`, |
| 271 | # `projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`, or |
| 272 | # `https://www.googleapis.com/compute/v1/projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]` |
| 273 | "A String", |
| 274 | ], |
| 275 | "groupLabels": [ # Targets VM instances matching at least one of these label sets. This allows |
| 276 | # targeting of disparate groups, for example "env=prod or env=staging". |
| 277 | { # Represents a group of VMs that can be identified as having all these |
| 278 | # labels, for example "env=prod and app=web". |
| 279 | "labels": { # Compute Engine instance labels that must be present for a VM instance to |
| 280 | # be targeted by this filter. |
| 281 | "a_key": "A String", |
| 282 | }, |
| 283 | }, |
| 284 | ], |
| 285 | "instanceNamePrefixes": [ # Targets VMs whose name starts with one of these prefixes. Similar to |
| 286 | # labels, this is another way to group VMs when targeting configs, for |
| 287 | # example prefix="prod-". |
| 288 | "A String", |
| 289 | ], |
| 290 | }, |
| 291 | "duration": "A String", # Optional. Duration of the patch. After the duration ends, the patch times out. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 292 | "recurringSchedule": { # Sets the time for recurring patch deployments. # Required. Schedule recurring executions. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 293 | "endTime": "A String", # Optional. The end time at which a recurring patch deployment schedule is no longer |
| 294 | # active. |
| 295 | "timeZone": { # Represents a time zone from the # Required. Defines the time zone that `time_of_day` is relative to. |
| 296 | # The rules for daylight saving time are determined by the chosen time zone. |
| 297 | # [IANA Time Zone Database](https://www.iana.org/time-zones). |
| 298 | "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York". |
| 299 | "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a". |
| 300 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 301 | "frequency": "A String", # Required. The frequency unit of this recurring schedule. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 302 | "nextExecuteTime": "A String", # Output only. The time the next patch job is scheduled to run. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 303 | "weekly": { # Represents a weekly schedule. # Required. Schedule with weekly executions. |
| 304 | "dayOfWeek": "A String", # Required. Day of the week. |
| 305 | }, |
| 306 | "lastExecuteTime": "A String", # Output only. The time the last patch job ran successfully. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 307 | "monthly": { # Represents a monthly schedule. An example of a valid monthly schedule is # Required. Schedule with monthly executions. |
| 308 | # "on the third Tuesday of the month" or "on the 15th of the month". |
| 309 | "monthDay": 42, # Required. One day of the month. 1-31 indicates the 1st to the 31st day. -1 |
| 310 | # indicates the last day of the month. |
| 311 | # Months without the target day will be skipped. For example, a schedule to |
| 312 | # run "every month on the 31st" will not run in February, April, June, etc. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 313 | "weekDayOfMonth": { # Represents one week day in a month. An example is "the 4th Sunday". # Required. Week day in a month. |
| 314 | "dayOfWeek": "A String", # Required. A day of the week. |
| 315 | "weekOrdinal": 42, # Required. Week number in a month. 1-4 indicates the 1st to 4th week of the month. -1 |
| 316 | # indicates the last week of the month. |
| 317 | }, |
| 318 | }, |
| 319 | "startTime": "A String", # Optional. The time that the recurring schedule becomes effective. |
| 320 | # Defaults to `create_time` of the patch deployment. |
| 321 | "timeOfDay": { # Represents a time of day. The date and time zone are either not significant # Required. Time of the day to run a recurring deployment. |
| 322 | # or are specified elsewhere. An API may choose to allow leap seconds. Related |
| 323 | # types are google.type.Date and `google.protobuf.Timestamp`. |
| 324 | "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may |
| 325 | # allow the value 60 if it allows leap-seconds. |
| 326 | "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| 327 | "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. |
| 328 | "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose |
| 329 | # to allow the value "24:00:00" for scenarios like business closing time. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 330 | }, |
| 331 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 332 | "description": "A String", # Optional. Description of the patch deployment. Length of the description is limited |
| 333 | # to 1024 characters. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 334 | "oneTimeSchedule": { # Sets the time for a one time patch deployment. Timestamp is in # Required. Schedule a one-time execution. |
| 335 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 336 | "executeTime": "A String", # Required. The desired patch job execution time. |
| 337 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 338 | "name": "A String", # Unique name for the patch deployment resource in a project. The patch |
| 339 | # deployment name is in the form: |
| 340 | # `projects/{project_id}/patchDeployments/{patch_deployment_id}`. |
| 341 | # This field is ignored when you create a new patch deployment. |
| 342 | "createTime": "A String", # Output only. Time the patch deployment was created. Timestamp is in |
| 343 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 344 | "updateTime": "A String", # Output only. Time the patch deployment was last updated. Timestamp is in |
| 345 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 346 | "rollout": { # Patch rollout configuration specifications. Contains details on the # Optional. Rollout strategy of the patch job. |
| 347 | # concurrency control when applying patch(es) to all targeted VMs. |
| 348 | "disruptionBudget": { # Message encapsulating a value that can be either absolute ("fixed") or # The maximum number (or percentage) of VMs per zone to disrupt at any given |
| 349 | # moment. The number of VMs calculated from multiplying the percentage by the |
| 350 | # total number of VMs in a zone is rounded up. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 351 | # |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 352 | # During patching, a VM is considered disrupted from the time the agent is |
| 353 | # notified to begin until patching has completed. This disruption time |
| 354 | # includes the time to complete reboot and any post-patch steps. |
| 355 | # |
| 356 | # A VM contributes to the disruption budget if its patching operation fails |
| 357 | # either when applying the patches, running pre or post patch steps, or if it |
| 358 | # fails to respond with a success notification before timing out. VMs that |
| 359 | # are not running or do not have an active agent do not count toward this |
| 360 | # disruption budget. |
| 361 | # |
| 362 | # For zone-by-zone rollouts, if the disruption budget in a zone is exceeded, |
| 363 | # the patch job stops, because continuing to the next zone requires |
| 364 | # completion of the patch process in the previous zone. |
| 365 | # |
| 366 | # For example, if the disruption budget has a fixed value of `10`, and 8 VMs |
| 367 | # fail to patch in the current zone, the patch job continues to patch 2 VMs |
| 368 | # at a time until the zone is completed. When that zone is completed |
| 369 | # successfully, patching begins with 10 VMs at a time in the next zone. If 10 |
| 370 | # VMs in the next zone fail to patch, the patch job stops. |
| 371 | # relative ("percent") to a value. |
| 372 | "percent": 42, # Specifies the relative value defined as a percentage, which will be |
| 373 | # multiplied by a reference value. |
| 374 | "fixed": 42, # Specifies a fixed value. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 375 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 376 | "mode": "A String", # Mode of the patch rollout. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 377 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 378 | } |
| 379 | |
| 380 | patchDeploymentId: string, Required. A name for the patch deployment in the project. When creating a name |
| 381 | the following rules apply: |
| 382 | * Must contain only lowercase letters, numbers, and hyphens. |
| 383 | * Must start with a letter. |
| 384 | * Must be between 1-63 characters. |
| 385 | * Must end with a number or a letter. |
| 386 | * Must be unique within the project. |
| 387 | x__xgafv: string, V1 error format. |
| 388 | Allowed values |
| 389 | 1 - v1 error format |
| 390 | 2 - v2 error format |
| 391 | |
| 392 | Returns: |
| 393 | An object of the form: |
| 394 | |
| 395 | { # Patch deployments are configurations that individual patch jobs use to |
| 396 | # complete a patch. These configurations include instance filter, package |
| 397 | # repository settings, and a schedule. For more information about creating and |
| 398 | # managing patch deployments, see [Scheduling patch |
| 399 | # jobs](https://cloud.google.com/compute/docs/os-patch-management/schedule-patch-jobs). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 400 | "patchConfig": { # Patch configuration specifications. Contains details on how to apply the # Optional. Patch configuration that is applied. |
| 401 | # patch(es) to a VM instance. |
| 402 | "yum": { # Yum patching is performed by executing `yum update`. Additional options # Yum update settings. Use this setting to override the default `yum` patch |
| 403 | # rules. |
| 404 | # can be set to control how this is executed. |
| 405 | # |
| 406 | # Note that not all settings are supported on all platforms. |
| 407 | "excludes": [ # List of packages to exclude from update. These packages are excluded by |
| 408 | # using the yum `--exclude` flag. |
| 409 | "A String", |
| 410 | ], |
| 411 | "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages |
| 412 | # that will be updated. If these packages are not installed, they will be |
| 413 | # ignored. This field must not be specified with any other patch |
| 414 | # configuration fields. |
| 415 | "A String", |
| 416 | ], |
| 417 | "minimal": True or False, # Will cause patch to run `yum update-minimal` instead. |
| 418 | "security": True or False, # Adds the `--security` flag to `yum update`. Not supported on |
| 419 | # all platforms. |
| 420 | }, |
| 421 | "postStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run after the patch update. |
| 422 | "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob. |
| 423 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is |
| 424 | # specified the script will be executed directly, which will likely |
| 425 | # only succeed for scripts with [shebang lines] |
| 426 | # (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| 427 | "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. |
| 428 | "object": "A String", # Required. Name of the Google Cloud Storage object. |
| 429 | "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. |
| 430 | "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to |
| 431 | # ensure that the ExecStep specified by this PatchJob does not change. |
| 432 | }, |
| 433 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the |
| 434 | # execution can return to indicate a success. |
| 435 | 42, |
| 436 | ], |
| 437 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 438 | }, |
| 439 | "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob. |
| 440 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is |
| 441 | # specified the script will be executed directly, which will likely |
| 442 | # only succeed for scripts with [shebang lines] |
| 443 | # (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| 444 | "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. |
| 445 | "object": "A String", # Required. Name of the Google Cloud Storage object. |
| 446 | "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. |
| 447 | "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to |
| 448 | # ensure that the ExecStep specified by this PatchJob does not change. |
| 449 | }, |
| 450 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the |
| 451 | # execution can return to indicate a success. |
| 452 | 42, |
| 453 | ], |
| 454 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 455 | }, |
| 456 | }, |
| 457 | "goo": { # Googet patching is performed by running `googet update`. # Goo update settings. Use this setting to override the default `goo` patch |
| 458 | # rules. |
| 459 | }, |
| 460 | "rebootConfig": "A String", # Post-patch reboot settings. |
| 461 | "apt": { # Apt patching is completed by executing `apt-get update && apt-get # Apt update settings. Use this setting to override the default `apt` patch |
| 462 | # rules. |
| 463 | # upgrade`. Additional options can be set to control how this is executed. |
| 464 | "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages |
| 465 | # that will be updated. If these packages are not installed, they will be |
| 466 | # ignored. This field cannot be specified with any other patch configuration |
| 467 | # fields. |
| 468 | "A String", |
| 469 | ], |
| 470 | "type": "A String", # By changing the type to DIST, the patching is performed |
| 471 | # using `apt-get dist-upgrade` instead. |
| 472 | "excludes": [ # List of packages to exclude from update. These packages will be excluded |
| 473 | "A String", |
| 474 | ], |
| 475 | }, |
| 476 | "windowsUpdate": { # Windows patching is performed using the Windows Update Agent. # Windows update settings. Use this override the default windows patch rules. |
| 477 | "exclusivePatches": [ # An exclusive list of kbs to be updated. These are the only patches |
| 478 | # that will be updated. This field must not be used with other |
| 479 | # patch configurations. |
| 480 | "A String", |
| 481 | ], |
| 482 | "excludes": [ # List of KBs to exclude from update. |
| 483 | "A String", |
| 484 | ], |
| 485 | "classifications": [ # Only apply updates of these windows update classifications. If empty, all |
| 486 | # updates are applied. |
| 487 | "A String", |
| 488 | ], |
| 489 | }, |
| 490 | "preStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run before the patch update. |
| 491 | "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob. |
| 492 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is |
| 493 | # specified the script will be executed directly, which will likely |
| 494 | # only succeed for scripts with [shebang lines] |
| 495 | # (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| 496 | "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. |
| 497 | "object": "A String", # Required. Name of the Google Cloud Storage object. |
| 498 | "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. |
| 499 | "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to |
| 500 | # ensure that the ExecStep specified by this PatchJob does not change. |
| 501 | }, |
| 502 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the |
| 503 | # execution can return to indicate a success. |
| 504 | 42, |
| 505 | ], |
| 506 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 507 | }, |
| 508 | "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob. |
| 509 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is |
| 510 | # specified the script will be executed directly, which will likely |
| 511 | # only succeed for scripts with [shebang lines] |
| 512 | # (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| 513 | "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. |
| 514 | "object": "A String", # Required. Name of the Google Cloud Storage object. |
| 515 | "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. |
| 516 | "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to |
| 517 | # ensure that the ExecStep specified by this PatchJob does not change. |
| 518 | }, |
| 519 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the |
| 520 | # execution can return to indicate a success. |
| 521 | 42, |
| 522 | ], |
| 523 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 524 | }, |
| 525 | }, |
| 526 | "zypper": { # Zypper patching is performed by running `zypper patch`. # Zypper update settings. Use this setting to override the default `zypper` |
| 527 | # patch rules. |
| 528 | # See also https://en.opensuse.org/SDB:Zypper_manual. |
| 529 | "exclusivePatches": [ # An exclusive list of patches to be updated. These are the only patches |
| 530 | # that will be installed using 'zypper patch patch:<patch_name>' command. |
| 531 | # This field must not be used with any other patch configuration fields. |
| 532 | "A String", |
| 533 | ], |
| 534 | "withUpdate": True or False, # Adds the `--with-update` flag, to `zypper patch`. |
| 535 | "excludes": [ # List of patches to exclude from update. |
| 536 | "A String", |
| 537 | ], |
| 538 | "severities": [ # Install only patches with these severities. |
| 539 | # Common severities include critical, important, moderate, and low. |
| 540 | "A String", |
| 541 | ], |
| 542 | "withOptional": True or False, # Adds the `--with-optional` flag to `zypper patch`. |
| 543 | "categories": [ # Install only patches with these categories. |
| 544 | # Common categories include security, recommended, and feature. |
| 545 | "A String", |
| 546 | ], |
| 547 | }, |
| 548 | }, |
| 549 | "lastExecuteTime": "A String", # Output only. The last time a patch job was started by this deployment. |
| 550 | # Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text |
| 551 | # format. |
| 552 | "instanceFilter": { # A filter to target VM instances for patching. The targeted # Required. VM instances to patch. |
| 553 | # VMs must meet all criteria specified. So if both labels and zones are |
| 554 | # specified, the patch job targets only VMs with those labels and in those |
| 555 | # zones. |
| 556 | "all": True or False, # Target all VM instances in the project. If true, no other criteria is |
| 557 | # permitted. |
| 558 | "zones": [ # Targets VM instances in ANY of these zones. Leave empty to target VM |
| 559 | # instances in any zone. |
| 560 | "A String", |
| 561 | ], |
| 562 | "instances": [ # Targets any of the VM instances specified. Instances are specified by their |
| 563 | # URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME]`, |
| 564 | # `projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`, or |
| 565 | # `https://www.googleapis.com/compute/v1/projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]` |
| 566 | "A String", |
| 567 | ], |
| 568 | "groupLabels": [ # Targets VM instances matching at least one of these label sets. This allows |
| 569 | # targeting of disparate groups, for example "env=prod or env=staging". |
| 570 | { # Represents a group of VMs that can be identified as having all these |
| 571 | # labels, for example "env=prod and app=web". |
| 572 | "labels": { # Compute Engine instance labels that must be present for a VM instance to |
| 573 | # be targeted by this filter. |
| 574 | "a_key": "A String", |
| 575 | }, |
| 576 | }, |
| 577 | ], |
| 578 | "instanceNamePrefixes": [ # Targets VMs whose name starts with one of these prefixes. Similar to |
| 579 | # labels, this is another way to group VMs when targeting configs, for |
| 580 | # example prefix="prod-". |
| 581 | "A String", |
| 582 | ], |
| 583 | }, |
| 584 | "duration": "A String", # Optional. Duration of the patch. After the duration ends, the patch times out. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 585 | "recurringSchedule": { # Sets the time for recurring patch deployments. # Required. Schedule recurring executions. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 586 | "endTime": "A String", # Optional. The end time at which a recurring patch deployment schedule is no longer |
| 587 | # active. |
| 588 | "timeZone": { # Represents a time zone from the # Required. Defines the time zone that `time_of_day` is relative to. |
| 589 | # The rules for daylight saving time are determined by the chosen time zone. |
| 590 | # [IANA Time Zone Database](https://www.iana.org/time-zones). |
| 591 | "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York". |
| 592 | "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a". |
| 593 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 594 | "frequency": "A String", # Required. The frequency unit of this recurring schedule. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 595 | "nextExecuteTime": "A String", # Output only. The time the next patch job is scheduled to run. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 596 | "weekly": { # Represents a weekly schedule. # Required. Schedule with weekly executions. |
| 597 | "dayOfWeek": "A String", # Required. Day of the week. |
| 598 | }, |
| 599 | "lastExecuteTime": "A String", # Output only. The time the last patch job ran successfully. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 600 | "monthly": { # Represents a monthly schedule. An example of a valid monthly schedule is # Required. Schedule with monthly executions. |
| 601 | # "on the third Tuesday of the month" or "on the 15th of the month". |
| 602 | "monthDay": 42, # Required. One day of the month. 1-31 indicates the 1st to the 31st day. -1 |
| 603 | # indicates the last day of the month. |
| 604 | # Months without the target day will be skipped. For example, a schedule to |
| 605 | # run "every month on the 31st" will not run in February, April, June, etc. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 606 | "weekDayOfMonth": { # Represents one week day in a month. An example is "the 4th Sunday". # Required. Week day in a month. |
| 607 | "dayOfWeek": "A String", # Required. A day of the week. |
| 608 | "weekOrdinal": 42, # Required. Week number in a month. 1-4 indicates the 1st to 4th week of the month. -1 |
| 609 | # indicates the last week of the month. |
| 610 | }, |
| 611 | }, |
| 612 | "startTime": "A String", # Optional. The time that the recurring schedule becomes effective. |
| 613 | # Defaults to `create_time` of the patch deployment. |
| 614 | "timeOfDay": { # Represents a time of day. The date and time zone are either not significant # Required. Time of the day to run a recurring deployment. |
| 615 | # or are specified elsewhere. An API may choose to allow leap seconds. Related |
| 616 | # types are google.type.Date and `google.protobuf.Timestamp`. |
| 617 | "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may |
| 618 | # allow the value 60 if it allows leap-seconds. |
| 619 | "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| 620 | "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. |
| 621 | "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose |
| 622 | # to allow the value "24:00:00" for scenarios like business closing time. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 623 | }, |
| 624 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 625 | "description": "A String", # Optional. Description of the patch deployment. Length of the description is limited |
| 626 | # to 1024 characters. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 627 | "oneTimeSchedule": { # Sets the time for a one time patch deployment. Timestamp is in # Required. Schedule a one-time execution. |
| 628 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 629 | "executeTime": "A String", # Required. The desired patch job execution time. |
| 630 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 631 | "name": "A String", # Unique name for the patch deployment resource in a project. The patch |
| 632 | # deployment name is in the form: |
| 633 | # `projects/{project_id}/patchDeployments/{patch_deployment_id}`. |
| 634 | # This field is ignored when you create a new patch deployment. |
| 635 | "createTime": "A String", # Output only. Time the patch deployment was created. Timestamp is in |
| 636 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 637 | "updateTime": "A String", # Output only. Time the patch deployment was last updated. Timestamp is in |
| 638 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 639 | "rollout": { # Patch rollout configuration specifications. Contains details on the # Optional. Rollout strategy of the patch job. |
| 640 | # concurrency control when applying patch(es) to all targeted VMs. |
| 641 | "disruptionBudget": { # Message encapsulating a value that can be either absolute ("fixed") or # The maximum number (or percentage) of VMs per zone to disrupt at any given |
| 642 | # moment. The number of VMs calculated from multiplying the percentage by the |
| 643 | # total number of VMs in a zone is rounded up. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 644 | # |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 645 | # During patching, a VM is considered disrupted from the time the agent is |
| 646 | # notified to begin until patching has completed. This disruption time |
| 647 | # includes the time to complete reboot and any post-patch steps. |
| 648 | # |
| 649 | # A VM contributes to the disruption budget if its patching operation fails |
| 650 | # either when applying the patches, running pre or post patch steps, or if it |
| 651 | # fails to respond with a success notification before timing out. VMs that |
| 652 | # are not running or do not have an active agent do not count toward this |
| 653 | # disruption budget. |
| 654 | # |
| 655 | # For zone-by-zone rollouts, if the disruption budget in a zone is exceeded, |
| 656 | # the patch job stops, because continuing to the next zone requires |
| 657 | # completion of the patch process in the previous zone. |
| 658 | # |
| 659 | # For example, if the disruption budget has a fixed value of `10`, and 8 VMs |
| 660 | # fail to patch in the current zone, the patch job continues to patch 2 VMs |
| 661 | # at a time until the zone is completed. When that zone is completed |
| 662 | # successfully, patching begins with 10 VMs at a time in the next zone. If 10 |
| 663 | # VMs in the next zone fail to patch, the patch job stops. |
| 664 | # relative ("percent") to a value. |
| 665 | "percent": 42, # Specifies the relative value defined as a percentage, which will be |
| 666 | # multiplied by a reference value. |
| 667 | "fixed": 42, # Specifies a fixed value. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 668 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 669 | "mode": "A String", # Mode of the patch rollout. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 670 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 671 | }</pre> |
| 672 | </div> |
| 673 | |
| 674 | <div class="method"> |
| 675 | <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| 676 | <pre>Delete an OS Config patch deployment. |
| 677 | |
| 678 | Args: |
| 679 | name: string, Required. The resource name of the patch deployment in the form |
| 680 | `projects/*/patchDeployments/*`. (required) |
| 681 | x__xgafv: string, V1 error format. |
| 682 | Allowed values |
| 683 | 1 - v1 error format |
| 684 | 2 - v2 error format |
| 685 | |
| 686 | Returns: |
| 687 | An object of the form: |
| 688 | |
| 689 | { # A generic empty message that you can re-use to avoid defining duplicated |
| 690 | # empty messages in your APIs. A typical example is to use it as the request |
| 691 | # or the response type of an API method. For instance: |
| 692 | # |
| 693 | # service Foo { |
| 694 | # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); |
| 695 | # } |
| 696 | # |
| 697 | # The JSON representation for `Empty` is empty JSON object `{}`. |
| 698 | }</pre> |
| 699 | </div> |
| 700 | |
| 701 | <div class="method"> |
| 702 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 703 | <pre>Get an OS Config patch deployment. |
| 704 | |
| 705 | Args: |
| 706 | name: string, Required. The resource name of the patch deployment in the form |
| 707 | `projects/*/patchDeployments/*`. (required) |
| 708 | x__xgafv: string, V1 error format. |
| 709 | Allowed values |
| 710 | 1 - v1 error format |
| 711 | 2 - v2 error format |
| 712 | |
| 713 | Returns: |
| 714 | An object of the form: |
| 715 | |
| 716 | { # Patch deployments are configurations that individual patch jobs use to |
| 717 | # complete a patch. These configurations include instance filter, package |
| 718 | # repository settings, and a schedule. For more information about creating and |
| 719 | # managing patch deployments, see [Scheduling patch |
| 720 | # jobs](https://cloud.google.com/compute/docs/os-patch-management/schedule-patch-jobs). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 721 | "patchConfig": { # Patch configuration specifications. Contains details on how to apply the # Optional. Patch configuration that is applied. |
| 722 | # patch(es) to a VM instance. |
| 723 | "yum": { # Yum patching is performed by executing `yum update`. Additional options # Yum update settings. Use this setting to override the default `yum` patch |
| 724 | # rules. |
| 725 | # can be set to control how this is executed. |
| 726 | # |
| 727 | # Note that not all settings are supported on all platforms. |
| 728 | "excludes": [ # List of packages to exclude from update. These packages are excluded by |
| 729 | # using the yum `--exclude` flag. |
| 730 | "A String", |
| 731 | ], |
| 732 | "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages |
| 733 | # that will be updated. If these packages are not installed, they will be |
| 734 | # ignored. This field must not be specified with any other patch |
| 735 | # configuration fields. |
| 736 | "A String", |
| 737 | ], |
| 738 | "minimal": True or False, # Will cause patch to run `yum update-minimal` instead. |
| 739 | "security": True or False, # Adds the `--security` flag to `yum update`. Not supported on |
| 740 | # all platforms. |
| 741 | }, |
| 742 | "postStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run after the patch update. |
| 743 | "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob. |
| 744 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is |
| 745 | # specified the script will be executed directly, which will likely |
| 746 | # only succeed for scripts with [shebang lines] |
| 747 | # (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| 748 | "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. |
| 749 | "object": "A String", # Required. Name of the Google Cloud Storage object. |
| 750 | "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. |
| 751 | "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to |
| 752 | # ensure that the ExecStep specified by this PatchJob does not change. |
| 753 | }, |
| 754 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the |
| 755 | # execution can return to indicate a success. |
| 756 | 42, |
| 757 | ], |
| 758 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 759 | }, |
| 760 | "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob. |
| 761 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is |
| 762 | # specified the script will be executed directly, which will likely |
| 763 | # only succeed for scripts with [shebang lines] |
| 764 | # (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| 765 | "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. |
| 766 | "object": "A String", # Required. Name of the Google Cloud Storage object. |
| 767 | "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. |
| 768 | "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to |
| 769 | # ensure that the ExecStep specified by this PatchJob does not change. |
| 770 | }, |
| 771 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the |
| 772 | # execution can return to indicate a success. |
| 773 | 42, |
| 774 | ], |
| 775 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 776 | }, |
| 777 | }, |
| 778 | "goo": { # Googet patching is performed by running `googet update`. # Goo update settings. Use this setting to override the default `goo` patch |
| 779 | # rules. |
| 780 | }, |
| 781 | "rebootConfig": "A String", # Post-patch reboot settings. |
| 782 | "apt": { # Apt patching is completed by executing `apt-get update && apt-get # Apt update settings. Use this setting to override the default `apt` patch |
| 783 | # rules. |
| 784 | # upgrade`. Additional options can be set to control how this is executed. |
| 785 | "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages |
| 786 | # that will be updated. If these packages are not installed, they will be |
| 787 | # ignored. This field cannot be specified with any other patch configuration |
| 788 | # fields. |
| 789 | "A String", |
| 790 | ], |
| 791 | "type": "A String", # By changing the type to DIST, the patching is performed |
| 792 | # using `apt-get dist-upgrade` instead. |
| 793 | "excludes": [ # List of packages to exclude from update. These packages will be excluded |
| 794 | "A String", |
| 795 | ], |
| 796 | }, |
| 797 | "windowsUpdate": { # Windows patching is performed using the Windows Update Agent. # Windows update settings. Use this override the default windows patch rules. |
| 798 | "exclusivePatches": [ # An exclusive list of kbs to be updated. These are the only patches |
| 799 | # that will be updated. This field must not be used with other |
| 800 | # patch configurations. |
| 801 | "A String", |
| 802 | ], |
| 803 | "excludes": [ # List of KBs to exclude from update. |
| 804 | "A String", |
| 805 | ], |
| 806 | "classifications": [ # Only apply updates of these windows update classifications. If empty, all |
| 807 | # updates are applied. |
| 808 | "A String", |
| 809 | ], |
| 810 | }, |
| 811 | "preStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run before the patch update. |
| 812 | "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob. |
| 813 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is |
| 814 | # specified the script will be executed directly, which will likely |
| 815 | # only succeed for scripts with [shebang lines] |
| 816 | # (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| 817 | "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. |
| 818 | "object": "A String", # Required. Name of the Google Cloud Storage object. |
| 819 | "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. |
| 820 | "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to |
| 821 | # ensure that the ExecStep specified by this PatchJob does not change. |
| 822 | }, |
| 823 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the |
| 824 | # execution can return to indicate a success. |
| 825 | 42, |
| 826 | ], |
| 827 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 828 | }, |
| 829 | "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob. |
| 830 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is |
| 831 | # specified the script will be executed directly, which will likely |
| 832 | # only succeed for scripts with [shebang lines] |
| 833 | # (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| 834 | "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. |
| 835 | "object": "A String", # Required. Name of the Google Cloud Storage object. |
| 836 | "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. |
| 837 | "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to |
| 838 | # ensure that the ExecStep specified by this PatchJob does not change. |
| 839 | }, |
| 840 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the |
| 841 | # execution can return to indicate a success. |
| 842 | 42, |
| 843 | ], |
| 844 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 845 | }, |
| 846 | }, |
| 847 | "zypper": { # Zypper patching is performed by running `zypper patch`. # Zypper update settings. Use this setting to override the default `zypper` |
| 848 | # patch rules. |
| 849 | # See also https://en.opensuse.org/SDB:Zypper_manual. |
| 850 | "exclusivePatches": [ # An exclusive list of patches to be updated. These are the only patches |
| 851 | # that will be installed using 'zypper patch patch:<patch_name>' command. |
| 852 | # This field must not be used with any other patch configuration fields. |
| 853 | "A String", |
| 854 | ], |
| 855 | "withUpdate": True or False, # Adds the `--with-update` flag, to `zypper patch`. |
| 856 | "excludes": [ # List of patches to exclude from update. |
| 857 | "A String", |
| 858 | ], |
| 859 | "severities": [ # Install only patches with these severities. |
| 860 | # Common severities include critical, important, moderate, and low. |
| 861 | "A String", |
| 862 | ], |
| 863 | "withOptional": True or False, # Adds the `--with-optional` flag to `zypper patch`. |
| 864 | "categories": [ # Install only patches with these categories. |
| 865 | # Common categories include security, recommended, and feature. |
| 866 | "A String", |
| 867 | ], |
| 868 | }, |
| 869 | }, |
| 870 | "lastExecuteTime": "A String", # Output only. The last time a patch job was started by this deployment. |
| 871 | # Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text |
| 872 | # format. |
| 873 | "instanceFilter": { # A filter to target VM instances for patching. The targeted # Required. VM instances to patch. |
| 874 | # VMs must meet all criteria specified. So if both labels and zones are |
| 875 | # specified, the patch job targets only VMs with those labels and in those |
| 876 | # zones. |
| 877 | "all": True or False, # Target all VM instances in the project. If true, no other criteria is |
| 878 | # permitted. |
| 879 | "zones": [ # Targets VM instances in ANY of these zones. Leave empty to target VM |
| 880 | # instances in any zone. |
| 881 | "A String", |
| 882 | ], |
| 883 | "instances": [ # Targets any of the VM instances specified. Instances are specified by their |
| 884 | # URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME]`, |
| 885 | # `projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`, or |
| 886 | # `https://www.googleapis.com/compute/v1/projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]` |
| 887 | "A String", |
| 888 | ], |
| 889 | "groupLabels": [ # Targets VM instances matching at least one of these label sets. This allows |
| 890 | # targeting of disparate groups, for example "env=prod or env=staging". |
| 891 | { # Represents a group of VMs that can be identified as having all these |
| 892 | # labels, for example "env=prod and app=web". |
| 893 | "labels": { # Compute Engine instance labels that must be present for a VM instance to |
| 894 | # be targeted by this filter. |
| 895 | "a_key": "A String", |
| 896 | }, |
| 897 | }, |
| 898 | ], |
| 899 | "instanceNamePrefixes": [ # Targets VMs whose name starts with one of these prefixes. Similar to |
| 900 | # labels, this is another way to group VMs when targeting configs, for |
| 901 | # example prefix="prod-". |
| 902 | "A String", |
| 903 | ], |
| 904 | }, |
| 905 | "duration": "A String", # Optional. Duration of the patch. After the duration ends, the patch times out. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 906 | "recurringSchedule": { # Sets the time for recurring patch deployments. # Required. Schedule recurring executions. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 907 | "endTime": "A String", # Optional. The end time at which a recurring patch deployment schedule is no longer |
| 908 | # active. |
| 909 | "timeZone": { # Represents a time zone from the # Required. Defines the time zone that `time_of_day` is relative to. |
| 910 | # The rules for daylight saving time are determined by the chosen time zone. |
| 911 | # [IANA Time Zone Database](https://www.iana.org/time-zones). |
| 912 | "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York". |
| 913 | "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a". |
| 914 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 915 | "frequency": "A String", # Required. The frequency unit of this recurring schedule. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 916 | "nextExecuteTime": "A String", # Output only. The time the next patch job is scheduled to run. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 917 | "weekly": { # Represents a weekly schedule. # Required. Schedule with weekly executions. |
| 918 | "dayOfWeek": "A String", # Required. Day of the week. |
| 919 | }, |
| 920 | "lastExecuteTime": "A String", # Output only. The time the last patch job ran successfully. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 921 | "monthly": { # Represents a monthly schedule. An example of a valid monthly schedule is # Required. Schedule with monthly executions. |
| 922 | # "on the third Tuesday of the month" or "on the 15th of the month". |
| 923 | "monthDay": 42, # Required. One day of the month. 1-31 indicates the 1st to the 31st day. -1 |
| 924 | # indicates the last day of the month. |
| 925 | # Months without the target day will be skipped. For example, a schedule to |
| 926 | # run "every month on the 31st" will not run in February, April, June, etc. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 927 | "weekDayOfMonth": { # Represents one week day in a month. An example is "the 4th Sunday". # Required. Week day in a month. |
| 928 | "dayOfWeek": "A String", # Required. A day of the week. |
| 929 | "weekOrdinal": 42, # Required. Week number in a month. 1-4 indicates the 1st to 4th week of the month. -1 |
| 930 | # indicates the last week of the month. |
| 931 | }, |
| 932 | }, |
| 933 | "startTime": "A String", # Optional. The time that the recurring schedule becomes effective. |
| 934 | # Defaults to `create_time` of the patch deployment. |
| 935 | "timeOfDay": { # Represents a time of day. The date and time zone are either not significant # Required. Time of the day to run a recurring deployment. |
| 936 | # or are specified elsewhere. An API may choose to allow leap seconds. Related |
| 937 | # types are google.type.Date and `google.protobuf.Timestamp`. |
| 938 | "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may |
| 939 | # allow the value 60 if it allows leap-seconds. |
| 940 | "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| 941 | "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. |
| 942 | "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose |
| 943 | # to allow the value "24:00:00" for scenarios like business closing time. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 944 | }, |
| 945 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 946 | "description": "A String", # Optional. Description of the patch deployment. Length of the description is limited |
| 947 | # to 1024 characters. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 948 | "oneTimeSchedule": { # Sets the time for a one time patch deployment. Timestamp is in # Required. Schedule a one-time execution. |
| 949 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 950 | "executeTime": "A String", # Required. The desired patch job execution time. |
| 951 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 952 | "name": "A String", # Unique name for the patch deployment resource in a project. The patch |
| 953 | # deployment name is in the form: |
| 954 | # `projects/{project_id}/patchDeployments/{patch_deployment_id}`. |
| 955 | # This field is ignored when you create a new patch deployment. |
| 956 | "createTime": "A String", # Output only. Time the patch deployment was created. Timestamp is in |
| 957 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 958 | "updateTime": "A String", # Output only. Time the patch deployment was last updated. Timestamp is in |
| 959 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 960 | "rollout": { # Patch rollout configuration specifications. Contains details on the # Optional. Rollout strategy of the patch job. |
| 961 | # concurrency control when applying patch(es) to all targeted VMs. |
| 962 | "disruptionBudget": { # Message encapsulating a value that can be either absolute ("fixed") or # The maximum number (or percentage) of VMs per zone to disrupt at any given |
| 963 | # moment. The number of VMs calculated from multiplying the percentage by the |
| 964 | # total number of VMs in a zone is rounded up. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 965 | # |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 966 | # During patching, a VM is considered disrupted from the time the agent is |
| 967 | # notified to begin until patching has completed. This disruption time |
| 968 | # includes the time to complete reboot and any post-patch steps. |
| 969 | # |
| 970 | # A VM contributes to the disruption budget if its patching operation fails |
| 971 | # either when applying the patches, running pre or post patch steps, or if it |
| 972 | # fails to respond with a success notification before timing out. VMs that |
| 973 | # are not running or do not have an active agent do not count toward this |
| 974 | # disruption budget. |
| 975 | # |
| 976 | # For zone-by-zone rollouts, if the disruption budget in a zone is exceeded, |
| 977 | # the patch job stops, because continuing to the next zone requires |
| 978 | # completion of the patch process in the previous zone. |
| 979 | # |
| 980 | # For example, if the disruption budget has a fixed value of `10`, and 8 VMs |
| 981 | # fail to patch in the current zone, the patch job continues to patch 2 VMs |
| 982 | # at a time until the zone is completed. When that zone is completed |
| 983 | # successfully, patching begins with 10 VMs at a time in the next zone. If 10 |
| 984 | # VMs in the next zone fail to patch, the patch job stops. |
| 985 | # relative ("percent") to a value. |
| 986 | "percent": 42, # Specifies the relative value defined as a percentage, which will be |
| 987 | # multiplied by a reference value. |
| 988 | "fixed": 42, # Specifies a fixed value. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 989 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 990 | "mode": "A String", # Mode of the patch rollout. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 991 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 992 | }</pre> |
| 993 | </div> |
| 994 | |
| 995 | <div class="method"> |
| 996 | <code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code> |
| 997 | <pre>Get a page of OS Config patch deployments. |
| 998 | |
| 999 | Args: |
| 1000 | parent: string, Required. The resource name of the parent in the form `projects/*`. (required) |
| 1001 | pageToken: string, Optional. A pagination token returned from a previous call to ListPatchDeployments |
| 1002 | that indicates where this listing should continue from. |
| 1003 | pageSize: integer, Optional. The maximum number of patch deployments to return. Default is 100. |
| 1004 | x__xgafv: string, V1 error format. |
| 1005 | Allowed values |
| 1006 | 1 - v1 error format |
| 1007 | 2 - v2 error format |
| 1008 | |
| 1009 | Returns: |
| 1010 | An object of the form: |
| 1011 | |
| 1012 | { # A response message for listing patch deployments. |
| 1013 | "nextPageToken": "A String", # A pagination token that can be used to get the next page of patch |
| 1014 | # deployments. |
| 1015 | "patchDeployments": [ # The list of patch deployments. |
| 1016 | { # Patch deployments are configurations that individual patch jobs use to |
| 1017 | # complete a patch. These configurations include instance filter, package |
| 1018 | # repository settings, and a schedule. For more information about creating and |
| 1019 | # managing patch deployments, see [Scheduling patch |
| 1020 | # jobs](https://cloud.google.com/compute/docs/os-patch-management/schedule-patch-jobs). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1021 | "patchConfig": { # Patch configuration specifications. Contains details on how to apply the # Optional. Patch configuration that is applied. |
| 1022 | # patch(es) to a VM instance. |
| 1023 | "yum": { # Yum patching is performed by executing `yum update`. Additional options # Yum update settings. Use this setting to override the default `yum` patch |
| 1024 | # rules. |
| 1025 | # can be set to control how this is executed. |
| 1026 | # |
| 1027 | # Note that not all settings are supported on all platforms. |
| 1028 | "excludes": [ # List of packages to exclude from update. These packages are excluded by |
| 1029 | # using the yum `--exclude` flag. |
| 1030 | "A String", |
| 1031 | ], |
| 1032 | "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages |
| 1033 | # that will be updated. If these packages are not installed, they will be |
| 1034 | # ignored. This field must not be specified with any other patch |
| 1035 | # configuration fields. |
| 1036 | "A String", |
| 1037 | ], |
| 1038 | "minimal": True or False, # Will cause patch to run `yum update-minimal` instead. |
| 1039 | "security": True or False, # Adds the `--security` flag to `yum update`. Not supported on |
| 1040 | # all platforms. |
| 1041 | }, |
| 1042 | "postStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run after the patch update. |
| 1043 | "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob. |
| 1044 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is |
| 1045 | # specified the script will be executed directly, which will likely |
| 1046 | # only succeed for scripts with [shebang lines] |
| 1047 | # (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| 1048 | "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. |
| 1049 | "object": "A String", # Required. Name of the Google Cloud Storage object. |
| 1050 | "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. |
| 1051 | "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to |
| 1052 | # ensure that the ExecStep specified by this PatchJob does not change. |
| 1053 | }, |
| 1054 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the |
| 1055 | # execution can return to indicate a success. |
| 1056 | 42, |
| 1057 | ], |
| 1058 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 1059 | }, |
| 1060 | "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob. |
| 1061 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is |
| 1062 | # specified the script will be executed directly, which will likely |
| 1063 | # only succeed for scripts with [shebang lines] |
| 1064 | # (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| 1065 | "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. |
| 1066 | "object": "A String", # Required. Name of the Google Cloud Storage object. |
| 1067 | "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. |
| 1068 | "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to |
| 1069 | # ensure that the ExecStep specified by this PatchJob does not change. |
| 1070 | }, |
| 1071 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the |
| 1072 | # execution can return to indicate a success. |
| 1073 | 42, |
| 1074 | ], |
| 1075 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 1076 | }, |
| 1077 | }, |
| 1078 | "goo": { # Googet patching is performed by running `googet update`. # Goo update settings. Use this setting to override the default `goo` patch |
| 1079 | # rules. |
| 1080 | }, |
| 1081 | "rebootConfig": "A String", # Post-patch reboot settings. |
| 1082 | "apt": { # Apt patching is completed by executing `apt-get update && apt-get # Apt update settings. Use this setting to override the default `apt` patch |
| 1083 | # rules. |
| 1084 | # upgrade`. Additional options can be set to control how this is executed. |
| 1085 | "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages |
| 1086 | # that will be updated. If these packages are not installed, they will be |
| 1087 | # ignored. This field cannot be specified with any other patch configuration |
| 1088 | # fields. |
| 1089 | "A String", |
| 1090 | ], |
| 1091 | "type": "A String", # By changing the type to DIST, the patching is performed |
| 1092 | # using `apt-get dist-upgrade` instead. |
| 1093 | "excludes": [ # List of packages to exclude from update. These packages will be excluded |
| 1094 | "A String", |
| 1095 | ], |
| 1096 | }, |
| 1097 | "windowsUpdate": { # Windows patching is performed using the Windows Update Agent. # Windows update settings. Use this override the default windows patch rules. |
| 1098 | "exclusivePatches": [ # An exclusive list of kbs to be updated. These are the only patches |
| 1099 | # that will be updated. This field must not be used with other |
| 1100 | # patch configurations. |
| 1101 | "A String", |
| 1102 | ], |
| 1103 | "excludes": [ # List of KBs to exclude from update. |
| 1104 | "A String", |
| 1105 | ], |
| 1106 | "classifications": [ # Only apply updates of these windows update classifications. If empty, all |
| 1107 | # updates are applied. |
| 1108 | "A String", |
| 1109 | ], |
| 1110 | }, |
| 1111 | "preStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run before the patch update. |
| 1112 | "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob. |
| 1113 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is |
| 1114 | # specified the script will be executed directly, which will likely |
| 1115 | # only succeed for scripts with [shebang lines] |
| 1116 | # (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| 1117 | "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. |
| 1118 | "object": "A String", # Required. Name of the Google Cloud Storage object. |
| 1119 | "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. |
| 1120 | "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to |
| 1121 | # ensure that the ExecStep specified by this PatchJob does not change. |
| 1122 | }, |
| 1123 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the |
| 1124 | # execution can return to indicate a success. |
| 1125 | 42, |
| 1126 | ], |
| 1127 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 1128 | }, |
| 1129 | "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob. |
| 1130 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is |
| 1131 | # specified the script will be executed directly, which will likely |
| 1132 | # only succeed for scripts with [shebang lines] |
| 1133 | # (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| 1134 | "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. |
| 1135 | "object": "A String", # Required. Name of the Google Cloud Storage object. |
| 1136 | "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. |
| 1137 | "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to |
| 1138 | # ensure that the ExecStep specified by this PatchJob does not change. |
| 1139 | }, |
| 1140 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the |
| 1141 | # execution can return to indicate a success. |
| 1142 | 42, |
| 1143 | ], |
| 1144 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 1145 | }, |
| 1146 | }, |
| 1147 | "zypper": { # Zypper patching is performed by running `zypper patch`. # Zypper update settings. Use this setting to override the default `zypper` |
| 1148 | # patch rules. |
| 1149 | # See also https://en.opensuse.org/SDB:Zypper_manual. |
| 1150 | "exclusivePatches": [ # An exclusive list of patches to be updated. These are the only patches |
| 1151 | # that will be installed using 'zypper patch patch:<patch_name>' command. |
| 1152 | # This field must not be used with any other patch configuration fields. |
| 1153 | "A String", |
| 1154 | ], |
| 1155 | "withUpdate": True or False, # Adds the `--with-update` flag, to `zypper patch`. |
| 1156 | "excludes": [ # List of patches to exclude from update. |
| 1157 | "A String", |
| 1158 | ], |
| 1159 | "severities": [ # Install only patches with these severities. |
| 1160 | # Common severities include critical, important, moderate, and low. |
| 1161 | "A String", |
| 1162 | ], |
| 1163 | "withOptional": True or False, # Adds the `--with-optional` flag to `zypper patch`. |
| 1164 | "categories": [ # Install only patches with these categories. |
| 1165 | # Common categories include security, recommended, and feature. |
| 1166 | "A String", |
| 1167 | ], |
| 1168 | }, |
| 1169 | }, |
| 1170 | "lastExecuteTime": "A String", # Output only. The last time a patch job was started by this deployment. |
| 1171 | # Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text |
| 1172 | # format. |
| 1173 | "instanceFilter": { # A filter to target VM instances for patching. The targeted # Required. VM instances to patch. |
| 1174 | # VMs must meet all criteria specified. So if both labels and zones are |
| 1175 | # specified, the patch job targets only VMs with those labels and in those |
| 1176 | # zones. |
| 1177 | "all": True or False, # Target all VM instances in the project. If true, no other criteria is |
| 1178 | # permitted. |
| 1179 | "zones": [ # Targets VM instances in ANY of these zones. Leave empty to target VM |
| 1180 | # instances in any zone. |
| 1181 | "A String", |
| 1182 | ], |
| 1183 | "instances": [ # Targets any of the VM instances specified. Instances are specified by their |
| 1184 | # URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME]`, |
| 1185 | # `projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`, or |
| 1186 | # `https://www.googleapis.com/compute/v1/projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]` |
| 1187 | "A String", |
| 1188 | ], |
| 1189 | "groupLabels": [ # Targets VM instances matching at least one of these label sets. This allows |
| 1190 | # targeting of disparate groups, for example "env=prod or env=staging". |
| 1191 | { # Represents a group of VMs that can be identified as having all these |
| 1192 | # labels, for example "env=prod and app=web". |
| 1193 | "labels": { # Compute Engine instance labels that must be present for a VM instance to |
| 1194 | # be targeted by this filter. |
| 1195 | "a_key": "A String", |
| 1196 | }, |
| 1197 | }, |
| 1198 | ], |
| 1199 | "instanceNamePrefixes": [ # Targets VMs whose name starts with one of these prefixes. Similar to |
| 1200 | # labels, this is another way to group VMs when targeting configs, for |
| 1201 | # example prefix="prod-". |
| 1202 | "A String", |
| 1203 | ], |
| 1204 | }, |
| 1205 | "duration": "A String", # Optional. Duration of the patch. After the duration ends, the patch times out. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1206 | "recurringSchedule": { # Sets the time for recurring patch deployments. # Required. Schedule recurring executions. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1207 | "endTime": "A String", # Optional. The end time at which a recurring patch deployment schedule is no longer |
| 1208 | # active. |
| 1209 | "timeZone": { # Represents a time zone from the # Required. Defines the time zone that `time_of_day` is relative to. |
| 1210 | # The rules for daylight saving time are determined by the chosen time zone. |
| 1211 | # [IANA Time Zone Database](https://www.iana.org/time-zones). |
| 1212 | "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York". |
| 1213 | "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a". |
| 1214 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1215 | "frequency": "A String", # Required. The frequency unit of this recurring schedule. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1216 | "nextExecuteTime": "A String", # Output only. The time the next patch job is scheduled to run. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1217 | "weekly": { # Represents a weekly schedule. # Required. Schedule with weekly executions. |
| 1218 | "dayOfWeek": "A String", # Required. Day of the week. |
| 1219 | }, |
| 1220 | "lastExecuteTime": "A String", # Output only. The time the last patch job ran successfully. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1221 | "monthly": { # Represents a monthly schedule. An example of a valid monthly schedule is # Required. Schedule with monthly executions. |
| 1222 | # "on the third Tuesday of the month" or "on the 15th of the month". |
| 1223 | "monthDay": 42, # Required. One day of the month. 1-31 indicates the 1st to the 31st day. -1 |
| 1224 | # indicates the last day of the month. |
| 1225 | # Months without the target day will be skipped. For example, a schedule to |
| 1226 | # run "every month on the 31st" will not run in February, April, June, etc. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1227 | "weekDayOfMonth": { # Represents one week day in a month. An example is "the 4th Sunday". # Required. Week day in a month. |
| 1228 | "dayOfWeek": "A String", # Required. A day of the week. |
| 1229 | "weekOrdinal": 42, # Required. Week number in a month. 1-4 indicates the 1st to 4th week of the month. -1 |
| 1230 | # indicates the last week of the month. |
| 1231 | }, |
| 1232 | }, |
| 1233 | "startTime": "A String", # Optional. The time that the recurring schedule becomes effective. |
| 1234 | # Defaults to `create_time` of the patch deployment. |
| 1235 | "timeOfDay": { # Represents a time of day. The date and time zone are either not significant # Required. Time of the day to run a recurring deployment. |
| 1236 | # or are specified elsewhere. An API may choose to allow leap seconds. Related |
| 1237 | # types are google.type.Date and `google.protobuf.Timestamp`. |
| 1238 | "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may |
| 1239 | # allow the value 60 if it allows leap-seconds. |
| 1240 | "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| 1241 | "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. |
| 1242 | "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose |
| 1243 | # to allow the value "24:00:00" for scenarios like business closing time. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1244 | }, |
| 1245 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1246 | "description": "A String", # Optional. Description of the patch deployment. Length of the description is limited |
| 1247 | # to 1024 characters. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1248 | "oneTimeSchedule": { # Sets the time for a one time patch deployment. Timestamp is in # Required. Schedule a one-time execution. |
| 1249 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 1250 | "executeTime": "A String", # Required. The desired patch job execution time. |
| 1251 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1252 | "name": "A String", # Unique name for the patch deployment resource in a project. The patch |
| 1253 | # deployment name is in the form: |
| 1254 | # `projects/{project_id}/patchDeployments/{patch_deployment_id}`. |
| 1255 | # This field is ignored when you create a new patch deployment. |
| 1256 | "createTime": "A String", # Output only. Time the patch deployment was created. Timestamp is in |
| 1257 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 1258 | "updateTime": "A String", # Output only. Time the patch deployment was last updated. Timestamp is in |
| 1259 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 1260 | "rollout": { # Patch rollout configuration specifications. Contains details on the # Optional. Rollout strategy of the patch job. |
| 1261 | # concurrency control when applying patch(es) to all targeted VMs. |
| 1262 | "disruptionBudget": { # Message encapsulating a value that can be either absolute ("fixed") or # The maximum number (or percentage) of VMs per zone to disrupt at any given |
| 1263 | # moment. The number of VMs calculated from multiplying the percentage by the |
| 1264 | # total number of VMs in a zone is rounded up. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1265 | # |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1266 | # During patching, a VM is considered disrupted from the time the agent is |
| 1267 | # notified to begin until patching has completed. This disruption time |
| 1268 | # includes the time to complete reboot and any post-patch steps. |
| 1269 | # |
| 1270 | # A VM contributes to the disruption budget if its patching operation fails |
| 1271 | # either when applying the patches, running pre or post patch steps, or if it |
| 1272 | # fails to respond with a success notification before timing out. VMs that |
| 1273 | # are not running or do not have an active agent do not count toward this |
| 1274 | # disruption budget. |
| 1275 | # |
| 1276 | # For zone-by-zone rollouts, if the disruption budget in a zone is exceeded, |
| 1277 | # the patch job stops, because continuing to the next zone requires |
| 1278 | # completion of the patch process in the previous zone. |
| 1279 | # |
| 1280 | # For example, if the disruption budget has a fixed value of `10`, and 8 VMs |
| 1281 | # fail to patch in the current zone, the patch job continues to patch 2 VMs |
| 1282 | # at a time until the zone is completed. When that zone is completed |
| 1283 | # successfully, patching begins with 10 VMs at a time in the next zone. If 10 |
| 1284 | # VMs in the next zone fail to patch, the patch job stops. |
| 1285 | # relative ("percent") to a value. |
| 1286 | "percent": 42, # Specifies the relative value defined as a percentage, which will be |
| 1287 | # multiplied by a reference value. |
| 1288 | "fixed": 42, # Specifies a fixed value. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1289 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1290 | "mode": "A String", # Mode of the patch rollout. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1291 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1292 | }, |
| 1293 | ], |
| 1294 | }</pre> |
| 1295 | </div> |
| 1296 | |
| 1297 | <div class="method"> |
| 1298 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 1299 | <pre>Retrieves the next page of results. |
| 1300 | |
| 1301 | Args: |
| 1302 | previous_request: The request for the previous page. (required) |
| 1303 | previous_response: The response from the request for the previous page. (required) |
| 1304 | |
| 1305 | Returns: |
| 1306 | A request object that you can call 'execute()' on to request the next |
| 1307 | page. Returns None if there are no more items in the collection. |
| 1308 | </pre> |
| 1309 | </div> |
| 1310 | |
| 1311 | </body></html> |