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