Class: Google::Apis::OsconfigV1::PatchDeployment

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

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ PatchDeployment

Returns a new instance of PatchDeployment.



2728
2729
2730
 
# File 'lib/google/apis/osconfig_v1/classes.rb', line 2728

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

Instance Attribute Details

#create_time ⇒ String

Output only. Time the patch deployment was created. Timestamp is in RFC3339 text format. Corresponds to the JSON property createTime

Returns:

  • (String) 


2665
2666
2667
 
# File 'lib/google/apis/osconfig_v1/classes.rb', line 2665

def create_time
  @create_time
end

#description ⇒ String

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

Returns:

  • (String) 


2671
2672
2673
 
# File 'lib/google/apis/osconfig_v1/classes.rb', line 2671

def description
  @description
end

#duration ⇒ String

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

Returns:

  • (String) 


2676
2677
2678
 
# File 'lib/google/apis/osconfig_v1/classes.rb', line 2676

def duration
  @duration
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:



2683
2684
2685
 
# File 'lib/google/apis/osconfig_v1/classes.rb', line 2683

def instance_filter
  @instance_filter
end

#last_execute_time ⇒ String

Output only. The last time a patch job was started by this deployment. Timestamp is in RFC3339 text format. Corresponds to the JSON property lastExecuteTime

Returns:

  • (String) 


2689
2690
2691
 
# File 'lib/google/apis/osconfig_v1/classes.rb', line 2689

def last_execute_time
  @last_execute_time
end

#name ⇒ 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. Corresponds to the JSON propertyname`

Returns:

  • (String) 


2697
2698
2699
 
# File 'lib/google/apis/osconfig_v1/classes.rb', line 2697

def name
  @name
end

#one_time_schedule ⇒ Google::Apis::OsconfigV1::OneTimeSchedule

Sets the time for a one time patch deployment. Timestamp is in RFC3339 text format. Corresponds to the JSON property oneTimeSchedule

Returns:



2703
2704
2705
 
# File 'lib/google/apis/osconfig_v1/classes.rb', line 2703

def one_time_schedule
  @one_time_schedule
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:



2709
2710
2711
 
# File 'lib/google/apis/osconfig_v1/classes.rb', line 2709

def patch_config
  @patch_config
end

#recurring_schedule ⇒ Google::Apis::OsconfigV1::RecurringSchedule

Sets the time for recurring patch deployments. Corresponds to the JSON property recurringSchedule

Returns:



2714
2715
2716
 
# File 'lib/google/apis/osconfig_v1/classes.rb', line 2714

def recurring_schedule
  @recurring_schedule
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:



2720
2721
2722
 
# File 'lib/google/apis/osconfig_v1/classes.rb', line 2720

def rollout
  @rollout
end

#update_time ⇒ String

Output only. Time the patch deployment was last updated. Timestamp is in RFC3339 text format. Corresponds to the JSON property updateTime

Returns:

  • (String) 


2726
2727
2728
 
# File 'lib/google/apis/osconfig_v1/classes.rb', line 2726

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
 
# File 'lib/google/apis/osconfig_v1/classes.rb', line 2733

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @description = args[:description] if args.key?(:description)
  @duration = args[:duration] if args.key?(:duration)
  @instance_filter = args[:instance_filter] if args.key?(:instance_filter)
  @last_execute_time = args[:last_execute_time] if args.key?(:last_execute_time)
  @name = args[:name] if args.key?(:name)
  @one_time_schedule = args[:one_time_schedule] if args.key?(:one_time_schedule)
  @patch_config = args[:patch_config] if args.key?(:patch_config)
  @recurring_schedule = args[:recurring_schedule] if args.key?(:recurring_schedule)
  @rollout = args[:rollout] if args.key?(:rollout)
  @update_time = args[:update_time] if args.key?(:update_time)
end