Class: Google::Apis::OsconfigV1beta::PatchDeployment

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/osconfig_v1beta/classes.rb,
lib/google/apis/osconfig_v1beta/representations.rb,
lib/google/apis/osconfig_v1beta/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.



1192
1193
1194
 
# File 'lib/google/apis/osconfig_v1beta/classes.rb', line 1192

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) 


1124
1125
1126
 
# File 'lib/google/apis/osconfig_v1beta/classes.rb', line 1124

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) 


1130
1131
1132
 
# File 'lib/google/apis/osconfig_v1beta/classes.rb', line 1130

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) 


1135
1136
1137
 
# File 'lib/google/apis/osconfig_v1beta/classes.rb', line 1135

def duration
  @duration
end

#instance_filter ⇒ Google::Apis::OsconfigV1beta::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:



1142
1143
1144
 
# File 'lib/google/apis/osconfig_v1beta/classes.rb', line 1142

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) 


1148
1149
1150
 
# File 'lib/google/apis/osconfig_v1beta/classes.rb', line 1148

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) 


1156
1157
1158
 
# File 'lib/google/apis/osconfig_v1beta/classes.rb', line 1156

def name
  @name
end

#one_time_schedule ⇒ Google::Apis::OsconfigV1beta::OneTimeSchedule

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

Returns:



1162
1163
1164
 
# File 'lib/google/apis/osconfig_v1beta/classes.rb', line 1162

def one_time_schedule
  @one_time_schedule
end

#patch_config ⇒ Google::Apis::OsconfigV1beta::PatchConfig

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

Returns:



1168
1169
1170
 
# File 'lib/google/apis/osconfig_v1beta/classes.rb', line 1168

def patch_config
  @patch_config
end

#recurring_schedule ⇒ Google::Apis::OsconfigV1beta::RecurringSchedule

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

Returns:



1173
1174
1175
 
# File 'lib/google/apis/osconfig_v1beta/classes.rb', line 1173

def recurring_schedule
  @recurring_schedule
end

#rollout ⇒ Google::Apis::OsconfigV1beta::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:



1179
1180
1181
 
# File 'lib/google/apis/osconfig_v1beta/classes.rb', line 1179

def rollout
  @rollout
end

#state ⇒ String

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

Returns:

  • (String) 


1184
1185
1186
 
# File 'lib/google/apis/osconfig_v1beta/classes.rb', line 1184

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) 


1190
1191
1192
 
# File 'lib/google/apis/osconfig_v1beta/classes.rb', line 1190

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
 
# File 'lib/google/apis/osconfig_v1beta/classes.rb', line 1197

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