Class: Google::Apis::OsconfigV1::PatchJob

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/osconfig_v1/classes.rb,
lib/google/apis/osconfig_v1/representations.rb,
lib/google/apis/osconfig_v1/representations.rb

Overview

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ PatchJob

Returns a new instance of PatchJob.



2922
2923
2924
 
# File 'lib/google/apis/osconfig_v1/classes.rb', line 2922

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#create_time ⇒ String

Time this patch job was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


2839
2840
2841
 
# File 'lib/google/apis/osconfig_v1/classes.rb', line 2839

def create_time
  @create_time
end

#description ⇒ String

Description of the patch job. Length of the description is limited to 1024 characters. Corresponds to the JSON property description

Returns:

  • (String) 


2845
2846
2847
 
# File 'lib/google/apis/osconfig_v1/classes.rb', line 2845

def description
  @description
end

#display_name ⇒ String

Display name for this patch job. This is not a unique identifier. Corresponds to the JSON property displayName

Returns:

  • (String) 


2850
2851
2852
 
# File 'lib/google/apis/osconfig_v1/classes.rb', line 2850

def display_name
  @display_name
end

#dry_run ⇒ Boolean Also known as: dry_run?

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

Returns:

  • (Boolean) 


2856
2857
2858
 
# File 'lib/google/apis/osconfig_v1/classes.rb', line 2856

def dry_run
  @dry_run
end

#duration ⇒ String

Duration of the patch job. After the duration ends, the patch job times out. Corresponds to the JSON property duration

Returns:

  • (String) 


2862
2863
2864
 
# File 'lib/google/apis/osconfig_v1/classes.rb', line 2862

def duration
  @duration
end

#error_message ⇒ String

If this patch job failed, this message provides information about the failure. Corresponds to the JSON property errorMessage

Returns:

  • (String) 


2867
2868
2869
 
# File 'lib/google/apis/osconfig_v1/classes.rb', line 2867

def error_message
  @error_message
end

#instance_details_summary ⇒ Google::Apis::OsconfigV1::PatchJobInstanceDetailsSummary

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

Returns:



2875
2876
2877
 
# File 'lib/google/apis/osconfig_v1/classes.rb', line 2875

def instance_details_summary
  @instance_details_summary
end

#instance_filter ⇒ Google::Apis::OsconfigV1::PatchInstanceFilter

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

Returns:



2882
2883
2884
 
# File 'lib/google/apis/osconfig_v1/classes.rb', line 2882

def instance_filter
  @instance_filter
end

#name ⇒ String

Unique identifier for this patch job in the form projects/*/patchJobs/* Corresponds to the JSON property name

Returns:

  • (String) 


2887
2888
2889
 
# File 'lib/google/apis/osconfig_v1/classes.rb', line 2887

def name
  @name
end

#patch_config ⇒ Google::Apis::OsconfigV1::PatchConfig

Patch configuration specifications. Contains details on how to apply the patch( es) to a VM instance. Corresponds to the JSON property patchConfig

Returns:



2893
2894
2895
 
# File 'lib/google/apis/osconfig_v1/classes.rb', line 2893

def patch_config
  @patch_config
end

#patch_deployment ⇒ String

Output only. Name of the patch deployment that created this patch job. Corresponds to the JSON property patchDeployment

Returns:

  • (String) 


2898
2899
2900
 
# File 'lib/google/apis/osconfig_v1/classes.rb', line 2898

def patch_deployment
  @patch_deployment
end

#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. Corresponds to the JSON property percentComplete

Returns:

  • (Float) 


2904
2905
2906
 
# File 'lib/google/apis/osconfig_v1/classes.rb', line 2904

def percent_complete
  @percent_complete
end

#rollout ⇒ Google::Apis::OsconfigV1::PatchRollout

Patch rollout configuration specifications. Contains details on the concurrency control when applying patch(es) to all targeted VMs. Corresponds to the JSON property rollout

Returns:



2910
2911
2912
 
# File 'lib/google/apis/osconfig_v1/classes.rb', line 2910

def rollout
  @rollout
end

#state ⇒ String

The current state of the PatchJob. Corresponds to the JSON property state

Returns:

  • (String) 


2915
2916
2917
 
# File 'lib/google/apis/osconfig_v1/classes.rb', line 2915

def state
  @state
end

#update_time ⇒ String

Last time this patch job was updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


2920
2921
2922
 
# File 'lib/google/apis/osconfig_v1/classes.rb', line 2920

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
 
# File 'lib/google/apis/osconfig_v1/classes.rb', line 2927

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