| 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 | |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 75 | <h1><a href="osconfig_v1beta.html">OS Config API</a> . <a href="osconfig_v1beta.projects.html">projects</a> . <a href="osconfig_v1beta.projects.patchDeployments.html">patchDeployments</a></h1> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 78 | <code><a href="#close">close()</a></code></p> |
| 79 | <p class="firstline">Close httplib2 connections.</p> |
| 80 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 81 | <code><a href="#create">create(parent, body=None, patchDeploymentId=None, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Create an OS Config patch deployment.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| 85 | <p class="firstline">Delete an OS Config patch deployment.</p> |
| 86 | <p class="toc_element"> |
| 87 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 88 | <p class="firstline">Get an OS Config patch deployment.</p> |
| 89 | <p class="toc_element"> |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 90 | <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 91 | <p class="firstline">Get a page of OS Config patch deployments.</p> |
| 92 | <p class="toc_element"> |
| 93 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 94 | <p class="firstline">Retrieves the next page of results.</p> |
| 95 | <h3>Method Details</h3> |
| 96 | <div class="method"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 97 | <code class="details" id="close">close()</code> |
| 98 | <pre>Close httplib2 connections.</pre> |
| 99 | </div> |
| 100 | |
| 101 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 102 | <code class="details" id="create">create(parent, body=None, patchDeploymentId=None, x__xgafv=None)</code> |
| 103 | <pre>Create an OS Config patch deployment. |
| 104 | |
| 105 | Args: |
| 106 | parent: string, Required. The project to apply this patch deployment to in the form `projects/*`. (required) |
| 107 | body: object, The request body. |
| 108 | The object takes the form of: |
| 109 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 110 | { # Patch deployments are configurations that individual patch jobs use to complete a patch. These configurations include instance filter, package repository settings, and a schedule. For more information about creating and managing patch deployments, see [Scheduling patch jobs](https://cloud.google.com/compute/docs/os-patch-management/schedule-patch-jobs). |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 111 | "oneTimeSchedule": { # Sets the time for a one time patch deployment. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. # Required. Schedule a one-time execution. |
| 112 | "executeTime": "A String", # Required. The desired patch job execution time. |
| 113 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 114 | "patchConfig": { # Patch configuration specifications. Contains details on how to apply the patch(es) to a VM instance. # Optional. Patch configuration that is applied. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 115 | "windowsUpdate": { # Windows patching is performed using the Windows Update Agent. # Windows update settings. Use this override the default windows patch rules. |
| 116 | "classifications": [ # Only apply updates of these windows update classifications. If empty, all updates are applied. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 117 | "A String", |
| 118 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 119 | "exclusivePatches": [ # An exclusive list of kbs to be updated. These are the only patches that will be updated. This field must not be used with other patch configurations. |
| 120 | "A String", |
| 121 | ], |
| 122 | "excludes": [ # List of KBs to exclude from update. |
| 123 | "A String", |
| 124 | ], |
| 125 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 126 | "preStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run before the patch update. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 127 | "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 128 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. |
| 129 | 42, |
| 130 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 131 | "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. |
| 132 | "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. |
| 133 | "object": "A String", # Required. Name of the Google Cloud Storage object. |
| 134 | "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. |
| 135 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 136 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 137 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 138 | }, |
| 139 | "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob. |
| 140 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. |
| 141 | 42, |
| 142 | ], |
| 143 | "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. |
| 144 | "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. |
| 145 | "object": "A String", # Required. Name of the Google Cloud Storage object. |
| 146 | "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. |
| 147 | }, |
| 148 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| 149 | "localPath": "A String", # An absolute path to the executable on the VM. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 150 | }, |
| 151 | }, |
| 152 | "rebootConfig": "A String", # Post-patch reboot settings. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 153 | "postStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run after the patch update. |
| 154 | "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob. |
| 155 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. |
| 156 | 42, |
| 157 | ], |
| 158 | "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. |
| 159 | "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. |
| 160 | "object": "A String", # Required. Name of the Google Cloud Storage object. |
| 161 | "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. |
| 162 | }, |
| 163 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| 164 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 165 | }, |
| 166 | "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob. |
| 167 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. |
| 168 | 42, |
| 169 | ], |
| 170 | "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. |
| 171 | "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. |
| 172 | "object": "A String", # Required. Name of the Google Cloud Storage object. |
| 173 | "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. |
| 174 | }, |
| 175 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| 176 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 177 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 178 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 179 | "apt": { # Apt patching is completed by executing `apt-get update && apt-get upgrade`. Additional options can be set to control how this is executed. # Apt update settings. Use this setting to override the default `apt` patch rules. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 180 | "excludes": [ # List of packages to exclude from update. These packages will be excluded |
| 181 | "A String", |
| 182 | ], |
| 183 | "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field cannot be specified with any other patch configuration fields. |
| 184 | "A String", |
| 185 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 186 | "type": "A String", # By changing the type to DIST, the patching is performed using `apt-get dist-upgrade` instead. |
| 187 | }, |
| 188 | "yum": { # Yum patching is performed by executing `yum update`. Additional options can be set to control how this is executed. Note that not all settings are supported on all platforms. # Yum update settings. Use this setting to override the default `yum` patch rules. |
| 189 | "minimal": True or False, # Will cause patch to run `yum update-minimal` instead. |
| 190 | "security": True or False, # Adds the `--security` flag to `yum update`. Not supported on all platforms. |
| 191 | "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field must not be specified with any other patch configuration fields. |
| 192 | "A String", |
| 193 | ], |
| 194 | "excludes": [ # List of packages to exclude from update. These packages are excluded by using the yum `--exclude` flag. |
| 195 | "A String", |
| 196 | ], |
| 197 | }, |
| 198 | "zypper": { # Zypper patching is performed by running `zypper patch`. See also https://en.opensuse.org/SDB:Zypper_manual. # Zypper update settings. Use this setting to override the default `zypper` patch rules. |
| 199 | "withUpdate": True or False, # Adds the `--with-update` flag, to `zypper patch`. |
| 200 | "exclusivePatches": [ # An exclusive list of patches to be updated. These are the only patches that will be installed using 'zypper patch patch:' command. This field must not be used with any other patch configuration fields. |
| 201 | "A String", |
| 202 | ], |
| 203 | "categories": [ # Install only patches with these categories. Common categories include security, recommended, and feature. |
| 204 | "A String", |
| 205 | ], |
| 206 | "excludes": [ # List of patches to exclude from update. |
| 207 | "A String", |
| 208 | ], |
| 209 | "severities": [ # Install only patches with these severities. Common severities include critical, important, moderate, and low. |
| 210 | "A String", |
| 211 | ], |
| 212 | "withOptional": True or False, # Adds the `--with-optional` flag to `zypper patch`. |
| 213 | }, |
| 214 | "goo": { # Googet patching is performed by running `googet update`. # Goo update settings. Use this setting to override the default `goo` patch rules. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 215 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 216 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 217 | "description": "A String", # Optional. Description of the patch deployment. Length of the description is limited to 1024 characters. |
| 218 | "createTime": "A String", # Output only. Time the patch deployment was created. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 219 | "updateTime": "A String", # Output only. Time the patch deployment was last updated. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 220 | "duration": "A String", # Optional. Duration of the patch. After the duration ends, the patch times out. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 221 | "recurringSchedule": { # Sets the time for recurring patch deployments. # Required. Schedule recurring executions. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 222 | "weekly": { # Represents a weekly schedule. # Required. Schedule with weekly executions. |
| 223 | "dayOfWeek": "A String", # Required. Day of the week. |
| 224 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 225 | "timeOfDay": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Time of the day to run a recurring deployment. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 226 | "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| 227 | "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| 228 | "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 229 | "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 230 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 231 | "nextExecuteTime": "A String", # Output only. The time the next patch job is scheduled to run. |
| 232 | "monthly": { # Represents a monthly schedule. An example of a valid monthly schedule is "on the third Tuesday of the month" or "on the 15th of the month". # Required. Schedule with monthly executions. |
| 233 | "weekDayOfMonth": { # Represents one week day in a month. An example is "the 4th Sunday". # Required. Week day in a month. |
| 234 | "dayOfWeek": "A String", # Required. A day of the week. |
| 235 | "weekOrdinal": 42, # Required. Week number in a month. 1-4 indicates the 1st to 4th week of the month. -1 indicates the last week of the month. |
| 236 | }, |
| 237 | "monthDay": 42, # Required. One day of the month. 1-31 indicates the 1st to the 31st day. -1 indicates the last day of the month. Months without the target day will be skipped. For example, a schedule to run "every month on the 31st" will not run in February, April, June, etc. |
| 238 | }, |
| 239 | "startTime": "A String", # Optional. The time that the recurring schedule becomes effective. Defaults to `create_time` of the patch deployment. |
| 240 | "lastExecuteTime": "A String", # Output only. The time the last patch job ran successfully. |
| 241 | "endTime": "A String", # Optional. The end time at which a recurring patch deployment schedule is no longer active. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 242 | "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. Defines the time zone that `time_of_day` is relative to. The rules for daylight saving time are determined by the chosen time zone. |
| 243 | "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a". |
| 244 | "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York". |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 245 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 246 | "frequency": "A String", # Required. The frequency unit of this recurring schedule. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 247 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 248 | "lastExecuteTime": "A String", # Output only. The last time a patch job was started by this deployment. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 249 | "rollout": { # Patch rollout configuration specifications. Contains details on the concurrency control when applying patch(es) to all targeted VMs. # Optional. Rollout strategy of the patch job. |
| 250 | "mode": "A String", # Mode of the patch rollout. |
| 251 | "disruptionBudget": { # Message encapsulating a value that can be either absolute ("fixed") or relative ("percent") to a value. # The maximum number (or percentage) of VMs per zone to disrupt at any given moment. The number of VMs calculated from multiplying the percentage by the total number of VMs in a zone is rounded up. During patching, a VM is considered disrupted from the time the agent is notified to begin until patching has completed. This disruption time includes the time to complete reboot and any post-patch steps. A VM contributes to the disruption budget if its patching operation fails either when applying the patches, running pre or post patch steps, or if it fails to respond with a success notification before timing out. VMs that are not running or do not have an active agent do not count toward this disruption budget. For zone-by-zone rollouts, if the disruption budget in a zone is exceeded, the patch job stops, because continuing to the next zone requires completion of the patch process in the previous zone. For example, if the disruption budget has a fixed value of `10`, and 8 VMs fail to patch in the current zone, the patch job continues to patch 2 VMs at a time until the zone is completed. When that zone is completed successfully, patching begins with 10 VMs at a time in the next zone. If 10 VMs in the next zone fail to patch, the patch job stops. |
| 252 | "fixed": 42, # Specifies a fixed value. |
| 253 | "percent": 42, # Specifies the relative value defined as a percentage, which will be multiplied by a reference value. |
| 254 | }, |
| 255 | }, |
| 256 | "name": "A String", # Unique name for the patch deployment resource in a project. The patch deployment name is in the form: `projects/{project_id}/patchDeployments/{patch_deployment_id}`. This field is ignored when you create a new patch deployment. |
| 257 | "instanceFilter": { # A filter to target VM instances for patching. The targeted VMs must meet all criteria specified. So if both labels and zones are specified, the patch job targets only VMs with those labels and in those zones. # Required. VM instances to patch. |
| 258 | "zones": [ # Targets VM instances in ANY of these zones. Leave empty to target VM instances in any zone. |
| 259 | "A String", |
| 260 | ], |
| 261 | "instanceNamePrefixes": [ # Targets VMs whose name starts with one of these prefixes. Similar to labels, this is another way to group VMs when targeting configs, for example prefix="prod-". |
| 262 | "A String", |
| 263 | ], |
| 264 | "all": True or False, # Target all VM instances in the project. If true, no other criteria is permitted. |
| 265 | "instances": [ # Targets any of the VM instances specified. Instances are specified by their URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME]`, `projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`, or `https://www.googleapis.com/compute/v1/projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]` |
| 266 | "A String", |
| 267 | ], |
| 268 | "groupLabels": [ # Targets VM instances matching at least one of these label sets. This allows targeting of disparate groups, for example "env=prod or env=staging". |
| 269 | { # Represents a group of VMs that can be identified as having all these labels, for example "env=prod and app=web". |
| 270 | "labels": { # Compute Engine instance labels that must be present for a VM instance to be targeted by this filter. |
| 271 | "a_key": "A String", |
| 272 | }, |
| 273 | }, |
| 274 | ], |
| 275 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 276 | } |
| 277 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 278 | patchDeploymentId: string, Required. A name for the patch deployment in the project. When creating a name the following rules apply: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the project. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 279 | x__xgafv: string, V1 error format. |
| 280 | Allowed values |
| 281 | 1 - v1 error format |
| 282 | 2 - v2 error format |
| 283 | |
| 284 | Returns: |
| 285 | An object of the form: |
| 286 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 287 | { # Patch deployments are configurations that individual patch jobs use to complete a patch. These configurations include instance filter, package repository settings, and a schedule. For more information about creating and managing patch deployments, see [Scheduling patch jobs](https://cloud.google.com/compute/docs/os-patch-management/schedule-patch-jobs). |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 288 | "oneTimeSchedule": { # Sets the time for a one time patch deployment. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. # Required. Schedule a one-time execution. |
| 289 | "executeTime": "A String", # Required. The desired patch job execution time. |
| 290 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 291 | "patchConfig": { # Patch configuration specifications. Contains details on how to apply the patch(es) to a VM instance. # Optional. Patch configuration that is applied. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 292 | "windowsUpdate": { # Windows patching is performed using the Windows Update Agent. # Windows update settings. Use this override the default windows patch rules. |
| 293 | "classifications": [ # Only apply updates of these windows update classifications. If empty, all updates are applied. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 294 | "A String", |
| 295 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 296 | "exclusivePatches": [ # An exclusive list of kbs to be updated. These are the only patches that will be updated. This field must not be used with other patch configurations. |
| 297 | "A String", |
| 298 | ], |
| 299 | "excludes": [ # List of KBs to exclude from update. |
| 300 | "A String", |
| 301 | ], |
| 302 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 303 | "preStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run before the patch update. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 304 | "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 305 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. |
| 306 | 42, |
| 307 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 308 | "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. |
| 309 | "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. |
| 310 | "object": "A String", # Required. Name of the Google Cloud Storage object. |
| 311 | "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. |
| 312 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 313 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 314 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 315 | }, |
| 316 | "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob. |
| 317 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. |
| 318 | 42, |
| 319 | ], |
| 320 | "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. |
| 321 | "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. |
| 322 | "object": "A String", # Required. Name of the Google Cloud Storage object. |
| 323 | "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. |
| 324 | }, |
| 325 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| 326 | "localPath": "A String", # An absolute path to the executable on the VM. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 327 | }, |
| 328 | }, |
| 329 | "rebootConfig": "A String", # Post-patch reboot settings. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 330 | "postStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run after the patch update. |
| 331 | "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob. |
| 332 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. |
| 333 | 42, |
| 334 | ], |
| 335 | "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. |
| 336 | "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. |
| 337 | "object": "A String", # Required. Name of the Google Cloud Storage object. |
| 338 | "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. |
| 339 | }, |
| 340 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| 341 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 342 | }, |
| 343 | "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob. |
| 344 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. |
| 345 | 42, |
| 346 | ], |
| 347 | "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. |
| 348 | "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. |
| 349 | "object": "A String", # Required. Name of the Google Cloud Storage object. |
| 350 | "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. |
| 351 | }, |
| 352 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| 353 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 354 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 355 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 356 | "apt": { # Apt patching is completed by executing `apt-get update && apt-get upgrade`. Additional options can be set to control how this is executed. # Apt update settings. Use this setting to override the default `apt` patch rules. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 357 | "excludes": [ # List of packages to exclude from update. These packages will be excluded |
| 358 | "A String", |
| 359 | ], |
| 360 | "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field cannot be specified with any other patch configuration fields. |
| 361 | "A String", |
| 362 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 363 | "type": "A String", # By changing the type to DIST, the patching is performed using `apt-get dist-upgrade` instead. |
| 364 | }, |
| 365 | "yum": { # Yum patching is performed by executing `yum update`. Additional options can be set to control how this is executed. Note that not all settings are supported on all platforms. # Yum update settings. Use this setting to override the default `yum` patch rules. |
| 366 | "minimal": True or False, # Will cause patch to run `yum update-minimal` instead. |
| 367 | "security": True or False, # Adds the `--security` flag to `yum update`. Not supported on all platforms. |
| 368 | "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field must not be specified with any other patch configuration fields. |
| 369 | "A String", |
| 370 | ], |
| 371 | "excludes": [ # List of packages to exclude from update. These packages are excluded by using the yum `--exclude` flag. |
| 372 | "A String", |
| 373 | ], |
| 374 | }, |
| 375 | "zypper": { # Zypper patching is performed by running `zypper patch`. See also https://en.opensuse.org/SDB:Zypper_manual. # Zypper update settings. Use this setting to override the default `zypper` patch rules. |
| 376 | "withUpdate": True or False, # Adds the `--with-update` flag, to `zypper patch`. |
| 377 | "exclusivePatches": [ # An exclusive list of patches to be updated. These are the only patches that will be installed using 'zypper patch patch:' command. This field must not be used with any other patch configuration fields. |
| 378 | "A String", |
| 379 | ], |
| 380 | "categories": [ # Install only patches with these categories. Common categories include security, recommended, and feature. |
| 381 | "A String", |
| 382 | ], |
| 383 | "excludes": [ # List of patches to exclude from update. |
| 384 | "A String", |
| 385 | ], |
| 386 | "severities": [ # Install only patches with these severities. Common severities include critical, important, moderate, and low. |
| 387 | "A String", |
| 388 | ], |
| 389 | "withOptional": True or False, # Adds the `--with-optional` flag to `zypper patch`. |
| 390 | }, |
| 391 | "goo": { # Googet patching is performed by running `googet update`. # Goo update settings. Use this setting to override the default `goo` patch rules. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 392 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 393 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 394 | "description": "A String", # Optional. Description of the patch deployment. Length of the description is limited to 1024 characters. |
| 395 | "createTime": "A String", # Output only. Time the patch deployment was created. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 396 | "updateTime": "A String", # Output only. Time the patch deployment was last updated. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 397 | "duration": "A String", # Optional. Duration of the patch. After the duration ends, the patch times out. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 398 | "recurringSchedule": { # Sets the time for recurring patch deployments. # Required. Schedule recurring executions. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 399 | "weekly": { # Represents a weekly schedule. # Required. Schedule with weekly executions. |
| 400 | "dayOfWeek": "A String", # Required. Day of the week. |
| 401 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 402 | "timeOfDay": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Time of the day to run a recurring deployment. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 403 | "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| 404 | "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| 405 | "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 406 | "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 407 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 408 | "nextExecuteTime": "A String", # Output only. The time the next patch job is scheduled to run. |
| 409 | "monthly": { # Represents a monthly schedule. An example of a valid monthly schedule is "on the third Tuesday of the month" or "on the 15th of the month". # Required. Schedule with monthly executions. |
| 410 | "weekDayOfMonth": { # Represents one week day in a month. An example is "the 4th Sunday". # Required. Week day in a month. |
| 411 | "dayOfWeek": "A String", # Required. A day of the week. |
| 412 | "weekOrdinal": 42, # Required. Week number in a month. 1-4 indicates the 1st to 4th week of the month. -1 indicates the last week of the month. |
| 413 | }, |
| 414 | "monthDay": 42, # Required. One day of the month. 1-31 indicates the 1st to the 31st day. -1 indicates the last day of the month. Months without the target day will be skipped. For example, a schedule to run "every month on the 31st" will not run in February, April, June, etc. |
| 415 | }, |
| 416 | "startTime": "A String", # Optional. The time that the recurring schedule becomes effective. Defaults to `create_time` of the patch deployment. |
| 417 | "lastExecuteTime": "A String", # Output only. The time the last patch job ran successfully. |
| 418 | "endTime": "A String", # Optional. The end time at which a recurring patch deployment schedule is no longer active. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 419 | "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. Defines the time zone that `time_of_day` is relative to. The rules for daylight saving time are determined by the chosen time zone. |
| 420 | "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a". |
| 421 | "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York". |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 422 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 423 | "frequency": "A String", # Required. The frequency unit of this recurring schedule. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 424 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 425 | "lastExecuteTime": "A String", # Output only. The last time a patch job was started by this deployment. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 426 | "rollout": { # Patch rollout configuration specifications. Contains details on the concurrency control when applying patch(es) to all targeted VMs. # Optional. Rollout strategy of the patch job. |
| 427 | "mode": "A String", # Mode of the patch rollout. |
| 428 | "disruptionBudget": { # Message encapsulating a value that can be either absolute ("fixed") or relative ("percent") to a value. # The maximum number (or percentage) of VMs per zone to disrupt at any given moment. The number of VMs calculated from multiplying the percentage by the total number of VMs in a zone is rounded up. During patching, a VM is considered disrupted from the time the agent is notified to begin until patching has completed. This disruption time includes the time to complete reboot and any post-patch steps. A VM contributes to the disruption budget if its patching operation fails either when applying the patches, running pre or post patch steps, or if it fails to respond with a success notification before timing out. VMs that are not running or do not have an active agent do not count toward this disruption budget. For zone-by-zone rollouts, if the disruption budget in a zone is exceeded, the patch job stops, because continuing to the next zone requires completion of the patch process in the previous zone. For example, if the disruption budget has a fixed value of `10`, and 8 VMs fail to patch in the current zone, the patch job continues to patch 2 VMs at a time until the zone is completed. When that zone is completed successfully, patching begins with 10 VMs at a time in the next zone. If 10 VMs in the next zone fail to patch, the patch job stops. |
| 429 | "fixed": 42, # Specifies a fixed value. |
| 430 | "percent": 42, # Specifies the relative value defined as a percentage, which will be multiplied by a reference value. |
| 431 | }, |
| 432 | }, |
| 433 | "name": "A String", # Unique name for the patch deployment resource in a project. The patch deployment name is in the form: `projects/{project_id}/patchDeployments/{patch_deployment_id}`. This field is ignored when you create a new patch deployment. |
| 434 | "instanceFilter": { # A filter to target VM instances for patching. The targeted VMs must meet all criteria specified. So if both labels and zones are specified, the patch job targets only VMs with those labels and in those zones. # Required. VM instances to patch. |
| 435 | "zones": [ # Targets VM instances in ANY of these zones. Leave empty to target VM instances in any zone. |
| 436 | "A String", |
| 437 | ], |
| 438 | "instanceNamePrefixes": [ # Targets VMs whose name starts with one of these prefixes. Similar to labels, this is another way to group VMs when targeting configs, for example prefix="prod-". |
| 439 | "A String", |
| 440 | ], |
| 441 | "all": True or False, # Target all VM instances in the project. If true, no other criteria is permitted. |
| 442 | "instances": [ # Targets any of the VM instances specified. Instances are specified by their URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME]`, `projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`, or `https://www.googleapis.com/compute/v1/projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]` |
| 443 | "A String", |
| 444 | ], |
| 445 | "groupLabels": [ # Targets VM instances matching at least one of these label sets. This allows targeting of disparate groups, for example "env=prod or env=staging". |
| 446 | { # Represents a group of VMs that can be identified as having all these labels, for example "env=prod and app=web". |
| 447 | "labels": { # Compute Engine instance labels that must be present for a VM instance to be targeted by this filter. |
| 448 | "a_key": "A String", |
| 449 | }, |
| 450 | }, |
| 451 | ], |
| 452 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 453 | }</pre> |
| 454 | </div> |
| 455 | |
| 456 | <div class="method"> |
| 457 | <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| 458 | <pre>Delete an OS Config patch deployment. |
| 459 | |
| 460 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 461 | name: string, Required. The resource name of the patch deployment in the form `projects/*/patchDeployments/*`. (required) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 462 | x__xgafv: string, V1 error format. |
| 463 | Allowed values |
| 464 | 1 - v1 error format |
| 465 | 2 - v2 error format |
| 466 | |
| 467 | Returns: |
| 468 | An object of the form: |
| 469 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 470 | { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 471 | }</pre> |
| 472 | </div> |
| 473 | |
| 474 | <div class="method"> |
| 475 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 476 | <pre>Get an OS Config patch deployment. |
| 477 | |
| 478 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 479 | name: string, Required. The resource name of the patch deployment in the form `projects/*/patchDeployments/*`. (required) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 480 | x__xgafv: string, V1 error format. |
| 481 | Allowed values |
| 482 | 1 - v1 error format |
| 483 | 2 - v2 error format |
| 484 | |
| 485 | Returns: |
| 486 | An object of the form: |
| 487 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 488 | { # Patch deployments are configurations that individual patch jobs use to complete a patch. These configurations include instance filter, package repository settings, and a schedule. For more information about creating and managing patch deployments, see [Scheduling patch jobs](https://cloud.google.com/compute/docs/os-patch-management/schedule-patch-jobs). |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 489 | "oneTimeSchedule": { # Sets the time for a one time patch deployment. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. # Required. Schedule a one-time execution. |
| 490 | "executeTime": "A String", # Required. The desired patch job execution time. |
| 491 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 492 | "patchConfig": { # Patch configuration specifications. Contains details on how to apply the patch(es) to a VM instance. # Optional. Patch configuration that is applied. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 493 | "windowsUpdate": { # Windows patching is performed using the Windows Update Agent. # Windows update settings. Use this override the default windows patch rules. |
| 494 | "classifications": [ # Only apply updates of these windows update classifications. If empty, all updates are applied. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 495 | "A String", |
| 496 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 497 | "exclusivePatches": [ # An exclusive list of kbs to be updated. These are the only patches that will be updated. This field must not be used with other patch configurations. |
| 498 | "A String", |
| 499 | ], |
| 500 | "excludes": [ # List of KBs to exclude from update. |
| 501 | "A String", |
| 502 | ], |
| 503 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 504 | "preStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run before the patch update. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 505 | "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 506 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. |
| 507 | 42, |
| 508 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 509 | "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. |
| 510 | "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. |
| 511 | "object": "A String", # Required. Name of the Google Cloud Storage object. |
| 512 | "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. |
| 513 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 514 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 515 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 516 | }, |
| 517 | "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob. |
| 518 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. |
| 519 | 42, |
| 520 | ], |
| 521 | "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. |
| 522 | "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. |
| 523 | "object": "A String", # Required. Name of the Google Cloud Storage object. |
| 524 | "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. |
| 525 | }, |
| 526 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| 527 | "localPath": "A String", # An absolute path to the executable on the VM. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 528 | }, |
| 529 | }, |
| 530 | "rebootConfig": "A String", # Post-patch reboot settings. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 531 | "postStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run after the patch update. |
| 532 | "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob. |
| 533 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. |
| 534 | 42, |
| 535 | ], |
| 536 | "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. |
| 537 | "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. |
| 538 | "object": "A String", # Required. Name of the Google Cloud Storage object. |
| 539 | "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. |
| 540 | }, |
| 541 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| 542 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 543 | }, |
| 544 | "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob. |
| 545 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. |
| 546 | 42, |
| 547 | ], |
| 548 | "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. |
| 549 | "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. |
| 550 | "object": "A String", # Required. Name of the Google Cloud Storage object. |
| 551 | "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. |
| 552 | }, |
| 553 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| 554 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 555 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 556 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 557 | "apt": { # Apt patching is completed by executing `apt-get update && apt-get upgrade`. Additional options can be set to control how this is executed. # Apt update settings. Use this setting to override the default `apt` patch rules. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 558 | "excludes": [ # List of packages to exclude from update. These packages will be excluded |
| 559 | "A String", |
| 560 | ], |
| 561 | "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field cannot be specified with any other patch configuration fields. |
| 562 | "A String", |
| 563 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 564 | "type": "A String", # By changing the type to DIST, the patching is performed using `apt-get dist-upgrade` instead. |
| 565 | }, |
| 566 | "yum": { # Yum patching is performed by executing `yum update`. Additional options can be set to control how this is executed. Note that not all settings are supported on all platforms. # Yum update settings. Use this setting to override the default `yum` patch rules. |
| 567 | "minimal": True or False, # Will cause patch to run `yum update-minimal` instead. |
| 568 | "security": True or False, # Adds the `--security` flag to `yum update`. Not supported on all platforms. |
| 569 | "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field must not be specified with any other patch configuration fields. |
| 570 | "A String", |
| 571 | ], |
| 572 | "excludes": [ # List of packages to exclude from update. These packages are excluded by using the yum `--exclude` flag. |
| 573 | "A String", |
| 574 | ], |
| 575 | }, |
| 576 | "zypper": { # Zypper patching is performed by running `zypper patch`. See also https://en.opensuse.org/SDB:Zypper_manual. # Zypper update settings. Use this setting to override the default `zypper` patch rules. |
| 577 | "withUpdate": True or False, # Adds the `--with-update` flag, to `zypper patch`. |
| 578 | "exclusivePatches": [ # An exclusive list of patches to be updated. These are the only patches that will be installed using 'zypper patch patch:' command. This field must not be used with any other patch configuration fields. |
| 579 | "A String", |
| 580 | ], |
| 581 | "categories": [ # Install only patches with these categories. Common categories include security, recommended, and feature. |
| 582 | "A String", |
| 583 | ], |
| 584 | "excludes": [ # List of patches to exclude from update. |
| 585 | "A String", |
| 586 | ], |
| 587 | "severities": [ # Install only patches with these severities. Common severities include critical, important, moderate, and low. |
| 588 | "A String", |
| 589 | ], |
| 590 | "withOptional": True or False, # Adds the `--with-optional` flag to `zypper patch`. |
| 591 | }, |
| 592 | "goo": { # Googet patching is performed by running `googet update`. # Goo update settings. Use this setting to override the default `goo` patch rules. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 593 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 594 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 595 | "description": "A String", # Optional. Description of the patch deployment. Length of the description is limited to 1024 characters. |
| 596 | "createTime": "A String", # Output only. Time the patch deployment was created. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 597 | "updateTime": "A String", # Output only. Time the patch deployment was last updated. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 598 | "duration": "A String", # Optional. Duration of the patch. After the duration ends, the patch times out. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 599 | "recurringSchedule": { # Sets the time for recurring patch deployments. # Required. Schedule recurring executions. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 600 | "weekly": { # Represents a weekly schedule. # Required. Schedule with weekly executions. |
| 601 | "dayOfWeek": "A String", # Required. Day of the week. |
| 602 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 603 | "timeOfDay": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Time of the day to run a recurring deployment. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 604 | "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| 605 | "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| 606 | "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 607 | "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 608 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 609 | "nextExecuteTime": "A String", # Output only. The time the next patch job is scheduled to run. |
| 610 | "monthly": { # Represents a monthly schedule. An example of a valid monthly schedule is "on the third Tuesday of the month" or "on the 15th of the month". # Required. Schedule with monthly executions. |
| 611 | "weekDayOfMonth": { # Represents one week day in a month. An example is "the 4th Sunday". # Required. Week day in a month. |
| 612 | "dayOfWeek": "A String", # Required. A day of the week. |
| 613 | "weekOrdinal": 42, # Required. Week number in a month. 1-4 indicates the 1st to 4th week of the month. -1 indicates the last week of the month. |
| 614 | }, |
| 615 | "monthDay": 42, # Required. One day of the month. 1-31 indicates the 1st to the 31st day. -1 indicates the last day of the month. Months without the target day will be skipped. For example, a schedule to run "every month on the 31st" will not run in February, April, June, etc. |
| 616 | }, |
| 617 | "startTime": "A String", # Optional. The time that the recurring schedule becomes effective. Defaults to `create_time` of the patch deployment. |
| 618 | "lastExecuteTime": "A String", # Output only. The time the last patch job ran successfully. |
| 619 | "endTime": "A String", # Optional. The end time at which a recurring patch deployment schedule is no longer active. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 620 | "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. Defines the time zone that `time_of_day` is relative to. The rules for daylight saving time are determined by the chosen time zone. |
| 621 | "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a". |
| 622 | "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York". |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 623 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 624 | "frequency": "A String", # Required. The frequency unit of this recurring schedule. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 625 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 626 | "lastExecuteTime": "A String", # Output only. The last time a patch job was started by this deployment. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 627 | "rollout": { # Patch rollout configuration specifications. Contains details on the concurrency control when applying patch(es) to all targeted VMs. # Optional. Rollout strategy of the patch job. |
| 628 | "mode": "A String", # Mode of the patch rollout. |
| 629 | "disruptionBudget": { # Message encapsulating a value that can be either absolute ("fixed") or relative ("percent") to a value. # The maximum number (or percentage) of VMs per zone to disrupt at any given moment. The number of VMs calculated from multiplying the percentage by the total number of VMs in a zone is rounded up. During patching, a VM is considered disrupted from the time the agent is notified to begin until patching has completed. This disruption time includes the time to complete reboot and any post-patch steps. A VM contributes to the disruption budget if its patching operation fails either when applying the patches, running pre or post patch steps, or if it fails to respond with a success notification before timing out. VMs that are not running or do not have an active agent do not count toward this disruption budget. For zone-by-zone rollouts, if the disruption budget in a zone is exceeded, the patch job stops, because continuing to the next zone requires completion of the patch process in the previous zone. For example, if the disruption budget has a fixed value of `10`, and 8 VMs fail to patch in the current zone, the patch job continues to patch 2 VMs at a time until the zone is completed. When that zone is completed successfully, patching begins with 10 VMs at a time in the next zone. If 10 VMs in the next zone fail to patch, the patch job stops. |
| 630 | "fixed": 42, # Specifies a fixed value. |
| 631 | "percent": 42, # Specifies the relative value defined as a percentage, which will be multiplied by a reference value. |
| 632 | }, |
| 633 | }, |
| 634 | "name": "A String", # Unique name for the patch deployment resource in a project. The patch deployment name is in the form: `projects/{project_id}/patchDeployments/{patch_deployment_id}`. This field is ignored when you create a new patch deployment. |
| 635 | "instanceFilter": { # A filter to target VM instances for patching. The targeted VMs must meet all criteria specified. So if both labels and zones are specified, the patch job targets only VMs with those labels and in those zones. # Required. VM instances to patch. |
| 636 | "zones": [ # Targets VM instances in ANY of these zones. Leave empty to target VM instances in any zone. |
| 637 | "A String", |
| 638 | ], |
| 639 | "instanceNamePrefixes": [ # Targets VMs whose name starts with one of these prefixes. Similar to labels, this is another way to group VMs when targeting configs, for example prefix="prod-". |
| 640 | "A String", |
| 641 | ], |
| 642 | "all": True or False, # Target all VM instances in the project. If true, no other criteria is permitted. |
| 643 | "instances": [ # Targets any of the VM instances specified. Instances are specified by their URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME]`, `projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`, or `https://www.googleapis.com/compute/v1/projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]` |
| 644 | "A String", |
| 645 | ], |
| 646 | "groupLabels": [ # Targets VM instances matching at least one of these label sets. This allows targeting of disparate groups, for example "env=prod or env=staging". |
| 647 | { # Represents a group of VMs that can be identified as having all these labels, for example "env=prod and app=web". |
| 648 | "labels": { # Compute Engine instance labels that must be present for a VM instance to be targeted by this filter. |
| 649 | "a_key": "A String", |
| 650 | }, |
| 651 | }, |
| 652 | ], |
| 653 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 654 | }</pre> |
| 655 | </div> |
| 656 | |
| 657 | <div class="method"> |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 658 | <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 659 | <pre>Get a page of OS Config patch deployments. |
| 660 | |
| 661 | Args: |
| 662 | parent: string, Required. The resource name of the parent in the form `projects/*`. (required) |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 663 | pageSize: integer, Optional. The maximum number of patch deployments to return. Default is 100. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 664 | pageToken: string, Optional. A pagination token returned from a previous call to ListPatchDeployments that indicates where this listing should continue from. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 665 | x__xgafv: string, V1 error format. |
| 666 | Allowed values |
| 667 | 1 - v1 error format |
| 668 | 2 - v2 error format |
| 669 | |
| 670 | Returns: |
| 671 | An object of the form: |
| 672 | |
| 673 | { # A response message for listing patch deployments. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 674 | "nextPageToken": "A String", # A pagination token that can be used to get the next page of patch deployments. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 675 | "patchDeployments": [ # The list of patch deployments. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 676 | { # Patch deployments are configurations that individual patch jobs use to complete a patch. These configurations include instance filter, package repository settings, and a schedule. For more information about creating and managing patch deployments, see [Scheduling patch jobs](https://cloud.google.com/compute/docs/os-patch-management/schedule-patch-jobs). |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 677 | "oneTimeSchedule": { # Sets the time for a one time patch deployment. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. # Required. Schedule a one-time execution. |
| 678 | "executeTime": "A String", # Required. The desired patch job execution time. |
| 679 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 680 | "patchConfig": { # Patch configuration specifications. Contains details on how to apply the patch(es) to a VM instance. # Optional. Patch configuration that is applied. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 681 | "windowsUpdate": { # Windows patching is performed using the Windows Update Agent. # Windows update settings. Use this override the default windows patch rules. |
| 682 | "classifications": [ # Only apply updates of these windows update classifications. If empty, all updates are applied. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 683 | "A String", |
| 684 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 685 | "exclusivePatches": [ # An exclusive list of kbs to be updated. These are the only patches that will be updated. This field must not be used with other patch configurations. |
| 686 | "A String", |
| 687 | ], |
| 688 | "excludes": [ # List of KBs to exclude from update. |
| 689 | "A String", |
| 690 | ], |
| 691 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 692 | "preStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run before the patch update. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 693 | "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 694 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. |
| 695 | 42, |
| 696 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 697 | "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. |
| 698 | "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. |
| 699 | "object": "A String", # Required. Name of the Google Cloud Storage object. |
| 700 | "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. |
| 701 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 702 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 703 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 704 | }, |
| 705 | "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob. |
| 706 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. |
| 707 | 42, |
| 708 | ], |
| 709 | "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. |
| 710 | "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. |
| 711 | "object": "A String", # Required. Name of the Google Cloud Storage object. |
| 712 | "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. |
| 713 | }, |
| 714 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| 715 | "localPath": "A String", # An absolute path to the executable on the VM. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 716 | }, |
| 717 | }, |
| 718 | "rebootConfig": "A String", # Post-patch reboot settings. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 719 | "postStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run after the patch update. |
| 720 | "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob. |
| 721 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. |
| 722 | 42, |
| 723 | ], |
| 724 | "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. |
| 725 | "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. |
| 726 | "object": "A String", # Required. Name of the Google Cloud Storage object. |
| 727 | "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. |
| 728 | }, |
| 729 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| 730 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 731 | }, |
| 732 | "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob. |
| 733 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. |
| 734 | 42, |
| 735 | ], |
| 736 | "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable. |
| 737 | "bucket": "A String", # Required. Bucket of the Google Cloud Storage object. |
| 738 | "object": "A String", # Required. Name of the Google Cloud Storage object. |
| 739 | "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. |
| 740 | }, |
| 741 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| 742 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 743 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 744 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 745 | "apt": { # Apt patching is completed by executing `apt-get update && apt-get upgrade`. Additional options can be set to control how this is executed. # Apt update settings. Use this setting to override the default `apt` patch rules. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 746 | "excludes": [ # List of packages to exclude from update. These packages will be excluded |
| 747 | "A String", |
| 748 | ], |
| 749 | "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field cannot be specified with any other patch configuration fields. |
| 750 | "A String", |
| 751 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 752 | "type": "A String", # By changing the type to DIST, the patching is performed using `apt-get dist-upgrade` instead. |
| 753 | }, |
| 754 | "yum": { # Yum patching is performed by executing `yum update`. Additional options can be set to control how this is executed. Note that not all settings are supported on all platforms. # Yum update settings. Use this setting to override the default `yum` patch rules. |
| 755 | "minimal": True or False, # Will cause patch to run `yum update-minimal` instead. |
| 756 | "security": True or False, # Adds the `--security` flag to `yum update`. Not supported on all platforms. |
| 757 | "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field must not be specified with any other patch configuration fields. |
| 758 | "A String", |
| 759 | ], |
| 760 | "excludes": [ # List of packages to exclude from update. These packages are excluded by using the yum `--exclude` flag. |
| 761 | "A String", |
| 762 | ], |
| 763 | }, |
| 764 | "zypper": { # Zypper patching is performed by running `zypper patch`. See also https://en.opensuse.org/SDB:Zypper_manual. # Zypper update settings. Use this setting to override the default `zypper` patch rules. |
| 765 | "withUpdate": True or False, # Adds the `--with-update` flag, to `zypper patch`. |
| 766 | "exclusivePatches": [ # An exclusive list of patches to be updated. These are the only patches that will be installed using 'zypper patch patch:' command. This field must not be used with any other patch configuration fields. |
| 767 | "A String", |
| 768 | ], |
| 769 | "categories": [ # Install only patches with these categories. Common categories include security, recommended, and feature. |
| 770 | "A String", |
| 771 | ], |
| 772 | "excludes": [ # List of patches to exclude from update. |
| 773 | "A String", |
| 774 | ], |
| 775 | "severities": [ # Install only patches with these severities. Common severities include critical, important, moderate, and low. |
| 776 | "A String", |
| 777 | ], |
| 778 | "withOptional": True or False, # Adds the `--with-optional` flag to `zypper patch`. |
| 779 | }, |
| 780 | "goo": { # Googet patching is performed by running `googet update`. # Goo update settings. Use this setting to override the default `goo` patch rules. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 781 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 782 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 783 | "description": "A String", # Optional. Description of the patch deployment. Length of the description is limited to 1024 characters. |
| 784 | "createTime": "A String", # Output only. Time the patch deployment was created. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 785 | "updateTime": "A String", # Output only. Time the patch deployment was last updated. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 786 | "duration": "A String", # Optional. Duration of the patch. After the duration ends, the patch times out. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 787 | "recurringSchedule": { # Sets the time for recurring patch deployments. # Required. Schedule recurring executions. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 788 | "weekly": { # Represents a weekly schedule. # Required. Schedule with weekly executions. |
| 789 | "dayOfWeek": "A String", # Required. Day of the week. |
| 790 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 791 | "timeOfDay": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Time of the day to run a recurring deployment. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 792 | "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| 793 | "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| 794 | "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 795 | "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 796 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 797 | "nextExecuteTime": "A String", # Output only. The time the next patch job is scheduled to run. |
| 798 | "monthly": { # Represents a monthly schedule. An example of a valid monthly schedule is "on the third Tuesday of the month" or "on the 15th of the month". # Required. Schedule with monthly executions. |
| 799 | "weekDayOfMonth": { # Represents one week day in a month. An example is "the 4th Sunday". # Required. Week day in a month. |
| 800 | "dayOfWeek": "A String", # Required. A day of the week. |
| 801 | "weekOrdinal": 42, # Required. Week number in a month. 1-4 indicates the 1st to 4th week of the month. -1 indicates the last week of the month. |
| 802 | }, |
| 803 | "monthDay": 42, # Required. One day of the month. 1-31 indicates the 1st to the 31st day. -1 indicates the last day of the month. Months without the target day will be skipped. For example, a schedule to run "every month on the 31st" will not run in February, April, June, etc. |
| 804 | }, |
| 805 | "startTime": "A String", # Optional. The time that the recurring schedule becomes effective. Defaults to `create_time` of the patch deployment. |
| 806 | "lastExecuteTime": "A String", # Output only. The time the last patch job ran successfully. |
| 807 | "endTime": "A String", # Optional. The end time at which a recurring patch deployment schedule is no longer active. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 808 | "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. Defines the time zone that `time_of_day` is relative to. The rules for daylight saving time are determined by the chosen time zone. |
| 809 | "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a". |
| 810 | "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York". |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 811 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 812 | "frequency": "A String", # Required. The frequency unit of this recurring schedule. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 813 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 814 | "lastExecuteTime": "A String", # Output only. The last time a patch job was started by this deployment. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 815 | "rollout": { # Patch rollout configuration specifications. Contains details on the concurrency control when applying patch(es) to all targeted VMs. # Optional. Rollout strategy of the patch job. |
| 816 | "mode": "A String", # Mode of the patch rollout. |
| 817 | "disruptionBudget": { # Message encapsulating a value that can be either absolute ("fixed") or relative ("percent") to a value. # The maximum number (or percentage) of VMs per zone to disrupt at any given moment. The number of VMs calculated from multiplying the percentage by the total number of VMs in a zone is rounded up. During patching, a VM is considered disrupted from the time the agent is notified to begin until patching has completed. This disruption time includes the time to complete reboot and any post-patch steps. A VM contributes to the disruption budget if its patching operation fails either when applying the patches, running pre or post patch steps, or if it fails to respond with a success notification before timing out. VMs that are not running or do not have an active agent do not count toward this disruption budget. For zone-by-zone rollouts, if the disruption budget in a zone is exceeded, the patch job stops, because continuing to the next zone requires completion of the patch process in the previous zone. For example, if the disruption budget has a fixed value of `10`, and 8 VMs fail to patch in the current zone, the patch job continues to patch 2 VMs at a time until the zone is completed. When that zone is completed successfully, patching begins with 10 VMs at a time in the next zone. If 10 VMs in the next zone fail to patch, the patch job stops. |
| 818 | "fixed": 42, # Specifies a fixed value. |
| 819 | "percent": 42, # Specifies the relative value defined as a percentage, which will be multiplied by a reference value. |
| 820 | }, |
| 821 | }, |
| 822 | "name": "A String", # Unique name for the patch deployment resource in a project. The patch deployment name is in the form: `projects/{project_id}/patchDeployments/{patch_deployment_id}`. This field is ignored when you create a new patch deployment. |
| 823 | "instanceFilter": { # A filter to target VM instances for patching. The targeted VMs must meet all criteria specified. So if both labels and zones are specified, the patch job targets only VMs with those labels and in those zones. # Required. VM instances to patch. |
| 824 | "zones": [ # Targets VM instances in ANY of these zones. Leave empty to target VM instances in any zone. |
| 825 | "A String", |
| 826 | ], |
| 827 | "instanceNamePrefixes": [ # Targets VMs whose name starts with one of these prefixes. Similar to labels, this is another way to group VMs when targeting configs, for example prefix="prod-". |
| 828 | "A String", |
| 829 | ], |
| 830 | "all": True or False, # Target all VM instances in the project. If true, no other criteria is permitted. |
| 831 | "instances": [ # Targets any of the VM instances specified. Instances are specified by their URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME]`, `projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`, or `https://www.googleapis.com/compute/v1/projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]` |
| 832 | "A String", |
| 833 | ], |
| 834 | "groupLabels": [ # Targets VM instances matching at least one of these label sets. This allows targeting of disparate groups, for example "env=prod or env=staging". |
| 835 | { # Represents a group of VMs that can be identified as having all these labels, for example "env=prod and app=web". |
| 836 | "labels": { # Compute Engine instance labels that must be present for a VM instance to be targeted by this filter. |
| 837 | "a_key": "A String", |
| 838 | }, |
| 839 | }, |
| 840 | ], |
| 841 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 842 | }, |
| 843 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 844 | }</pre> |
| 845 | </div> |
| 846 | |
| 847 | <div class="method"> |
| 848 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 849 | <pre>Retrieves the next page of results. |
| 850 | |
| 851 | Args: |
| 852 | previous_request: The request for the previous page. (required) |
| 853 | previous_response: The response from the request for the previous page. (required) |
| 854 | |
| 855 | Returns: |
| 856 | A request object that you can call 'execute()' on to request the next |
| 857 | page. Returns None if there are no more items in the collection. |
| 858 | </pre> |
| 859 | </div> |
| 860 | |
| 861 | </body></html> |