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