docs: update docs (#916)
* fix: re-run script
* test: fix noxfile
diff --git a/docs/dyn/osconfig_v1.projects.patchJobs.html b/docs/dyn/osconfig_v1.projects.patchJobs.html
index 495d73d..d38be45 100644
--- a/docs/dyn/osconfig_v1.projects.patchJobs.html
+++ b/docs/dyn/osconfig_v1.projects.patchJobs.html
@@ -125,57 +125,88 @@
# For more information about patch jobs, see
# [Creating patch
# jobs](https://cloud.google.com/compute/docs/os-patch-management/create-patch-job).
- "state": "A String", # The current state of the PatchJob .
- "name": "A String", # Unique identifier for this patch job in the form
- # `projects/*/patchJobs/*`
"displayName": "A String", # Display name for this patch job. This is not a unique identifier.
- "createTime": "A String", # Time this patch job was created.
"dryRun": True or False, # If this patch job is a dry run, the agent reports that it has
# finished without running any updates on the VM instance.
+ "createTime": "A String", # Time this patch job was created.
"updateTime": "A String", # Last time this patch job was updated.
"patchDeployment": "A String", # Output only. Name of the patch deployment that created this patch job.
"errorMessage": "A String", # If this patch job failed, this message provides information about the
# failure.
"patchConfig": { # Patch configuration specifications. Contains details on how to apply the # Patch configuration being applied.
# patch(es) to a VM instance.
+ "apt": { # Apt patching is completed by executing `apt-get update && apt-get # Apt update settings. Use this setting to override the default `apt` patch
+ # rules.
+ # upgrade`. Additional options can be set to control how this is executed.
+ "excludes": [ # List of packages to exclude from update. These packages will be excluded
+ "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 cannot be specified with any other patch configuration
+ # fields.
+ "A String",
+ ],
+ "type": "A String", # By changing the type to DIST, the patching is performed
+ # using `apt-get dist-upgrade` instead.
+ },
+ "yum": { # Yum patching is performed by executing `yum update`. Additional options # Yum update settings. Use this setting to override the default `yum` patch
+ # rules.
+ # can be set to control how this is executed.
+ #
+ # Note that not all settings are 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",
+ ],
+ "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.
+ },
"goo": { # Googet patching is performed by running `googet update`. # Goo update settings. Use this setting to override the default `goo` patch
# rules.
},
"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.
"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.
- "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.
- "bucket": "A String", # Required. Bucket of the Cloud Storage object.
- "object": "A String", # Required. Name of the Cloud Storage object.
- },
- "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.
+ },
+ "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\)).
},
"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.
- "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.
- "bucket": "A String", # Required. Bucket of the Cloud Storage object.
- "object": "A String", # Required. Name of the Cloud Storage object.
- },
- "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.
+ },
+ "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\)).
},
},
"windowsUpdate": { # Windows patching is performed using the Windows Update Agent. # Windows update settings. Use this override the default windows patch rules.
@@ -216,77 +247,41 @@
},
"postStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run after the patch update.
"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.
- "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.
- "bucket": "A String", # Required. Bucket of the Cloud Storage object.
- "object": "A String", # Required. Name of the Cloud Storage object.
- },
- "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.
+ },
+ "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\)).
},
"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.
- "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.
- "bucket": "A String", # Required. Bucket of the Cloud Storage object.
- "object": "A String", # Required. Name of the Cloud Storage object.
- },
- "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.
+ },
+ "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\)).
},
},
- "apt": { # Apt patching is completed by executing `apt-get update && apt-get # Apt update settings. Use this setting to override the default `apt` patch
- # rules.
- # upgrade`. Additional options can be set to control how this is executed.
- "excludes": [ # List of packages to exclude from update. These packages will be excluded
- "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 cannot be specified with any other patch configuration
- # fields.
- "A String",
- ],
- "type": "A String", # By changing the type to DIST, the patching is performed
- # using `apt-get dist-upgrade` instead.
- },
- "yum": { # Yum patching is performed by executing `yum update`. Additional options # Yum update settings. Use this setting to override the default `yum` patch
- # rules.
- # can be set to control how this is executed.
- #
- # Note that not all settings are 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",
- ],
- "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.
- },
},
- "duration": "A String", # Duration of the patch job. After the duration ends, the
- # patch job times out.
"instanceFilter": { # A filter to target VM instances for patching. The targeted # Instances to patch.
# 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
@@ -325,10 +320,17 @@
},
],
},
+ "duration": "A String", # Duration of the patch job. After the duration ends, the
+ # patch job times out.
"instanceDetailsSummary": { # A summary of the current patch state across all instances that this patch # Summary of instance details.
# job affects. Contains counts of instances in different states. These states
# map to `InstancePatchState`. List patch job instance details to see the
# specific states of each instance.
+ "succeededRebootRequiredInstanceCount": "A String", # Number of instances that require reboot.
+ "prePatchStepInstanceCount": "A String", # Number of instances that are running the pre-patch step.
+ "noAgentDetectedInstanceCount": "A String", # Number of instances that do not appear to be running the agent. Check to
+ # ensure that the agent is installed, running, and able to communicate with
+ # the service.
"failedInstanceCount": "A String", # Number of instances that failed.
"pendingInstanceCount": "A String", # Number of instances pending patch job.
"notifiedInstanceCount": "A String", # Number of instances notified about patch job.
@@ -341,16 +343,14 @@
"applyingPatchesInstanceCount": "A String", # Number of instances that are applying patches.
"startedInstanceCount": "A String", # Number of instances that have started.
"inactiveInstanceCount": "A String", # Number of instances that are inactive.
- "succeededRebootRequiredInstanceCount": "A String", # Number of instances that require reboot.
- "prePatchStepInstanceCount": "A String", # Number of instances that are running the pre-patch step.
- "noAgentDetectedInstanceCount": "A String", # Number of instances that do not appear to be running the agent. Check to
- # ensure that the agent is installed, running, and able to communicate with
- # the service.
},
"description": "A String", # Description of the patch job. Length of the description is limited
# to 1024 characters.
"percentComplete": 3.14, # Reflects the overall progress of the patch job in the range of
# 0.0 being no progress to 100.0 being complete.
+ "state": "A String", # The current state of the PatchJob .
+ "name": "A String", # Unique identifier for this patch job in the form
+ # `projects/*/patchJobs/*`
}</pre>
</div>
@@ -365,49 +365,86 @@
{ # A request message to initiate patching across Compute Engine
# instances.
+ "displayName": "A String", # Display name for this patch job. This does not have to be unique.
+ "description": "A String", # Description of the patch job. Length of the description is limited
+ # to 1024 characters.
"dryRun": True or False, # If this patch is a dry-run only, instances are contacted but
# will do nothing.
"patchConfig": { # Patch configuration specifications. Contains details on how to apply the # Patch configuration being applied. If omitted, instances are
# patched using the default configurations.
# patch(es) to a VM instance.
+ "apt": { # Apt patching is completed by executing `apt-get update && apt-get # Apt update settings. Use this setting to override the default `apt` patch
+ # rules.
+ # upgrade`. Additional options can be set to control how this is executed.
+ "excludes": [ # List of packages to exclude from update. These packages will be excluded
+ "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 cannot be specified with any other patch configuration
+ # fields.
+ "A String",
+ ],
+ "type": "A String", # By changing the type to DIST, the patching is performed
+ # using `apt-get dist-upgrade` instead.
+ },
+ "yum": { # Yum patching is performed by executing `yum update`. Additional options # Yum update settings. Use this setting to override the default `yum` patch
+ # rules.
+ # can be set to control how this is executed.
+ #
+ # Note that not all settings are 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",
+ ],
+ "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.
+ },
"goo": { # Googet patching is performed by running `googet update`. # Goo update settings. Use this setting to override the default `goo` patch
# rules.
},
"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.
"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.
- "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.
- "bucket": "A String", # Required. Bucket of the Cloud Storage object.
- "object": "A String", # Required. Name of the Cloud Storage object.
- },
- "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.
+ },
+ "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\)).
},
"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.
- "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.
- "bucket": "A String", # Required. Bucket of the Cloud Storage object.
- "object": "A String", # Required. Name of the Cloud Storage object.
- },
- "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.
+ },
+ "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\)).
},
},
"windowsUpdate": { # Windows patching is performed using the Windows Update Agent. # Windows update settings. Use this override the default windows patch rules.
@@ -448,74 +485,40 @@
},
"postStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run after the patch update.
"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.
- "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.
- "bucket": "A String", # Required. Bucket of the Cloud Storage object.
- "object": "A String", # Required. Name of the Cloud Storage object.
- },
- "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.
+ },
+ "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\)).
},
"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.
- "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.
- "bucket": "A String", # Required. Bucket of the Cloud Storage object.
- "object": "A String", # Required. Name of the Cloud Storage object.
- },
- "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.
+ },
+ "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\)).
},
},
- "apt": { # Apt patching is completed by executing `apt-get update && apt-get # Apt update settings. Use this setting to override the default `apt` patch
- # rules.
- # upgrade`. Additional options can be set to control how this is executed.
- "excludes": [ # List of packages to exclude from update. These packages will be excluded
- "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 cannot be specified with any other patch configuration
- # fields.
- "A String",
- ],
- "type": "A String", # By changing the type to DIST, the patching is performed
- # using `apt-get dist-upgrade` instead.
- },
- "yum": { # Yum patching is performed by executing `yum update`. Additional options # Yum update settings. Use this setting to override the default `yum` patch
- # rules.
- # can be set to control how this is executed.
- #
- # Note that not all settings are 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",
- ],
- "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.
- },
},
"instanceFilter": { # A filter to target VM instances for patching. The targeted # Required. Instances to patch, either explicitly or filtered by some criteria such
# as zone or labels.
@@ -558,9 +561,6 @@
},
"duration": "A String", # Duration of the patch job. After the duration ends, the patch job
# times out.
- "description": "A String", # Description of the patch job. Length of the description is limited
- # to 1024 characters.
- "displayName": "A String", # Display name for this patch job. This does not have to be unique.
}
x__xgafv: string, V1 error format.
@@ -580,57 +580,88 @@
# For more information about patch jobs, see
# [Creating patch
# jobs](https://cloud.google.com/compute/docs/os-patch-management/create-patch-job).
- "state": "A String", # The current state of the PatchJob .
- "name": "A String", # Unique identifier for this patch job in the form
- # `projects/*/patchJobs/*`
"displayName": "A String", # Display name for this patch job. This is not a unique identifier.
- "createTime": "A String", # Time this patch job was created.
"dryRun": True or False, # If this patch job is a dry run, the agent reports that it has
# finished without running any updates on the VM instance.
+ "createTime": "A String", # Time this patch job was created.
"updateTime": "A String", # Last time this patch job was updated.
"patchDeployment": "A String", # Output only. Name of the patch deployment that created this patch job.
"errorMessage": "A String", # If this patch job failed, this message provides information about the
# failure.
"patchConfig": { # Patch configuration specifications. Contains details on how to apply the # Patch configuration being applied.
# patch(es) to a VM instance.
+ "apt": { # Apt patching is completed by executing `apt-get update && apt-get # Apt update settings. Use this setting to override the default `apt` patch
+ # rules.
+ # upgrade`. Additional options can be set to control how this is executed.
+ "excludes": [ # List of packages to exclude from update. These packages will be excluded
+ "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 cannot be specified with any other patch configuration
+ # fields.
+ "A String",
+ ],
+ "type": "A String", # By changing the type to DIST, the patching is performed
+ # using `apt-get dist-upgrade` instead.
+ },
+ "yum": { # Yum patching is performed by executing `yum update`. Additional options # Yum update settings. Use this setting to override the default `yum` patch
+ # rules.
+ # can be set to control how this is executed.
+ #
+ # Note that not all settings are 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",
+ ],
+ "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.
+ },
"goo": { # Googet patching is performed by running `googet update`. # Goo update settings. Use this setting to override the default `goo` patch
# rules.
},
"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.
"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.
- "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.
- "bucket": "A String", # Required. Bucket of the Cloud Storage object.
- "object": "A String", # Required. Name of the Cloud Storage object.
- },
- "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.
+ },
+ "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\)).
},
"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.
- "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.
- "bucket": "A String", # Required. Bucket of the Cloud Storage object.
- "object": "A String", # Required. Name of the Cloud Storage object.
- },
- "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.
+ },
+ "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\)).
},
},
"windowsUpdate": { # Windows patching is performed using the Windows Update Agent. # Windows update settings. Use this override the default windows patch rules.
@@ -671,77 +702,41 @@
},
"postStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run after the patch update.
"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.
- "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.
- "bucket": "A String", # Required. Bucket of the Cloud Storage object.
- "object": "A String", # Required. Name of the Cloud Storage object.
- },
- "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.
+ },
+ "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\)).
},
"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.
- "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.
- "bucket": "A String", # Required. Bucket of the Cloud Storage object.
- "object": "A String", # Required. Name of the Cloud Storage object.
- },
- "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.
+ },
+ "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\)).
},
},
- "apt": { # Apt patching is completed by executing `apt-get update && apt-get # Apt update settings. Use this setting to override the default `apt` patch
- # rules.
- # upgrade`. Additional options can be set to control how this is executed.
- "excludes": [ # List of packages to exclude from update. These packages will be excluded
- "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 cannot be specified with any other patch configuration
- # fields.
- "A String",
- ],
- "type": "A String", # By changing the type to DIST, the patching is performed
- # using `apt-get dist-upgrade` instead.
- },
- "yum": { # Yum patching is performed by executing `yum update`. Additional options # Yum update settings. Use this setting to override the default `yum` patch
- # rules.
- # can be set to control how this is executed.
- #
- # Note that not all settings are 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",
- ],
- "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.
- },
},
- "duration": "A String", # Duration of the patch job. After the duration ends, the
- # patch job times out.
"instanceFilter": { # A filter to target VM instances for patching. The targeted # Instances to patch.
# 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
@@ -780,10 +775,17 @@
},
],
},
+ "duration": "A String", # Duration of the patch job. After the duration ends, the
+ # patch job times out.
"instanceDetailsSummary": { # A summary of the current patch state across all instances that this patch # Summary of instance details.
# job affects. Contains counts of instances in different states. These states
# map to `InstancePatchState`. List patch job instance details to see the
# specific states of each instance.
+ "succeededRebootRequiredInstanceCount": "A String", # Number of instances that require reboot.
+ "prePatchStepInstanceCount": "A String", # Number of instances that are running the pre-patch step.
+ "noAgentDetectedInstanceCount": "A String", # Number of instances that do not appear to be running the agent. Check to
+ # ensure that the agent is installed, running, and able to communicate with
+ # the service.
"failedInstanceCount": "A String", # Number of instances that failed.
"pendingInstanceCount": "A String", # Number of instances pending patch job.
"notifiedInstanceCount": "A String", # Number of instances notified about patch job.
@@ -796,16 +798,14 @@
"applyingPatchesInstanceCount": "A String", # Number of instances that are applying patches.
"startedInstanceCount": "A String", # Number of instances that have started.
"inactiveInstanceCount": "A String", # Number of instances that are inactive.
- "succeededRebootRequiredInstanceCount": "A String", # Number of instances that require reboot.
- "prePatchStepInstanceCount": "A String", # Number of instances that are running the pre-patch step.
- "noAgentDetectedInstanceCount": "A String", # Number of instances that do not appear to be running the agent. Check to
- # ensure that the agent is installed, running, and able to communicate with
- # the service.
},
"description": "A String", # Description of the patch job. Length of the description is limited
# to 1024 characters.
"percentComplete": 3.14, # Reflects the overall progress of the patch job in the range of
# 0.0 being no progress to 100.0 being complete.
+ "state": "A String", # The current state of the PatchJob .
+ "name": "A String", # Unique identifier for this patch job in the form
+ # `projects/*/patchJobs/*`
}</pre>
</div>
@@ -833,57 +833,88 @@
# For more information about patch jobs, see
# [Creating patch
# jobs](https://cloud.google.com/compute/docs/os-patch-management/create-patch-job).
- "state": "A String", # The current state of the PatchJob .
- "name": "A String", # Unique identifier for this patch job in the form
- # `projects/*/patchJobs/*`
"displayName": "A String", # Display name for this patch job. This is not a unique identifier.
- "createTime": "A String", # Time this patch job was created.
"dryRun": True or False, # If this patch job is a dry run, the agent reports that it has
# finished without running any updates on the VM instance.
+ "createTime": "A String", # Time this patch job was created.
"updateTime": "A String", # Last time this patch job was updated.
"patchDeployment": "A String", # Output only. Name of the patch deployment that created this patch job.
"errorMessage": "A String", # If this patch job failed, this message provides information about the
# failure.
"patchConfig": { # Patch configuration specifications. Contains details on how to apply the # Patch configuration being applied.
# patch(es) to a VM instance.
+ "apt": { # Apt patching is completed by executing `apt-get update && apt-get # Apt update settings. Use this setting to override the default `apt` patch
+ # rules.
+ # upgrade`. Additional options can be set to control how this is executed.
+ "excludes": [ # List of packages to exclude from update. These packages will be excluded
+ "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 cannot be specified with any other patch configuration
+ # fields.
+ "A String",
+ ],
+ "type": "A String", # By changing the type to DIST, the patching is performed
+ # using `apt-get dist-upgrade` instead.
+ },
+ "yum": { # Yum patching is performed by executing `yum update`. Additional options # Yum update settings. Use this setting to override the default `yum` patch
+ # rules.
+ # can be set to control how this is executed.
+ #
+ # Note that not all settings are 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",
+ ],
+ "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.
+ },
"goo": { # Googet patching is performed by running `googet update`. # Goo update settings. Use this setting to override the default `goo` patch
# rules.
},
"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.
"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.
- "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.
- "bucket": "A String", # Required. Bucket of the Cloud Storage object.
- "object": "A String", # Required. Name of the Cloud Storage object.
- },
- "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.
+ },
+ "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\)).
},
"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.
- "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.
- "bucket": "A String", # Required. Bucket of the Cloud Storage object.
- "object": "A String", # Required. Name of the Cloud Storage object.
- },
- "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.
+ },
+ "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\)).
},
},
"windowsUpdate": { # Windows patching is performed using the Windows Update Agent. # Windows update settings. Use this override the default windows patch rules.
@@ -924,77 +955,41 @@
},
"postStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run after the patch update.
"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.
- "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.
- "bucket": "A String", # Required. Bucket of the Cloud Storage object.
- "object": "A String", # Required. Name of the Cloud Storage object.
- },
- "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.
+ },
+ "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\)).
},
"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.
- "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.
- "bucket": "A String", # Required. Bucket of the Cloud Storage object.
- "object": "A String", # Required. Name of the Cloud Storage object.
- },
- "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.
+ },
+ "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\)).
},
},
- "apt": { # Apt patching is completed by executing `apt-get update && apt-get # Apt update settings. Use this setting to override the default `apt` patch
- # rules.
- # upgrade`. Additional options can be set to control how this is executed.
- "excludes": [ # List of packages to exclude from update. These packages will be excluded
- "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 cannot be specified with any other patch configuration
- # fields.
- "A String",
- ],
- "type": "A String", # By changing the type to DIST, the patching is performed
- # using `apt-get dist-upgrade` instead.
- },
- "yum": { # Yum patching is performed by executing `yum update`. Additional options # Yum update settings. Use this setting to override the default `yum` patch
- # rules.
- # can be set to control how this is executed.
- #
- # Note that not all settings are 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",
- ],
- "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.
- },
},
- "duration": "A String", # Duration of the patch job. After the duration ends, the
- # patch job times out.
"instanceFilter": { # A filter to target VM instances for patching. The targeted # Instances to patch.
# 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
@@ -1033,10 +1028,17 @@
},
],
},
+ "duration": "A String", # Duration of the patch job. After the duration ends, the
+ # patch job times out.
"instanceDetailsSummary": { # A summary of the current patch state across all instances that this patch # Summary of instance details.
# job affects. Contains counts of instances in different states. These states
# map to `InstancePatchState`. List patch job instance details to see the
# specific states of each instance.
+ "succeededRebootRequiredInstanceCount": "A String", # Number of instances that require reboot.
+ "prePatchStepInstanceCount": "A String", # Number of instances that are running the pre-patch step.
+ "noAgentDetectedInstanceCount": "A String", # Number of instances that do not appear to be running the agent. Check to
+ # ensure that the agent is installed, running, and able to communicate with
+ # the service.
"failedInstanceCount": "A String", # Number of instances that failed.
"pendingInstanceCount": "A String", # Number of instances pending patch job.
"notifiedInstanceCount": "A String", # Number of instances notified about patch job.
@@ -1049,16 +1051,14 @@
"applyingPatchesInstanceCount": "A String", # Number of instances that are applying patches.
"startedInstanceCount": "A String", # Number of instances that have started.
"inactiveInstanceCount": "A String", # Number of instances that are inactive.
- "succeededRebootRequiredInstanceCount": "A String", # Number of instances that require reboot.
- "prePatchStepInstanceCount": "A String", # Number of instances that are running the pre-patch step.
- "noAgentDetectedInstanceCount": "A String", # Number of instances that do not appear to be running the agent. Check to
- # ensure that the agent is installed, running, and able to communicate with
- # the service.
},
"description": "A String", # Description of the patch job. Length of the description is limited
# to 1024 characters.
"percentComplete": 3.14, # Reflects the overall progress of the patch job in the range of
# 0.0 being no progress to 100.0 being complete.
+ "state": "A String", # The current state of the PatchJob .
+ "name": "A String", # Unique identifier for this patch job in the form
+ # `projects/*/patchJobs/*`
}</pre>
</div>
@@ -1093,57 +1093,88 @@
# For more information about patch jobs, see
# [Creating patch
# jobs](https://cloud.google.com/compute/docs/os-patch-management/create-patch-job).
- "state": "A String", # The current state of the PatchJob .
- "name": "A String", # Unique identifier for this patch job in the form
- # `projects/*/patchJobs/*`
"displayName": "A String", # Display name for this patch job. This is not a unique identifier.
- "createTime": "A String", # Time this patch job was created.
"dryRun": True or False, # If this patch job is a dry run, the agent reports that it has
# finished without running any updates on the VM instance.
+ "createTime": "A String", # Time this patch job was created.
"updateTime": "A String", # Last time this patch job was updated.
"patchDeployment": "A String", # Output only. Name of the patch deployment that created this patch job.
"errorMessage": "A String", # If this patch job failed, this message provides information about the
# failure.
"patchConfig": { # Patch configuration specifications. Contains details on how to apply the # Patch configuration being applied.
# patch(es) to a VM instance.
+ "apt": { # Apt patching is completed by executing `apt-get update && apt-get # Apt update settings. Use this setting to override the default `apt` patch
+ # rules.
+ # upgrade`. Additional options can be set to control how this is executed.
+ "excludes": [ # List of packages to exclude from update. These packages will be excluded
+ "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 cannot be specified with any other patch configuration
+ # fields.
+ "A String",
+ ],
+ "type": "A String", # By changing the type to DIST, the patching is performed
+ # using `apt-get dist-upgrade` instead.
+ },
+ "yum": { # Yum patching is performed by executing `yum update`. Additional options # Yum update settings. Use this setting to override the default `yum` patch
+ # rules.
+ # can be set to control how this is executed.
+ #
+ # Note that not all settings are 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",
+ ],
+ "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.
+ },
"goo": { # Googet patching is performed by running `googet update`. # Goo update settings. Use this setting to override the default `goo` patch
# rules.
},
"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.
"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.
- "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.
- "bucket": "A String", # Required. Bucket of the Cloud Storage object.
- "object": "A String", # Required. Name of the Cloud Storage object.
- },
- "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.
+ },
+ "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\)).
},
"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.
- "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.
- "bucket": "A String", # Required. Bucket of the Cloud Storage object.
- "object": "A String", # Required. Name of the Cloud Storage object.
- },
- "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.
+ },
+ "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\)).
},
},
"windowsUpdate": { # Windows patching is performed using the Windows Update Agent. # Windows update settings. Use this override the default windows patch rules.
@@ -1184,77 +1215,41 @@
},
"postStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run after the patch update.
"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.
- "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.
- "bucket": "A String", # Required. Bucket of the Cloud Storage object.
- "object": "A String", # Required. Name of the Cloud Storage object.
- },
- "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.
+ },
+ "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\)).
},
"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.
- "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.
- "bucket": "A String", # Required. Bucket of the Cloud Storage object.
- "object": "A String", # Required. Name of the Cloud Storage object.
- },
- "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.
+ },
+ "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\)).
},
},
- "apt": { # Apt patching is completed by executing `apt-get update && apt-get # Apt update settings. Use this setting to override the default `apt` patch
- # rules.
- # upgrade`. Additional options can be set to control how this is executed.
- "excludes": [ # List of packages to exclude from update. These packages will be excluded
- "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 cannot be specified with any other patch configuration
- # fields.
- "A String",
- ],
- "type": "A String", # By changing the type to DIST, the patching is performed
- # using `apt-get dist-upgrade` instead.
- },
- "yum": { # Yum patching is performed by executing `yum update`. Additional options # Yum update settings. Use this setting to override the default `yum` patch
- # rules.
- # can be set to control how this is executed.
- #
- # Note that not all settings are 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",
- ],
- "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.
- },
},
- "duration": "A String", # Duration of the patch job. After the duration ends, the
- # patch job times out.
"instanceFilter": { # A filter to target VM instances for patching. The targeted # Instances to patch.
# 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
@@ -1293,10 +1288,17 @@
},
],
},
+ "duration": "A String", # Duration of the patch job. After the duration ends, the
+ # patch job times out.
"instanceDetailsSummary": { # A summary of the current patch state across all instances that this patch # Summary of instance details.
# job affects. Contains counts of instances in different states. These states
# map to `InstancePatchState`. List patch job instance details to see the
# specific states of each instance.
+ "succeededRebootRequiredInstanceCount": "A String", # Number of instances that require reboot.
+ "prePatchStepInstanceCount": "A String", # Number of instances that are running the pre-patch step.
+ "noAgentDetectedInstanceCount": "A String", # Number of instances that do not appear to be running the agent. Check to
+ # ensure that the agent is installed, running, and able to communicate with
+ # the service.
"failedInstanceCount": "A String", # Number of instances that failed.
"pendingInstanceCount": "A String", # Number of instances pending patch job.
"notifiedInstanceCount": "A String", # Number of instances notified about patch job.
@@ -1309,16 +1311,14 @@
"applyingPatchesInstanceCount": "A String", # Number of instances that are applying patches.
"startedInstanceCount": "A String", # Number of instances that have started.
"inactiveInstanceCount": "A String", # Number of instances that are inactive.
- "succeededRebootRequiredInstanceCount": "A String", # Number of instances that require reboot.
- "prePatchStepInstanceCount": "A String", # Number of instances that are running the pre-patch step.
- "noAgentDetectedInstanceCount": "A String", # Number of instances that do not appear to be running the agent. Check to
- # ensure that the agent is installed, running, and able to communicate with
- # the service.
},
"description": "A String", # Description of the patch job. Length of the description is limited
# to 1024 characters.
"percentComplete": 3.14, # Reflects the overall progress of the patch job in the range of
# 0.0 being no progress to 100.0 being complete.
+ "state": "A String", # The current state of the PatchJob .
+ "name": "A String", # Unique identifier for this patch job in the form
+ # `projects/*/patchJobs/*`
},
],
"nextPageToken": "A String", # A pagination token that can be used to get the next page of results.