class Google::Apis::OsconfigV1beta::PatchJob

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](cloud.google.com/compute/ docs/os-patch-management/create-patch-job).

Attributes

create_time[RW]

Time this patch job was created. Corresponds to the JSON property `createTime` @return [String]

description[RW]

Description of the patch job. Length of the description is limited to 1024 characters. Corresponds to the JSON property `description` @return [String]

display_name[RW]

Display name for this patch job. This is not a unique identifier. Corresponds to the JSON property `displayName` @return [String]

dry_run[RW]

If this patch job is a dry run, the agent reports that it has finished without running any updates on the VM instance. Corresponds to the JSON property `dryRun` @return [Boolean]

dry_run?[RW]

If this patch job is a dry run, the agent reports that it has finished without running any updates on the VM instance. Corresponds to the JSON property `dryRun` @return [Boolean]

duration[RW]

Duration of the patch job. After the duration ends, the patch job times out. Corresponds to the JSON property `duration` @return [String]

error_message[RW]

If this patch job failed, this message provides information about the failure. Corresponds to the JSON property `errorMessage` @return [String]

instance_details_summary[RW]

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. Corresponds to the JSON property `instanceDetailsSummary` @return [Google::Apis::OsconfigV1beta::PatchJobInstanceDetailsSummary]

instance_filter[RW]

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. Corresponds to the JSON property `instanceFilter` @return [Google::Apis::OsconfigV1beta::PatchInstanceFilter]

name[RW]

Unique identifier for this patch job in the form `projects//patchJobs/` Corresponds to the JSON property `name` @return [String]

patch_config[RW]

Patch configuration specifications. Contains details on how to apply the patch( es) to a VM instance. Corresponds to the JSON property `patchConfig` @return [Google::Apis::OsconfigV1beta::PatchConfig]

patch_deployment[RW]

Output only. Name of the patch deployment that created this patch job. Corresponds to the JSON property `patchDeployment` @return [String]

percent_complete[RW]

Reflects the overall progress of the patch job in the range of 0.0 being no progress to 100.0 being complete. Corresponds to the JSON property `percentComplete` @return [Float]

rollout[RW]

Patch rollout configuration specifications. Contains details on the concurrency control when applying patch(es) to all targeted VMs. Corresponds to the JSON property `rollout` @return [Google::Apis::OsconfigV1beta::PatchRollout]

state[RW]

The current state of the PatchJob. Corresponds to the JSON property `state` @return [String]

update_time[RW]

Last time this patch job was updated. Corresponds to the JSON property `updateTime` @return [String]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/osconfig_v1beta/classes.rb, line 1331
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/osconfig_v1beta/classes.rb, line 1336
def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @dry_run = args[:dry_run] if args.key?(:dry_run)
  @duration = args[:duration] if args.key?(:duration)
  @error_message = args[:error_message] if args.key?(:error_message)
  @instance_details_summary = args[:instance_details_summary] if args.key?(:instance_details_summary)
  @instance_filter = args[:instance_filter] if args.key?(:instance_filter)
  @name = args[:name] if args.key?(:name)
  @patch_config = args[:patch_config] if args.key?(:patch_config)
  @patch_deployment = args[:patch_deployment] if args.key?(:patch_deployment)
  @percent_complete = args[:percent_complete] if args.key?(:percent_complete)
  @rollout = args[:rollout] if args.key?(:rollout)
  @state = args[:state] if args.key?(:state)
  @update_time = args[:update_time] if args.key?(:update_time)
end