Class PatchJob (1.12.2)

PatchJob(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A high level representation of a patch job that is either in progress or has completed.

Instance details are not included in the job. To paginate through instance details, use ListPatchJobInstanceDetails.

For more information about patch jobs, see Creating patch jobs <>__.


name str
Unique identifier for this patch job in the form ``projects/*/patchJobs/*``
display_name str
Display name for this patch job. This is not a unique identifier.
description str
Description of the patch job. Length of the description is limited to 1024 characters.
create_time google.protobuf.timestamp_pb2.Timestamp
Time this patch job was created.
update_time google.protobuf.timestamp_pb2.Timestamp
Last time this patch job was updated.
The current state of the PatchJob.
Instances to patch.
Patch configuration being applied.
duration google.protobuf.duration_pb2.Duration
Duration of the patch job. After the duration ends, the patch job times out.
Summary of instance details.
dry_run bool
If this patch job is a dry run, the agent reports that it has finished without running any updates on the VM instance.
error_message str
If this patch job failed, this message provides information about the failure.
percent_complete float
Reflects the overall progress of the patch job in the range of 0.0 being no progress to 100.0 being complete.
patch_deployment str
Output only. Name of the patch deployment that created this patch job.
Rollout strategy being applied.


builtins.object > proto.message.Message > PatchJob



InstanceDetailsSummary(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A summary of the current patch state across all instances that this patch 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.



Enumeration of the various states a patch job passes through as it executes.