chore: update generated docs (#1115)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/2ed9ab0e-55b4-4ab2-aede-c95e765f7376/targets
- [x] To automatically regenerate this PR, check this box.
Source-Link: https://github.com/googleapis/discovery-artifact-manager/commit/0bed8bdae25d545e796cfcdd7a9bfffff11e69da
Source-Link: https://github.com/googleapis/synthtool/commit/c2de32114ec484aa708d32012d1fa8d75232daf5
diff --git a/docs/dyn/osconfig_v1.projects.patchDeployments.html b/docs/dyn/osconfig_v1.projects.patchDeployments.html
index 0ac0e63..e29bed1 100644
--- a/docs/dyn/osconfig_v1.projects.patchDeployments.html
+++ b/docs/dyn/osconfig_v1.projects.patchDeployments.html
@@ -108,21 +108,8 @@
The object takes the form of:
{ # 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).
- "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.
- "mode": "A String", # Mode of the patch rollout.
- "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.
- "fixed": 42, # Specifies a fixed value.
- "percent": 42, # Specifies the relative value defined as a percentage, which will be multiplied by a reference value.
- },
- },
- "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.
- "createTime": "A String", # Output only. Time the patch deployment was created. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
- "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.
- "description": "A String", # Optional. Description of the patch deployment. Length of the description is limited to 1024 characters.
- "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.
- "executeTime": "A String", # Required. The desired patch job execution time.
- },
"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.
+ "all": True or False, # Target all VM instances in the project. If true, no other criteria is permitted.
"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]`
"A String",
],
@@ -139,47 +126,139 @@
},
},
],
- "all": True or False, # Target all VM instances in the project. If true, no other criteria is permitted.
},
- "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.
- "duration": "A String", # Optional. Duration of the patch. After the duration ends, the patch times out.
+ "description": "A String", # Optional. Description of the patch deployment. Length of the description is limited to 1024 characters.
+ "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.
+ "mode": "A String", # Mode of the patch rollout.
+ "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.
+ "percent": 42, # Specifies the relative value defined as a percentage, which will be multiplied by a reference value.
+ "fixed": 42, # Specifies a fixed value.
+ },
+ },
+ "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.
+ "executeTime": "A String", # Required. The desired patch job execution time.
+ },
"recurringSchedule": { # Sets the time for recurring patch deployments. # Required. Schedule recurring executions.
- "nextExecuteTime": "A String", # Output only. The time the next patch job is scheduled to run.
- "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.
- "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
- "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
- "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.
- "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.
- },
"lastExecuteTime": "A String", # Output only. The time the last patch job ran successfully.
- "frequency": "A String", # Required. The frequency unit of this recurring schedule.
- "startTime": "A String", # Optional. The time that the recurring schedule becomes effective. Defaults to `create_time` of the patch deployment.
- "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.
- "weekDayOfMonth": { # Represents one week day in a month. An example is "the 4th Sunday". # Required. Week day in a month.
- "dayOfWeek": "A String", # Required. A day of the week.
- "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.
- },
- "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.
- },
"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.
"version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
"id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
},
+ "endTime": "A String", # Optional. The end time at which a recurring patch deployment schedule is no longer active.
+ "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.
+ "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.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "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.
+ },
+ "nextExecuteTime": "A String", # Output only. The time the next patch job is scheduled to run.
+ "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.
+ "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.
+ "weekDayOfMonth": { # Represents one week day in a month. An example is "the 4th Sunday". # Required. Week day in a month.
+ "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.
+ "dayOfWeek": "A String", # Required. A day of the week.
+ },
+ },
"weekly": { # Represents a weekly schedule. # Required. Schedule with weekly executions.
"dayOfWeek": "A String", # Required. Day of the week.
},
- "endTime": "A String", # Optional. The end time at which a recurring patch deployment schedule is no longer active.
+ "frequency": "A String", # Required. The frequency unit of this recurring schedule.
+ "startTime": "A String", # Optional. The time that the recurring schedule becomes effective. Defaults to `create_time` of the patch deployment.
},
+ "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.
+ "createTime": "A String", # Output only. Time the patch deployment was created. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+ "duration": "A String", # Optional. Duration of the patch. After the duration ends, the patch times out.
+ "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.
"patchConfig": { # Patch configuration specifications. Contains details on how to apply the patch(es) to a VM instance. # Optional. Patch configuration that is applied.
- "rebootConfig": "A String", # Post-patch reboot settings.
- "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.
- "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.
+ "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.
+ "excludes": [ # List of patches to exclude from update.
"A String",
],
+ "categories": [ # Install only patches with these categories. Common categories include security, recommended, and feature.
+ "A String",
+ ],
+ "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.
+ "A String",
+ ],
+ "withUpdate": True or False, # Adds the `--with-update` flag, to `zypper patch`.
+ "withOptional": True or False, # Adds the `--with-optional` flag to `zypper patch`.
+ "severities": [ # Install only patches with these severities. Common severities include critical, important, moderate, and low.
+ "A String",
+ ],
+ },
+ "goo": { # Googet patching is performed by running `googet update`. # Goo update settings. Use this setting to override the default `goo` patch rules.
+ },
+ "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.
"excludes": [ # List of packages to exclude from update. These packages will be excluded
"A String",
],
"type": "A String", # By changing the type to DIST, the patching is performed using `apt-get dist-upgrade` instead.
+ "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.
+ "A String",
+ ],
+ },
+ "postStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run after the patch update.
+ "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob.
+ "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\)).
+ "localPath": "A String", # An absolute path to the executable on the VM.
+ "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
+ 42,
+ ],
+ "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
+ "bucket": "A String", # Required. Bucket of the Cloud Storage object.
+ "object": "A String", # Required. Name of the Cloud Storage object.
+ "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
+ },
+ },
+ "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob.
+ "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\)).
+ "localPath": "A String", # An absolute path to the executable on the VM.
+ "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
+ 42,
+ ],
+ "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
+ "bucket": "A String", # Required. Bucket of the Cloud Storage object.
+ "object": "A String", # Required. Name of the Cloud Storage object.
+ "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
+ },
+ },
+ },
+ "rebootConfig": "A String", # Post-patch reboot settings.
+ "preStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run before the patch update.
+ "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob.
+ "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\)).
+ "localPath": "A String", # An absolute path to the executable on the VM.
+ "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
+ 42,
+ ],
+ "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
+ "bucket": "A String", # Required. Bucket of the Cloud Storage object.
+ "object": "A String", # Required. Name of the Cloud Storage object.
+ "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
+ },
+ },
+ "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob.
+ "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\)).
+ "localPath": "A String", # An absolute path to the executable on the VM.
+ "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
+ 42,
+ ],
+ "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
+ "bucket": "A String", # Required. Bucket of the Cloud Storage object.
+ "object": "A String", # Required. Name of the Cloud Storage object.
+ "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
+ },
+ },
+ },
+ "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.
+ "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.
+ "A String",
+ ],
+ "security": True or False, # Adds the `--security` flag to `yum update`. Not supported on all platforms.
+ "minimal": True or False, # Will cause patch to run `yum update-minimal` instead.
+ "excludes": [ # List of packages to exclude from update. These packages are excluded by using the yum `--exclude` flag.
+ "A String",
+ ],
},
"windowsUpdate": { # Windows patching is performed using the Windows Update Agent. # Windows update settings. Use this override the default windows patch rules.
"classifications": [ # Only apply updates of these windows update classifications. If empty, all updates are applied.
@@ -192,87 +271,8 @@
"A String",
],
},
- "postStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run after the patch update.
- "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob.
- "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
- "bucket": "A String", # Required. Bucket of the Cloud Storage object.
- "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
- "object": "A String", # Required. Name of the Cloud Storage object.
- },
- "localPath": "A String", # An absolute path to the executable on the VM.
- "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
- 42,
- ],
- "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\)).
- },
- "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob.
- "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
- "bucket": "A String", # Required. Bucket of the Cloud Storage object.
- "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
- "object": "A String", # Required. Name of the Cloud Storage object.
- },
- "localPath": "A String", # An absolute path to the executable on the VM.
- "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
- 42,
- ],
- "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\)).
- },
- },
- "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.
- "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.
- "A String",
- ],
- "withOptional": True or False, # Adds the `--with-optional` flag to `zypper patch`.
- "severities": [ # Install only patches with these severities. Common severities include critical, important, moderate, and low.
- "A String",
- ],
- "categories": [ # Install only patches with these categories. Common categories include security, recommended, and feature.
- "A String",
- ],
- "withUpdate": True or False, # Adds the `--with-update` flag, to `zypper patch`.
- "excludes": [ # List of patches to exclude from update.
- "A String",
- ],
- },
- "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.
- "security": True or False, # Adds the `--security` flag to `yum update`. Not supported on all platforms.
- "excludes": [ # List of packages to exclude from update. These packages are excluded by using the yum `--exclude` flag.
- "A String",
- ],
- "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.
- "A String",
- ],
- "minimal": True or False, # Will cause patch to run `yum update-minimal` instead.
- },
- "preStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run before the patch update.
- "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob.
- "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
- "bucket": "A String", # Required. Bucket of the Cloud Storage object.
- "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
- "object": "A String", # Required. Name of the Cloud Storage object.
- },
- "localPath": "A String", # An absolute path to the executable on the VM.
- "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
- 42,
- ],
- "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\)).
- },
- "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob.
- "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
- "bucket": "A String", # Required. Bucket of the Cloud Storage object.
- "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
- "object": "A String", # Required. Name of the Cloud Storage object.
- },
- "localPath": "A String", # An absolute path to the executable on the VM.
- "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
- 42,
- ],
- "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\)).
- },
- },
- "goo": { # Googet patching is performed by running `googet update`. # Goo update settings. Use this setting to override the default `goo` patch rules.
- },
},
+ "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.
}
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.
@@ -285,21 +285,8 @@
An object of the form:
{ # 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).
- "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.
- "mode": "A String", # Mode of the patch rollout.
- "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.
- "fixed": 42, # Specifies a fixed value.
- "percent": 42, # Specifies the relative value defined as a percentage, which will be multiplied by a reference value.
- },
- },
- "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.
- "createTime": "A String", # Output only. Time the patch deployment was created. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
- "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.
- "description": "A String", # Optional. Description of the patch deployment. Length of the description is limited to 1024 characters.
- "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.
- "executeTime": "A String", # Required. The desired patch job execution time.
- },
"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.
+ "all": True or False, # Target all VM instances in the project. If true, no other criteria is permitted.
"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]`
"A String",
],
@@ -316,47 +303,139 @@
},
},
],
- "all": True or False, # Target all VM instances in the project. If true, no other criteria is permitted.
},
- "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.
- "duration": "A String", # Optional. Duration of the patch. After the duration ends, the patch times out.
+ "description": "A String", # Optional. Description of the patch deployment. Length of the description is limited to 1024 characters.
+ "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.
+ "mode": "A String", # Mode of the patch rollout.
+ "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.
+ "percent": 42, # Specifies the relative value defined as a percentage, which will be multiplied by a reference value.
+ "fixed": 42, # Specifies a fixed value.
+ },
+ },
+ "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.
+ "executeTime": "A String", # Required. The desired patch job execution time.
+ },
"recurringSchedule": { # Sets the time for recurring patch deployments. # Required. Schedule recurring executions.
- "nextExecuteTime": "A String", # Output only. The time the next patch job is scheduled to run.
- "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.
- "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
- "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
- "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.
- "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.
- },
"lastExecuteTime": "A String", # Output only. The time the last patch job ran successfully.
- "frequency": "A String", # Required. The frequency unit of this recurring schedule.
- "startTime": "A String", # Optional. The time that the recurring schedule becomes effective. Defaults to `create_time` of the patch deployment.
- "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.
- "weekDayOfMonth": { # Represents one week day in a month. An example is "the 4th Sunday". # Required. Week day in a month.
- "dayOfWeek": "A String", # Required. A day of the week.
- "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.
- },
- "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.
- },
"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.
"version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
"id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
},
+ "endTime": "A String", # Optional. The end time at which a recurring patch deployment schedule is no longer active.
+ "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.
+ "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.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "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.
+ },
+ "nextExecuteTime": "A String", # Output only. The time the next patch job is scheduled to run.
+ "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.
+ "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.
+ "weekDayOfMonth": { # Represents one week day in a month. An example is "the 4th Sunday". # Required. Week day in a month.
+ "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.
+ "dayOfWeek": "A String", # Required. A day of the week.
+ },
+ },
"weekly": { # Represents a weekly schedule. # Required. Schedule with weekly executions.
"dayOfWeek": "A String", # Required. Day of the week.
},
- "endTime": "A String", # Optional. The end time at which a recurring patch deployment schedule is no longer active.
+ "frequency": "A String", # Required. The frequency unit of this recurring schedule.
+ "startTime": "A String", # Optional. The time that the recurring schedule becomes effective. Defaults to `create_time` of the patch deployment.
},
+ "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.
+ "createTime": "A String", # Output only. Time the patch deployment was created. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+ "duration": "A String", # Optional. Duration of the patch. After the duration ends, the patch times out.
+ "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.
"patchConfig": { # Patch configuration specifications. Contains details on how to apply the patch(es) to a VM instance. # Optional. Patch configuration that is applied.
- "rebootConfig": "A String", # Post-patch reboot settings.
- "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.
- "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.
+ "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.
+ "excludes": [ # List of patches to exclude from update.
"A String",
],
+ "categories": [ # Install only patches with these categories. Common categories include security, recommended, and feature.
+ "A String",
+ ],
+ "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.
+ "A String",
+ ],
+ "withUpdate": True or False, # Adds the `--with-update` flag, to `zypper patch`.
+ "withOptional": True or False, # Adds the `--with-optional` flag to `zypper patch`.
+ "severities": [ # Install only patches with these severities. Common severities include critical, important, moderate, and low.
+ "A String",
+ ],
+ },
+ "goo": { # Googet patching is performed by running `googet update`. # Goo update settings. Use this setting to override the default `goo` patch rules.
+ },
+ "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.
"excludes": [ # List of packages to exclude from update. These packages will be excluded
"A String",
],
"type": "A String", # By changing the type to DIST, the patching is performed using `apt-get dist-upgrade` instead.
+ "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.
+ "A String",
+ ],
+ },
+ "postStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run after the patch update.
+ "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob.
+ "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\)).
+ "localPath": "A String", # An absolute path to the executable on the VM.
+ "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
+ 42,
+ ],
+ "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
+ "bucket": "A String", # Required. Bucket of the Cloud Storage object.
+ "object": "A String", # Required. Name of the Cloud Storage object.
+ "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
+ },
+ },
+ "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob.
+ "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\)).
+ "localPath": "A String", # An absolute path to the executable on the VM.
+ "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
+ 42,
+ ],
+ "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
+ "bucket": "A String", # Required. Bucket of the Cloud Storage object.
+ "object": "A String", # Required. Name of the Cloud Storage object.
+ "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
+ },
+ },
+ },
+ "rebootConfig": "A String", # Post-patch reboot settings.
+ "preStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run before the patch update.
+ "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob.
+ "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\)).
+ "localPath": "A String", # An absolute path to the executable on the VM.
+ "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
+ 42,
+ ],
+ "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
+ "bucket": "A String", # Required. Bucket of the Cloud Storage object.
+ "object": "A String", # Required. Name of the Cloud Storage object.
+ "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
+ },
+ },
+ "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob.
+ "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\)).
+ "localPath": "A String", # An absolute path to the executable on the VM.
+ "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
+ 42,
+ ],
+ "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
+ "bucket": "A String", # Required. Bucket of the Cloud Storage object.
+ "object": "A String", # Required. Name of the Cloud Storage object.
+ "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
+ },
+ },
+ },
+ "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.
+ "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.
+ "A String",
+ ],
+ "security": True or False, # Adds the `--security` flag to `yum update`. Not supported on all platforms.
+ "minimal": True or False, # Will cause patch to run `yum update-minimal` instead.
+ "excludes": [ # List of packages to exclude from update. These packages are excluded by using the yum `--exclude` flag.
+ "A String",
+ ],
},
"windowsUpdate": { # Windows patching is performed using the Windows Update Agent. # Windows update settings. Use this override the default windows patch rules.
"classifications": [ # Only apply updates of these windows update classifications. If empty, all updates are applied.
@@ -369,87 +448,8 @@
"A String",
],
},
- "postStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run after the patch update.
- "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob.
- "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
- "bucket": "A String", # Required. Bucket of the Cloud Storage object.
- "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
- "object": "A String", # Required. Name of the Cloud Storage object.
- },
- "localPath": "A String", # An absolute path to the executable on the VM.
- "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
- 42,
- ],
- "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\)).
- },
- "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob.
- "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
- "bucket": "A String", # Required. Bucket of the Cloud Storage object.
- "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
- "object": "A String", # Required. Name of the Cloud Storage object.
- },
- "localPath": "A String", # An absolute path to the executable on the VM.
- "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
- 42,
- ],
- "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\)).
- },
- },
- "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.
- "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.
- "A String",
- ],
- "withOptional": True or False, # Adds the `--with-optional` flag to `zypper patch`.
- "severities": [ # Install only patches with these severities. Common severities include critical, important, moderate, and low.
- "A String",
- ],
- "categories": [ # Install only patches with these categories. Common categories include security, recommended, and feature.
- "A String",
- ],
- "withUpdate": True or False, # Adds the `--with-update` flag, to `zypper patch`.
- "excludes": [ # List of patches to exclude from update.
- "A String",
- ],
- },
- "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.
- "security": True or False, # Adds the `--security` flag to `yum update`. Not supported on all platforms.
- "excludes": [ # List of packages to exclude from update. These packages are excluded by using the yum `--exclude` flag.
- "A String",
- ],
- "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.
- "A String",
- ],
- "minimal": True or False, # Will cause patch to run `yum update-minimal` instead.
- },
- "preStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run before the patch update.
- "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob.
- "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
- "bucket": "A String", # Required. Bucket of the Cloud Storage object.
- "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
- "object": "A String", # Required. Name of the Cloud Storage object.
- },
- "localPath": "A String", # An absolute path to the executable on the VM.
- "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
- 42,
- ],
- "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\)).
- },
- "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob.
- "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
- "bucket": "A String", # Required. Bucket of the Cloud Storage object.
- "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
- "object": "A String", # Required. Name of the Cloud Storage object.
- },
- "localPath": "A String", # An absolute path to the executable on the VM.
- "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
- 42,
- ],
- "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\)).
- },
- },
- "goo": { # Googet patching is performed by running `googet update`. # Goo update settings. Use this setting to override the default `goo` patch rules.
- },
},
+ "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.
}</pre>
</div>
@@ -486,21 +486,8 @@
An object of the form:
{ # 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).
- "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.
- "mode": "A String", # Mode of the patch rollout.
- "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.
- "fixed": 42, # Specifies a fixed value.
- "percent": 42, # Specifies the relative value defined as a percentage, which will be multiplied by a reference value.
- },
- },
- "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.
- "createTime": "A String", # Output only. Time the patch deployment was created. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
- "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.
- "description": "A String", # Optional. Description of the patch deployment. Length of the description is limited to 1024 characters.
- "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.
- "executeTime": "A String", # Required. The desired patch job execution time.
- },
"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.
+ "all": True or False, # Target all VM instances in the project. If true, no other criteria is permitted.
"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]`
"A String",
],
@@ -517,47 +504,139 @@
},
},
],
- "all": True or False, # Target all VM instances in the project. If true, no other criteria is permitted.
},
- "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.
- "duration": "A String", # Optional. Duration of the patch. After the duration ends, the patch times out.
+ "description": "A String", # Optional. Description of the patch deployment. Length of the description is limited to 1024 characters.
+ "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.
+ "mode": "A String", # Mode of the patch rollout.
+ "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.
+ "percent": 42, # Specifies the relative value defined as a percentage, which will be multiplied by a reference value.
+ "fixed": 42, # Specifies a fixed value.
+ },
+ },
+ "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.
+ "executeTime": "A String", # Required. The desired patch job execution time.
+ },
"recurringSchedule": { # Sets the time for recurring patch deployments. # Required. Schedule recurring executions.
- "nextExecuteTime": "A String", # Output only. The time the next patch job is scheduled to run.
- "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.
- "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
- "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
- "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.
- "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.
- },
"lastExecuteTime": "A String", # Output only. The time the last patch job ran successfully.
- "frequency": "A String", # Required. The frequency unit of this recurring schedule.
- "startTime": "A String", # Optional. The time that the recurring schedule becomes effective. Defaults to `create_time` of the patch deployment.
- "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.
- "weekDayOfMonth": { # Represents one week day in a month. An example is "the 4th Sunday". # Required. Week day in a month.
- "dayOfWeek": "A String", # Required. A day of the week.
- "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.
- },
- "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.
- },
"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.
"version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
"id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
},
+ "endTime": "A String", # Optional. The end time at which a recurring patch deployment schedule is no longer active.
+ "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.
+ "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.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "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.
+ },
+ "nextExecuteTime": "A String", # Output only. The time the next patch job is scheduled to run.
+ "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.
+ "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.
+ "weekDayOfMonth": { # Represents one week day in a month. An example is "the 4th Sunday". # Required. Week day in a month.
+ "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.
+ "dayOfWeek": "A String", # Required. A day of the week.
+ },
+ },
"weekly": { # Represents a weekly schedule. # Required. Schedule with weekly executions.
"dayOfWeek": "A String", # Required. Day of the week.
},
- "endTime": "A String", # Optional. The end time at which a recurring patch deployment schedule is no longer active.
+ "frequency": "A String", # Required. The frequency unit of this recurring schedule.
+ "startTime": "A String", # Optional. The time that the recurring schedule becomes effective. Defaults to `create_time` of the patch deployment.
},
+ "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.
+ "createTime": "A String", # Output only. Time the patch deployment was created. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+ "duration": "A String", # Optional. Duration of the patch. After the duration ends, the patch times out.
+ "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.
"patchConfig": { # Patch configuration specifications. Contains details on how to apply the patch(es) to a VM instance. # Optional. Patch configuration that is applied.
- "rebootConfig": "A String", # Post-patch reboot settings.
- "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.
- "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.
+ "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.
+ "excludes": [ # List of patches to exclude from update.
"A String",
],
+ "categories": [ # Install only patches with these categories. Common categories include security, recommended, and feature.
+ "A String",
+ ],
+ "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.
+ "A String",
+ ],
+ "withUpdate": True or False, # Adds the `--with-update` flag, to `zypper patch`.
+ "withOptional": True or False, # Adds the `--with-optional` flag to `zypper patch`.
+ "severities": [ # Install only patches with these severities. Common severities include critical, important, moderate, and low.
+ "A String",
+ ],
+ },
+ "goo": { # Googet patching is performed by running `googet update`. # Goo update settings. Use this setting to override the default `goo` patch rules.
+ },
+ "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.
"excludes": [ # List of packages to exclude from update. These packages will be excluded
"A String",
],
"type": "A String", # By changing the type to DIST, the patching is performed using `apt-get dist-upgrade` instead.
+ "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.
+ "A String",
+ ],
+ },
+ "postStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run after the patch update.
+ "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob.
+ "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\)).
+ "localPath": "A String", # An absolute path to the executable on the VM.
+ "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
+ 42,
+ ],
+ "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
+ "bucket": "A String", # Required. Bucket of the Cloud Storage object.
+ "object": "A String", # Required. Name of the Cloud Storage object.
+ "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
+ },
+ },
+ "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob.
+ "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\)).
+ "localPath": "A String", # An absolute path to the executable on the VM.
+ "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
+ 42,
+ ],
+ "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
+ "bucket": "A String", # Required. Bucket of the Cloud Storage object.
+ "object": "A String", # Required. Name of the Cloud Storage object.
+ "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
+ },
+ },
+ },
+ "rebootConfig": "A String", # Post-patch reboot settings.
+ "preStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run before the patch update.
+ "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob.
+ "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\)).
+ "localPath": "A String", # An absolute path to the executable on the VM.
+ "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
+ 42,
+ ],
+ "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
+ "bucket": "A String", # Required. Bucket of the Cloud Storage object.
+ "object": "A String", # Required. Name of the Cloud Storage object.
+ "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
+ },
+ },
+ "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob.
+ "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\)).
+ "localPath": "A String", # An absolute path to the executable on the VM.
+ "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
+ 42,
+ ],
+ "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
+ "bucket": "A String", # Required. Bucket of the Cloud Storage object.
+ "object": "A String", # Required. Name of the Cloud Storage object.
+ "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
+ },
+ },
+ },
+ "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.
+ "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.
+ "A String",
+ ],
+ "security": True or False, # Adds the `--security` flag to `yum update`. Not supported on all platforms.
+ "minimal": True or False, # Will cause patch to run `yum update-minimal` instead.
+ "excludes": [ # List of packages to exclude from update. These packages are excluded by using the yum `--exclude` flag.
+ "A String",
+ ],
},
"windowsUpdate": { # Windows patching is performed using the Windows Update Agent. # Windows update settings. Use this override the default windows patch rules.
"classifications": [ # Only apply updates of these windows update classifications. If empty, all updates are applied.
@@ -570,87 +649,8 @@
"A String",
],
},
- "postStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run after the patch update.
- "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob.
- "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
- "bucket": "A String", # Required. Bucket of the Cloud Storage object.
- "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
- "object": "A String", # Required. Name of the Cloud Storage object.
- },
- "localPath": "A String", # An absolute path to the executable on the VM.
- "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
- 42,
- ],
- "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\)).
- },
- "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob.
- "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
- "bucket": "A String", # Required. Bucket of the Cloud Storage object.
- "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
- "object": "A String", # Required. Name of the Cloud Storage object.
- },
- "localPath": "A String", # An absolute path to the executable on the VM.
- "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
- 42,
- ],
- "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\)).
- },
- },
- "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.
- "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.
- "A String",
- ],
- "withOptional": True or False, # Adds the `--with-optional` flag to `zypper patch`.
- "severities": [ # Install only patches with these severities. Common severities include critical, important, moderate, and low.
- "A String",
- ],
- "categories": [ # Install only patches with these categories. Common categories include security, recommended, and feature.
- "A String",
- ],
- "withUpdate": True or False, # Adds the `--with-update` flag, to `zypper patch`.
- "excludes": [ # List of patches to exclude from update.
- "A String",
- ],
- },
- "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.
- "security": True or False, # Adds the `--security` flag to `yum update`. Not supported on all platforms.
- "excludes": [ # List of packages to exclude from update. These packages are excluded by using the yum `--exclude` flag.
- "A String",
- ],
- "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.
- "A String",
- ],
- "minimal": True or False, # Will cause patch to run `yum update-minimal` instead.
- },
- "preStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run before the patch update.
- "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob.
- "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
- "bucket": "A String", # Required. Bucket of the Cloud Storage object.
- "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
- "object": "A String", # Required. Name of the Cloud Storage object.
- },
- "localPath": "A String", # An absolute path to the executable on the VM.
- "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
- 42,
- ],
- "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\)).
- },
- "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob.
- "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
- "bucket": "A String", # Required. Bucket of the Cloud Storage object.
- "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
- "object": "A String", # Required. Name of the Cloud Storage object.
- },
- "localPath": "A String", # An absolute path to the executable on the VM.
- "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
- 42,
- ],
- "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\)).
- },
- },
- "goo": { # Googet patching is performed by running `googet update`. # Goo update settings. Use this setting to override the default `goo` patch rules.
- },
},
+ "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.
}</pre>
</div>
@@ -671,24 +671,10 @@
An object of the form:
{ # A response message for listing patch deployments.
- "nextPageToken": "A String", # A pagination token that can be used to get the next page of patch deployments.
"patchDeployments": [ # The list of patch deployments.
{ # 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).
- "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.
- "mode": "A String", # Mode of the patch rollout.
- "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.
- "fixed": 42, # Specifies a fixed value.
- "percent": 42, # Specifies the relative value defined as a percentage, which will be multiplied by a reference value.
- },
- },
- "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.
- "createTime": "A String", # Output only. Time the patch deployment was created. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
- "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.
- "description": "A String", # Optional. Description of the patch deployment. Length of the description is limited to 1024 characters.
- "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.
- "executeTime": "A String", # Required. The desired patch job execution time.
- },
"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.
+ "all": True or False, # Target all VM instances in the project. If true, no other criteria is permitted.
"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]`
"A String",
],
@@ -705,47 +691,139 @@
},
},
],
- "all": True or False, # Target all VM instances in the project. If true, no other criteria is permitted.
},
- "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.
- "duration": "A String", # Optional. Duration of the patch. After the duration ends, the patch times out.
+ "description": "A String", # Optional. Description of the patch deployment. Length of the description is limited to 1024 characters.
+ "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.
+ "mode": "A String", # Mode of the patch rollout.
+ "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.
+ "percent": 42, # Specifies the relative value defined as a percentage, which will be multiplied by a reference value.
+ "fixed": 42, # Specifies a fixed value.
+ },
+ },
+ "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.
+ "executeTime": "A String", # Required. The desired patch job execution time.
+ },
"recurringSchedule": { # Sets the time for recurring patch deployments. # Required. Schedule recurring executions.
- "nextExecuteTime": "A String", # Output only. The time the next patch job is scheduled to run.
- "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.
- "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
- "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
- "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.
- "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.
- },
"lastExecuteTime": "A String", # Output only. The time the last patch job ran successfully.
- "frequency": "A String", # Required. The frequency unit of this recurring schedule.
- "startTime": "A String", # Optional. The time that the recurring schedule becomes effective. Defaults to `create_time` of the patch deployment.
- "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.
- "weekDayOfMonth": { # Represents one week day in a month. An example is "the 4th Sunday". # Required. Week day in a month.
- "dayOfWeek": "A String", # Required. A day of the week.
- "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.
- },
- "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.
- },
"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.
"version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
"id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
},
+ "endTime": "A String", # Optional. The end time at which a recurring patch deployment schedule is no longer active.
+ "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.
+ "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.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "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.
+ },
+ "nextExecuteTime": "A String", # Output only. The time the next patch job is scheduled to run.
+ "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.
+ "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.
+ "weekDayOfMonth": { # Represents one week day in a month. An example is "the 4th Sunday". # Required. Week day in a month.
+ "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.
+ "dayOfWeek": "A String", # Required. A day of the week.
+ },
+ },
"weekly": { # Represents a weekly schedule. # Required. Schedule with weekly executions.
"dayOfWeek": "A String", # Required. Day of the week.
},
- "endTime": "A String", # Optional. The end time at which a recurring patch deployment schedule is no longer active.
+ "frequency": "A String", # Required. The frequency unit of this recurring schedule.
+ "startTime": "A String", # Optional. The time that the recurring schedule becomes effective. Defaults to `create_time` of the patch deployment.
},
+ "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.
+ "createTime": "A String", # Output only. Time the patch deployment was created. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+ "duration": "A String", # Optional. Duration of the patch. After the duration ends, the patch times out.
+ "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.
"patchConfig": { # Patch configuration specifications. Contains details on how to apply the patch(es) to a VM instance. # Optional. Patch configuration that is applied.
- "rebootConfig": "A String", # Post-patch reboot settings.
- "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.
- "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.
+ "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.
+ "excludes": [ # List of patches to exclude from update.
"A String",
],
+ "categories": [ # Install only patches with these categories. Common categories include security, recommended, and feature.
+ "A String",
+ ],
+ "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.
+ "A String",
+ ],
+ "withUpdate": True or False, # Adds the `--with-update` flag, to `zypper patch`.
+ "withOptional": True or False, # Adds the `--with-optional` flag to `zypper patch`.
+ "severities": [ # Install only patches with these severities. Common severities include critical, important, moderate, and low.
+ "A String",
+ ],
+ },
+ "goo": { # Googet patching is performed by running `googet update`. # Goo update settings. Use this setting to override the default `goo` patch rules.
+ },
+ "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.
"excludes": [ # List of packages to exclude from update. These packages will be excluded
"A String",
],
"type": "A String", # By changing the type to DIST, the patching is performed using `apt-get dist-upgrade` instead.
+ "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.
+ "A String",
+ ],
+ },
+ "postStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run after the patch update.
+ "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob.
+ "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\)).
+ "localPath": "A String", # An absolute path to the executable on the VM.
+ "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
+ 42,
+ ],
+ "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
+ "bucket": "A String", # Required. Bucket of the Cloud Storage object.
+ "object": "A String", # Required. Name of the Cloud Storage object.
+ "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
+ },
+ },
+ "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob.
+ "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\)).
+ "localPath": "A String", # An absolute path to the executable on the VM.
+ "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
+ 42,
+ ],
+ "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
+ "bucket": "A String", # Required. Bucket of the Cloud Storage object.
+ "object": "A String", # Required. Name of the Cloud Storage object.
+ "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
+ },
+ },
+ },
+ "rebootConfig": "A String", # Post-patch reboot settings.
+ "preStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run before the patch update.
+ "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob.
+ "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\)).
+ "localPath": "A String", # An absolute path to the executable on the VM.
+ "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
+ 42,
+ ],
+ "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
+ "bucket": "A String", # Required. Bucket of the Cloud Storage object.
+ "object": "A String", # Required. Name of the Cloud Storage object.
+ "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
+ },
+ },
+ "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob.
+ "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\)).
+ "localPath": "A String", # An absolute path to the executable on the VM.
+ "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
+ 42,
+ ],
+ "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
+ "bucket": "A String", # Required. Bucket of the Cloud Storage object.
+ "object": "A String", # Required. Name of the Cloud Storage object.
+ "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
+ },
+ },
+ },
+ "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.
+ "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.
+ "A String",
+ ],
+ "security": True or False, # Adds the `--security` flag to `yum update`. Not supported on all platforms.
+ "minimal": True or False, # Will cause patch to run `yum update-minimal` instead.
+ "excludes": [ # List of packages to exclude from update. These packages are excluded by using the yum `--exclude` flag.
+ "A String",
+ ],
},
"windowsUpdate": { # Windows patching is performed using the Windows Update Agent. # Windows update settings. Use this override the default windows patch rules.
"classifications": [ # Only apply updates of these windows update classifications. If empty, all updates are applied.
@@ -758,89 +836,11 @@
"A String",
],
},
- "postStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run after the patch update.
- "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob.
- "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
- "bucket": "A String", # Required. Bucket of the Cloud Storage object.
- "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
- "object": "A String", # Required. Name of the Cloud Storage object.
- },
- "localPath": "A String", # An absolute path to the executable on the VM.
- "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
- 42,
- ],
- "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\)).
- },
- "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob.
- "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
- "bucket": "A String", # Required. Bucket of the Cloud Storage object.
- "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
- "object": "A String", # Required. Name of the Cloud Storage object.
- },
- "localPath": "A String", # An absolute path to the executable on the VM.
- "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
- 42,
- ],
- "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\)).
- },
- },
- "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.
- "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.
- "A String",
- ],
- "withOptional": True or False, # Adds the `--with-optional` flag to `zypper patch`.
- "severities": [ # Install only patches with these severities. Common severities include critical, important, moderate, and low.
- "A String",
- ],
- "categories": [ # Install only patches with these categories. Common categories include security, recommended, and feature.
- "A String",
- ],
- "withUpdate": True or False, # Adds the `--with-update` flag, to `zypper patch`.
- "excludes": [ # List of patches to exclude from update.
- "A String",
- ],
- },
- "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.
- "security": True or False, # Adds the `--security` flag to `yum update`. Not supported on all platforms.
- "excludes": [ # List of packages to exclude from update. These packages are excluded by using the yum `--exclude` flag.
- "A String",
- ],
- "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.
- "A String",
- ],
- "minimal": True or False, # Will cause patch to run `yum update-minimal` instead.
- },
- "preStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run before the patch update.
- "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob.
- "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
- "bucket": "A String", # Required. Bucket of the Cloud Storage object.
- "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
- "object": "A String", # Required. Name of the Cloud Storage object.
- },
- "localPath": "A String", # An absolute path to the executable on the VM.
- "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
- 42,
- ],
- "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\)).
- },
- "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob.
- "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
- "bucket": "A String", # Required. Bucket of the Cloud Storage object.
- "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
- "object": "A String", # Required. Name of the Cloud Storage object.
- },
- "localPath": "A String", # An absolute path to the executable on the VM.
- "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
- 42,
- ],
- "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\)).
- },
- },
- "goo": { # Googet patching is performed by running `googet update`. # Goo update settings. Use this setting to override the default `goo` patch rules.
- },
},
+ "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.
},
],
+ "nextPageToken": "A String", # A pagination token that can be used to get the next page of patch deployments.
}</pre>
</div>