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.



2848
2849
2850
 
# File 'lib/google/apis/osconfig_v1/classes.rb', line 2848

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) 


2780
2781
2782
 
# File 'lib/google/apis/osconfig_v1/classes.rb', line 2780

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) 


2786
2787
2788
 
# File 'lib/google/apis/osconfig_v1/classes.rb', line 2786

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) 


2791
2792
2793
 
# File 'lib/google/apis/osconfig_v1/classes.rb', line 2791

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:



2798
2799
2800
 
# File 'lib/google/apis/osconfig_v1/classes.rb', line 2798

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) 


2804
2805
2806
 
# File 'lib/google/apis/osconfig_v1/classes.rb', line 2804

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) 


2812
2813
2814
 
# File 'lib/google/apis/osconfig_v1/classes.rb', line 2812

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:



2818
2819
2820
 
# File 'lib/google/apis/osconfig_v1/classes.rb', line 2818

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:



2824
2825
2826
 
# File 'lib/google/apis/osconfig_v1/classes.rb', line 2824

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:



2829
2830
2831
 
# File 'lib/google/apis/osconfig_v1/classes.rb', line 2829

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:



2835
2836
2837
 
# File 'lib/google/apis/osconfig_v1/classes.rb', line 2835

def rollout
  @rollout
end

#state ⇒ String

Output only. Current state of the patch deployment. Corresponds to the JSON property state

Returns:

  • (String) 


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

def state
  @state
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) 


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

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
 
# File 'lib/google/apis/osconfig_v1/classes.rb', line 2853

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)
  @state = args[:state] if args.key?(:state)
  @update_time = args[:update_time] if args.key?(:update_time)
end